Melis Platform engine module
MelisEngine provides a set of services and classes to access the CMS' pages and datas.
These instructions will get you a copy of the project up and running on your machine.
Run the composer command:
composer require melisplatform/melis-engine
Database model is accessible on the MySQL Workbench file:
Database will be installed through composer and its hooks.
In case of problems, SQL files are located here:
- All Melis CMS database model
- Services to access the page and tree system
- Default Melis templating plugin abstract class
- Page microservices
MelisEngine provides many services to be used in other modules:
Provides services to get all datas from a page. File: /melis-engine/src/Service/MelisPageService.php
// Get the service $melisPage = $this->getServiceLocator()->get('MelisEnginePage'); // Get all datas of this page $datasPageRes = $melisPage->getDatasPage($siteMainPage);
Provides services to get sets of pages based on the tree of pages.
Meant to deliver parent pages, breadcrumb, generate menus, generate URLs, etc.
// Get the service $treeSrv = $this->getServiceLocator()->get('MelisEngineTree'); // Get the breadcrumb $pageBreadcrumb = $treeSrv->getPageBreadcrumb($pageId, 0, true);
This service deals with search on the Melis Platform hosted website.
Search is done using Zend_Search.
// Get the service $searchSvc = $this->getServiceLocator()->get('MelisSearch'); // Search $searchresults = $searchSvc->search($keyword, $moduleName, true);
All models used my the platform to access the CMS part of the database are located in this module.
Melis Platform offers a plugin system for edition of pages.
All plugins are built on the ZF2 Controller plugin system, and all plugins must extend this class too as it provides many default and awaited methods.
- Melis Technology - www.melistechnology.com
See also the list of contributors who participated in this project.
This project is licensed under the OSL-3.0 License - see the LICENSE.md file for details