sideclick/entity-helper-bundle

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

0.1.3 2016-12-07 08:17 UTC

Requires

• php: >=5.5
• symfony/symfony: >=2.6 || ~3.0

MIT

• Rowan Reid

README

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

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

composer require sideclick/entity-helper-bundle

Step 2: Enable the bundle

Enable the bundle in the kernel:

<?php
// app/AppKernel.php

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

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

namespace YourBundle\Entity\Helper;

use Sideclick\EntityHelperBundle\Entity\Helper\HelperAbstract;
use YourBundle\Entity\User;

class UserHelper extends HelperAbstract
{
    protected $_user;

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

}

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:

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

Also, there is a twig function to get a helper in your templates:

get_entity_helper(user)

More documentation to come...