Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 1.98 KB

README.md

File metadata and controls

74 lines (53 loc) · 1.98 KB
Raw

ezobject

Symfony Bundle eZObjectWrapperBundle for eZ Publish 5 development (>=5.3).

version 1.0 24/10/2014

Developed by the Kaliop team.

Description

This bundle offers a simple model to encapsulate location and content for eZPublish 5 development. It provides a factory to build eZObjectWrapper and extended classes.

eZObjectWrapper provides a lazy-loading method to fetch content. Extended wrapper classes can for example expose methods to fetch secondary contents without overloading main controller and creating new kernel request.

These extended classes are built via a class_mapping in eZObjectWrapper.yml.

This bundle also provides a Twig function, renderLocation, wich uses the ViewController as a service, and doesn't relaunch the Symfony kernel, for more efficiency.

Installation

The recommanded way to install this bundle is through Composer.

  • Require the ezobject/wrapperbundle package into your composer.json file :
{
	"repositories": [
        { "type": "vcs", "url": "https://github.com/kaliop/ezobjectwrapper.git" }
    ],
    "require": {
        "ezobject/wrapperbundle": "~1.0"
    }
}
  • Add eZObjectWrapperBundle into EzPublishKernel.php:
new \Kaliop\eZObjectWrapperBundle\eZObjectWrapperBundle()

Usage

Building eZObjectWrapper

// get the service
$factory = $this->container->get('ezobject_wrapper.services.factory');
// build accepts Location or locationID as parameter
$factory->buildeZObjectWrapper($location);

Class mapping

parameters:
    class_mapping:
        content_identifier: \myGreat\BundleBundle\eZObjectWrapper\ClassesExtendingeZObjectWrapper

renderLocation

{{ renderLocation(locationId, 'view_type', { ezObjectWrapper : myObject }) |raw }}

Call method or attribute from eZObjectWrapper in Twig

{{ ez_field_value(ezObjectWrapper.content, 'title') }}

Contact

E-mail : asavoie@kaliop.com / sbressey@kaliop.com