Download the PHP package melisplatform/melis-cms-twig without Composer

On this page you can find all versions of the php package melisplatform/melis-cms-twig. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of melisplatform/melis-cms-twig

Informations about the package melis-cms-twig

Melis CMS Twig

Extends Twig's functionalities to offer an alternative rendering strategy. This module is based on ZendFramework's ZfcTwig.

Getting started

These instructions will get you a copy of the project up and running on your machine.

Installation

Run the composer command:

Guides

Basic usage inside Melis Platform

By default, Melis CMS Twig can be used to render a page inside Melis CMS by performing the following:

I. Base Template creation

This base template will be extended by a child layout.

  1. Inside your site's layout view folder, create a view file with a twig file extension:

    ..\view\layout\defaultTwigLayout.twig

    This template must be registered in your site module's configuration:

    Possible contents of a base template can be seen in this sample: defaultTwigLayout.twig

II. Child Template creation

For this example, we will be creating a "Home" page.

  1. Inside your site's view folder, create a new file:

    ..\view\my-demo-site-name\home\my-index.twig

    Sample child templates: news-list.twig

  2. Inside Melis Platform, go to MelisCms > Site Tools > Template manager, and add a New template.

    • Site: My Demo Site Name
    • Template type: Twig
    • Layout: defaultTwigLayout
    • Controller: Home
    • Action: myIndex

    Layout shall be the base template's name as registered in your module configuration. In other words, MyDemoSiteName/defaultTwigLayout.

    Action shall be the child template's comma-separated filename, transformed into Camel Case.

    Inside Home Controller, implement a method named myIndexAction(...).

III. Twig a page
  1. Inside Melis Platform, go to MelisCms > Site tree view. Create a new page.

  2. Set the page's Template to your child template from the previous step. Select Draft to save & reload the Page.

    Note: To enable Twig rendering in front, enable Melis CMS Twig in in your site's module.load.php.

Using View Helpers

Inside your twig templates, Melis CMS Twig provides access to various View Helpers:

Converting a Melis Plugin

To make use of Melis Plugins inside Twig templates, convert them as view helpers.

I. Helper creation

  1. Create/Copy the helper class that extends Laminas's AbstractHelper.

  2. Implement the __invoke method that it calls your plugin: ServiceManager->get('ControllerPluginManager')->get('YourPlugin').

  3. return the result of ViewRenderer->render(YourPlugin).

II. Helper Factory creation

  1. Create/Copy the helper factory class that implements Laminas's FactoryInterface

  2. Implement the createService method that it instantiates the Helper from the previous step, passing all the needed parameters.

III. Helper Registration

The conversion process actually creates a Twig function injected inside Melis CMS Twig's Environment via ZF2's View Helper Manager. This is the reason why you need to register your plugin under the view_helpers key.

  1. Under your site's configuration (my-demo-site-name\config\module.config.php), register your plugin's helper:

References

These documentations mainly helped in understanding & implementing the module:

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the Melis Technology premium versions end user license agreement (EULA) - see the LICENSE.md file for details

All versions of melis-cms-twig with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1|^8.3
twig/twig Version ^3.8
melisplatform/melis-core Version ^5.2
melisplatform/melis-cms Version ^5.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package melisplatform/melis-cms-twig contains the following files

Loading the files please wait ....