Melis Platform V2. Front-Office. Create a website. Content: Date Version 2.0

Transcription

1 4, rue du Dahomey Paris, France (+33) Melis Platform V2 Front-Office Create a website Content: This document explains how to create a website using Melis Platform V2. It will go through the different configuration steps inside the platform and describes how to create a template. Date Version Melis Technology

2 1. DECLARE YOUR WEBSITE Declare a vhost for your website Declare a website inside the platform CREATE YOUR WEBSITE S MODULE File system Create and declare a template Create your site s treeview See your page online DEVELOP YOUR TEMPLATES USING PROVIDED HELPERS AND SERVICES Melis Tag Helper Melis Link Helper Melis Navigation Melis Tree Service Melis Page Service SiteMap... 9

3 1. DECLARE YOUR WEBSITE 1.1. Declare a vhost for your website Melis Platform is a multi-website platform, therefore every website has its own vhost so it can have its own domain. <VirtualHost *:80> DocumentRoot "${docroot}/public" <Directory "${docroot}/public"> Options +Indexes +FollowSymLinks DirectoryIndex index.php Order allow,deny Allow from all AllowOverride All </Directory> ServerName SetEnv MELIS_PLATFORM "development" SetEnv MELIS_MODULE "MySiteTest" </VirtualHost> Example of a virtual host declaration for a MySiteTest website Every website will use its own modules and components and loading the modules of a website (including the website itself) shouldn t load the other websites along, as it would result to multiple useless loadings and, maybe, conflicts. On a typical ZF2 project, all modules are loaded from /config/module.load.php. This is not possible on Melis Platform for the reasons just explained. Instead, Melis Platform allows every website to have its own module.load.php that will be loaded automatically from an environment variable in the vhost : MELIS_MODULE. This variable must contain the module name of the website situated in /module/melissites/. In our example above, the platform will then load /module/melissites/mysitetest/config/module.load.php. But when making a website, you will very likely end up in creating multiple platforms: development, preproduction and production servers at least. And every environment will have its own domains for the websites. The MELIS_PLATFORM environment variable will help handle this problem, allowing to define configuration per platform (and to set id brackets specific to your platform as it will be explained later on) Declare a website inside the platform Note: When installing Melis for the first time, all these next steps will be done automatically during the setup. But this will be useful in case of setting a new site on rails or when creating new platforms. Initial setup can be run at this URL: /melis/setup, considering MelisInstaller module is activated.

4 Declare the platforms First, you will need to declare your environment in Melis Platform by using the Platforms tool situated in the System Configuration submenu on the left side of the screen: System configuration menu Platform tool Declare the website Second, you will need to declare your site in Melis Platform by using the Sites tool situated in the MelisCMS submenu on the left side of the screen: MelisCMS menu Sites tool When creating a new site, you will be invited to give the site name (the module s name of the website), along with other information which are not mandatory at this stage (home page id, 404 page id). Then, for each existing platform, you will need to provide the scheme and domain of the website. This is a very important step as the front engine of Melis Platform will automatically rewrite URLs and make 301 redirection to the correct domains or URLs when a query is received. When creation is done, a page will be created in the site s treeview with the name of your site. It is a good practice to come back to this tool and update homepage and 404 page ids. Both of them are used in order to generate breadcrumbs, or to make automatic 301 redirections if a page is not available.

5 Declare your platform s bracket of ids Because Melis Platform handles multiple website and multiple platforms, one of the problems could be the ids management. You might create pages or templates on your development platform and you could do the same at the same time on your production where your site lives. This would result in conflicts when wanting to move your newly created pages to another environment. For this reason, Melis Platform saves bracket of ids to be used on each platforms, and this allows to have different ids used on each platforms. This system must be configured in the Platforms IDs tool: MelisCMS menu Platform Ids tool 2. CREATE YOUR WEBSITE S MODULE 2.1. File system Melis Platform s website are simple ZF2 modules located in the folder /module/melissites. Therefore, a website is typically composed of the following file system: /config /language /public /src /view Module.php Configuration folder Translation folder Public folder with assets used for this module only Sources of the website: controllers, services, Views and layouts of the website Module.php of the website AssetManager / Calling assets of the website: Accessing to the public folder is done by using URLs formatted like: /[SiteName]/[files]. This is allowed thanks to the use of module AssetManager. It must be included in your site s module.load.php Example: /MySiteTest/css/styles.css /MySiteTest/images/logo.jpg

6 2.2. Create and declare a template Melis Platform s template are basically a layout and an associated view saved together into the template s table. Every page in Melis Platform is associated with a template, allowing the rendering when calling a page by its id. There is 2 different types of templates: ZF2 and PHP. ZF2 is, like its name says, a template system directly based on the ZF2 MVC implementation, meaning that a template will be based on a layout, controller, action and associated view. The PHP one, although it is available, is not recommended, but allows to simply make an evaluation of a PHP script and use the rendered result as the template. So, to create a ZF2 template home, you will need at least the following files: /src/mysitetest/controller/indexcontroller.php A controller for the business logic and a home method /view/layout/layout.phtml A layout for your site /view/my-site-test/index/home.phtml The associated view rendered from your controller s action The controller should extend the MelisSiteActionController in order to have an easy access to the page object and variables set by the melis front engine while evaluating and rendering the page. namespace MySiteTest\Controller; use MelisFront\Controller\MelisSiteActionController; use Zend\View\Model\ViewModel; class IndexController extends MelisSiteActionController { public function homeaction() { $view = new ViewModel(); $view->setvariable('idpage', $this->idpage); $view->setvariable('rendertype', $this->rendertype); $view->setvariable('rendermode', $this->rendermode); } } return $view; Inherited from the MelisSiteActionController, those variables are available anywhere and provide ready-to-use information in your templates: public $idpage; // Id of the page requested public $rendertype; // Type of rendering, zf2 or regular PHP public $rendermode; // Mode of rendering, front side or melis side (back) public $pagelangid; public $pagelanglocale; public $omelistree; public $omelispage; // LangId of the page // Locale of the page // Tree object for this page // Page object for this page Once your first template is created, it is necessary to declare it inside the Template Tool: MelisCMS menu Template Edition

7 2.3. Create your site s treeview Once the template is ready, it s time to have a look at it. First, you need to edit a page and affect the newly created template in the properties tab. Along with the template, a few properties must be set up: - Type of page: SITE, PAGE or FOLDER. Those types are not really used by the engine, but they allow a good organization of your pages - Show Menu: this will be important when Melis Navigation Class is used as it will implements rules on whether or not a page should be shown in menus (Link: name of page with link to it, Text without link: name of page only and None: no showing at all) 2.4. See your page online Once the website s pages are created, it is possible to see them on preview mode or online mode: See button in the page s tool bar 3. DEVELOP YOUR TEMPLATES USING PROVIDED HELPERS AND SERVICES Classes, services, helpers and others designed to help making templates are all located in the MelisFront module Melis Tag Helper Location of file: /melis-front/src/view/helper/melistagshelper.php This helper will create a zone in the template which will be editable by using a tag system. public function invoke($idpage, $tagid, $type, $defaultvalue = '') This helper will take as parameters: - $idpage: the id of page (can be the current page, or can be the one of another page if you want to display blocks from other pages) - $tagid: a unique string code under which the text will be saved in DB.

8 - $type: a string key that will decide what kind of tinymce configuration to load in the block being edited when the template is shown on back-office side. Types allowed are: html, textarea, media. The configuration associated with this file can be found in the BO in module.config.php: 'tinymce' => array( 'html' => 'MelisCms/public/js/tinyMCE/html.js', 'textarea' => 'MelisCms/public/js/tinyMCE/textarea.js', 'media' => 'MelisCms/public/js/tinyMCE/media.js', ), Using module.config.php for adding this key allows to take advantage of the ZF2 config module s loading, meaning that it is easy to create a BO module that will override those keys to link with different configurations, or even to create new ones that will automatically be recognized. - $defaultvalue: a text that will be shown in BO when the block has no value yet. It is important that the template looks like a normal one with values when editing the page for the first time, this value Example of implementation inside the home.phtml view: <div class="col-md-8"> <p> <?= $this->melistag($this->idpage, "home_001", "html", '<span>my default value that will be shown in the back-office</span>');?> </p> </div> This tag will be saved on the current page ($this->idpage) under the code home_ Melis Link Helper Location of file: /melis-front/src/view/helper/melislinkshelper.php public function invoke($idpage, $absolute) This helper will send you back a link to a specific page, relative or absolut. If an absolut link is asked, it will determine what site is the page coming from in order to add the domain to the URL, using for this the data provided in the site tool (site will be determined by finding the homepage of a site (declared in sites) in the breadcrumb of the asked page). Parameters: - $idpage: the targeted page id - $absolute: whether or not to create a link with the domain Example of implementation: <a href="<?= $this->melislink(2, true);?>"> My link to page 2 </a>

9 3.3. Melis Navigation Location of file: /melis-front/src/navigation/melisfrontnavigation.php This class extends the DefaultNavigationFactory. public function construct($servicelocator, $idpage, $rendermode) public function getchildrenrecursive($idpage) protected function getpages(containerinterface $container) This Navigation Class will return you all the pages and subpages information needed to create a menu Melis Tree Service Location of file: /melis-engine/src/service/melispageservice.php Service name: MelisEngineTree This service provides everything needed that deals with the treeview of pages: getting a parent page, getting children, getting a breadcrumb of pages public function getpagechildren($idpage, $publishedonly = 0) public function getpagefather($idpage) public function getpagebreadcrumb($idpage, $typelinkonly = 1, $allpages = true) public function getpagelink($idpage, $absolute = false) public function getdomainbypageid($idpage) public function getsitebypageid($idpage) public function getprevnextpage($idpage, $publishedonly = 1) 3.5. Melis Page Service Location of file: /melis-engine/src/service/melistreeservice.php Service name: MelisEnginePage This service provides an access to the datas of the pages. public function getdataspage($idpage, $type = 'published') 3.6. SiteMap Sitemap is automatically accessible using one of the following URLs (domain will determine which site to use for making the sitemap): - /sitemap - /sitemap.xml - /sitemap.html