Laravel is a popular PHP framework used in web development. To facilitate and simplify the work of software developers using this framework, this paper proposes an MDA based methodology for developing Laravel based web information systems. This methodology implementation would allow software developers to generate Laravel code from UML diagrams through MDA transformations from PIM to PSM (with Laravel PSM profile applied) and from PSM to code. Developers then could fill the gaps in the generated PHP code for Laravel framework to develop a complete web information system.
code generation save time in the IS development
process, reduce the risk of potential errors, and simplify
The modern need for development of high quality in- modifications [
© 2020 Copyright for this paper by its authors. Use permitted under Creative Based on framework comparison results [
The rest of the paper is organized as follows. In re- age, this package consisted of many JSP pages. The
lated work section related studies in the area of MDA second part consisted of a controller package, and this
and code generation are discussed. In the third section, package encompassed a number of controllers and each
the general process of the proposed methodology for controller having one or more actions.
Laravel code generation is presented, along with func- Authors defined transformation rules for model to
tional requirements for the methodology implementa- model and model to code transformations. These rules
tion and implementation strategy representation. The enabled creation of an XML file containing all the
acfourth section discusses guidelines for implementation tions, forms, and JSP pages that can be used to
genof proposed concept and presents a short examples erate code. Authors developed a transformation
alof developed models and generated code. Finally, in gorithm using the ATL transformation language [17]
the conclusions section, conclusions are presented and (this language is part of the Eclipse M2M). Next, the
further research perspectives are discussed. model to text transformation was developed to
generate Spring MVC code. For the model to text
transformation, a Spring MVC template was defined.
2. Related Work A tool that support the Model Driven Architecture
(MoDAr-WA) was introduced by Essebaa, et al. [16],
In recent years, there has been a numerous research on which implements a methodology automating
transMDA and code generation [
In research paper by Arrhioui, Mbarki, Betari, Roubi, models for UML class and sequence diagrams, QVT
Erramdani [
This approach demonstrated eficiency by enabling the creation of a complete CodeIgniter MVC architecture framework with defined metamodel and generated program code based on this metamodel.
The CodeIgniter framework metamodel developed defined key structural and behavioral aspects in UML class and sequence diagrams. Java source code from PSM was generated with the help of Acceleo tool.
All of the analyzed researches aim to apply MDA principles to improve the process of system development. They provide a detailed definition of their proposed theoretical concept and its implementation, by defining profiles, transformation rules and algorithms, as well as experimental implementation examples. The analyzed methodologies are intended for various frameworks and architectures (PHP CodeIgniter, Spring MVC and Java MVC). The methodology proposed in our paper also applies MDA principles and analyses model by the authors is divided into packages of models, views, transformations and code generation, but in the conand controllers. Each package has specific metaclasses based on the MVC architecture. When authors comtext of Laravel framework, which is not analyzed in other authors’ research.
for LARAVEL Code Generation engine. This transformation results in Laravel code which can further be completed by the system develThis section presents the MDA based methodology for opers in order to finalize the system implementation. Laravel framework. This methodology encompasses It should be noted, that our method does not aim to not only modelling of PIM and PSM, but also model generate the complete PHP code for Laravel frametransformations from PIM to PSM and from PSM to work. It rather concentrates on automating the tranLaravel code. sition from UML diagrams to code as much as possible, but allowing the software developers to complete 3.1. The General Process for the the system implementation by themselves, as the full Proposed Methodology code usually contains more information than it was provided in the UML diagrams of PIM and PSM.
In the proposed methodology (Fig. 1), the abstract modeling and code generation process is proposed which 3.2. Functional Requirements for the encompasses three main steps: PIM development, trans- Methodology Implementation formation to PSM for Laravel framework and Laravel PHP code generation. First of all, using a UML CASE For a detailed representation of the proposed methodtool, PIM model should be modeled and exported to ology, the UML use case diagram (Fig. 2) depicts posthe selected model-to-model transformation tool. The sible actions software developer can perform in order XMI model interchange format should be used to en- to accomplish the model transformations and generate able transfer of models between the steps of the pro- Laravel code. cess. Next, transformation from PIM to PSM is per- In our proposed methodology, platform independent formed by applying transformation rules, algorithms model (PIM) can be managed using any CASE tool seand model transformation engine along with UML pro- lected by software developer, which is able to export ifle for Laravel PSM. After the transformation, PSM in the model to XMI file. The PIM model must include a XMI format is generated. class diagram, without this type of diagram it will not
This PSM model can be either edited in modelling be possible to continue the code generation process. tool or directly transformed into code. PSM to code The PIM model has a high level of abstraction and septransformation is performed using transformation tem- arates logic from technological implementation. This plate, transformation algorithms and code generation model provides modeled system a structure that will ift any implementation platform.
In order to perform transformation from PIM to PSM and to edit PSM, the software developer can import the UML profile for the PHP Laravel framework. Having UML Profile and XMI format PIM model file, imported into selected transformations tool, Laravel PSM can be generated by using transformation engine and by applying transformation rules and algorithms. After the transformation, software developer can manage Laravel PSM model – make changes to it if required or import PSM models’ XMI file to transformation tool for transformation to code.
Transformation from PSM to code is performed using the selected code generation engine, PSM metamodel and code generation algorithms. As a result of the transformation, software developer will receive the PHP Laravel code with PHP files for models, views, controllers, routes and other required Laravel framework elements.
Possible implementation solution with proposed tools Figure 3: Deployment diagram representing proposed tools for modeling and generating Laravel based informa- for modelling and generating Laravel based IS. tion system are depicted in deployment diagram (Fig. 3). The communication paths (having the name “xmi ifle”) between execution environment nodes in this di- the transformation from PIM to PSM according to deagram do not represent the direct communication, but fined rules and algorithms. As a result, PSM in XMI rather the possibility for the software developer to trans- format will be generated. fer XMI file from one execution environment to an- Once the M2M transformation has been completed, other. the PHP code can be generated using the Eclipse Ac
Using MagicDraw CASE tool, software developer celeo tool according to established rules and algorithms can manage PIM. Software developer models the class for code generation [18]. This tool is an open source diagram in PIM and it is possible to save PIM in XMI code generator implementing the OMG’s MOF Model format for M2M transformation. After M2M transfor- to Text Language (MTL) standard that uses any EMF mation, if further changes are required, it is possible to based models to generate any kind of code. import PSM in XMI format back to MagicDraw CASE To perform transformation from PSM to code, PIM tool to modify it before proceeding to code generation. model in XMI format must be imported to Eclipse AcAfter PSM modification it is possible to save this model celeo tool. Then transformation option should be sein XMI format for further transformation. lected for Acceleo code generation engine to perform
Transformation from PIM to PSM can be performed the transformation from PSM to code according to the using Eclipse tool and according to the rules and algo- defined rules and algorithms. The result of this transrithms which have to be defined using ATL transfor- formation is PHP Laravel code. mation language [17]. ATL provides a way to produce For the proposed transformation methodology, we a number of target models from a set of source mod- have chosen to use UML class and sequence diagrams els. An ATL transformation tool is composed of rules, in PIM and in PSM. The implementation plan for the which define how source model elements are used to proposed methodology consists of several steps. The create the elements of the target model. ifrst step is the definition of the PIM metamodel, which
To perform transformation from PIM to PSM, XMI will consist of relevant class and sequence diagram format PIM file must be imported into Eclipse ATL metaclasses, the next step is the definition of PSM metatool. Afterwards, transformation option should be se- model which will consist of relevant class and sequence lected for the ATL transformation engine to perform metaclasses enriched with UML profile, encompassing transformation rules and algorithms applied, PSM mospecific Laravel framework stereotypes. After defin- del should be generated, where previous classes acing both metamodels, we will perform the first trans- cording to the class type would become classes with formation using PIM metamodel as input, and by ap- applied «LaravelBlade», «LaravelModel», «LaravelRoplying transformation rules the PSM will be generated ute> or «LaravelRequest» stereotype. «LaravelBlade» according to the defined PSM metamodel. After defin- stereotype defines Laravel views, «LaravelController» ing the first transformation in detail we will proceed stereotype defines Laravel framework controller type, to the next step – detail definition transformation to «LaravelModel» defines frameworks’ model type, «Larcode. The input of this transformation will be the re- avelRoutes» defines application route and «LaravelResult of previous transformation (PSM), and its output quest» defines a class used for validation in Laravel will be PHP Laravel code according to the defined code framework. metamodel and transformation rules. In Fig. 5, a fragment of PSM model for bookstore information system is presented. This fragment gives an example of how the PIM model depicted in Fig. 4 4. Model Transformation and might look like after transformation from PIM to PSM.
Code Generation Example Previously defined AddBookView and BookListView views after transformation become views that have «LarIn our proposed methodology, platform independent avelBlade» stereotype applied, which is specific for Larmodel should be developed according to MVC archi- avel framework. For BookController class, the «Lartecture principles. When modelling PIM, it is impor- avelController» stereotype is applied and operations tant to have in mind that controller, model and view in this controller are replaced with Laravel type operaparts must be separate classes. tions according to the stereotypes in the PIM model. In
Model classes should have attributes and operations this case, PIM showAdd() operation became the PSM declared, controller classes should include operations create() operation, because in PIM model it had «Route» for navigation between view classes, operations for stereotype assigned, and the showList() operation bedata manipulation and other additional operations, if came index() operation also due to assigned «Route» required. When adding operations to the controller stereotype. The save() operation was transformed to class, it is important to assign stereotypes to them, store(request) operation because of the «CRUD» stereowhich indicate whether it is a route type or a CRUD type, which was applied in PIM model. (Create, Read, Update, Delete) type operation. «Route» The Book model class after transformation became stereotype defines an operation which is intended for class with «LaravelModel» stereotype. In the PSM morouting between diferent views. del, a new class was created after transformation – the «CRUD» stereotype defines an operation intended BookRequest class with «LaravelRequest» stereotype for manipulating the database. If controller class op- applied. This PSM class, after transformation to code eration does not have any stereotype applied, this op- will define the validation rules for BookController CRUD eration is considered as an additional one, which is re- operations. The PSM model also has Routes class, that quired by the user. will define routes for controller classes route type meth
In order to demonstrate the proposed solution, in ods.
Fig. 4 a fragment of PIM model for Bookstore informa- After transformation from PSM to code, PHP Lartion system is presented. The fragment contains four avel code should be generated. Sample code fragments PIM classes: Book, BookController, AddBookView and of BookController, Book, AddBookView, Router and BookListView. Each operation of BookController class BookRequest classes are presented in Fig. 6-10. has its own stereotype applied, which will further be Fig. 6 shows Laravel controller code fragment for used during transformation to PSM process. PSM model BookController. In this controller class as
In this case, BookController class has an assigned sociation with Book class was generated because of the «Route» stereotype for the showList() and showAdd() association relationship defined between BookControloperations, the showList() operation provides the Book- ler and Book classes in PSM model. Index(), create() ListView view and the showAdd() operation provides and store(BookRequest request) methods were generthe AddBookView view. The «CRUD» stereotype is ated in this class because the corresponding operations assigned to the save() operation, which is intended for were also defined for PSM model BookController. creating a new book. Fig. 7 shows Laravel Book model code fragments After model transformation from PIM to PSM, with for PSM model Book class. Book model would be generated from PSM model Book class which has «Lar
In this paper, a methodology is proposed, which when Figure 9: Generated Laravel view code fragment. implemented could enable transformation of web application UML models into Laravel code. While organizations nowadays seek to apply the MDA prin
Fig. 10 shows generated Laravel request validation ciples in information system development to reduce class BookRequest code fragment. It is possible to cre- high technological migration costs, there is a need for ate and use a custom form request for better Laravel a methodology and algorithms to generate code for application structure or more complex validation sce- Laravel PHP framework based information systems. narios. Form request are custom request classes that Laravel framework does not have a complete methodcontain validation logic. In this case, BookRequest class ology for managing MDA model transformations and code fragment could be generated. Validation rules code generation and the proposed methodology for mocould be generated in rules() method of this class, where del transformations and code generation for the PHP variables would be obtained through BookController Laravel framework in the context of the MDA prinrelation with Book model, and “required” rules would ciples should help to improve the process of software be defined in PIM Book model attribute specification. development using Laravel. When implemented, the
The presented model transformation and code gen- proposed methodology should reduce the migration eration example demonstrated how PIM and PSM mod- and development costs of organizations working with els and generated code should be defined when imple- PHP Laravel framework. mented for bookstore information system. In example In the future, we are planning to develop more decase, the generated code consists of five classes and tailed transformation algorithms and implement the one route: two view classes, one route class, controller proposed methodology to facilitate the development class, model class and request validation class. All of of Laravel framework based information systems. these classes have code fragment structure that a software developer can further extend to finish the implementation of the BookStore information system. References