sideclick/entity-helper-bundle

Bundle for Symfony 2.6+ which introduces entity helper classes for each Doctrine entity in your bundle

EntityHelperBundle

Bundle for Symfony 2.6+ which introduces entity helper classes for each Doctrine entity in your bundle, _(*1)

Installation

Step 1: Add the following to the "require" section of composer.json

"sideclick/entity-helper-bundle": "dev-master"

OR just require the bundle from the commandline, _(*2)

composer require sideclick/entity-helper-bundle

Step 2: Enable the bundle

Enable the bundle in the kernel:, _(*3)

``` php <?php // app/AppKernel.php, <sub>(*4)</sub>

public function registerBundles() { $bundles = array( // ... new Sideclick\EntityHelperBundle\SideclickEntityHelperBundle(), ); }, <sub>(*5)</sub>

## Usage

Entity helper classes should be defined in the /Entity/Helper directory of your bundle, here is the basic structure of an Entity Helper class for an entity named 'User':

//YourBundle\Entity\Entity\Helper\UserHelper.php, <sub>(*6)</sub>

namespace YourBundle\Entity\Helper;, <sub>(*7)</sub>

use Sideclick\EntityHelperBundle\Entity\Helper\HelperAbstract; use YourBundle\Entity\User;, <sub>(*8)</sub>

class UserHelper extends HelperAbstract { protected $_user;, <sub>(*9)</sub>

public function setUser(User $user)
{
    $this->_user = $user;
}

}, <sub>(*10)</sub>

There is a service named sideclick_entity_helper.entity_helper_factory which makes it easy to get an instance of an Entity Helper for an object, for example, in your controller you could do:

``` php
$userHelper = $this->get('sideclick_entity_helper.entity_helper_factory')->getEntityHelper($user);

Also, there is a twig function to get a helper in your templates:, <sub>(*11)</sub>

twig get_entity_helper(user), <sub>(*12)</sub>

More documentation to come..., <sub>(*13)</sub>