spomky-labs/role-hierarchy-bundle

Symfony2 Role Hierarchy Bundle

Role Hierarchy

, _(*1)

, _(*2)

, _(*3)

Prerequisites

This version of the bundle requires:, _(*4)

• Symfony 2.8 or 3.0+
• PHP 5.6+

It has been successfully tested using PHP 5.6 to PHP 7.0 and HHVM under Symfony 2.8 to 3.0., _(*5)

Installation

Installation is a quick 4 steps process:, _(*6)

• Install the bundle
• Enable the bundle
• Create your model class
• Configure the bundle

Step 1: Install the bundle

The preferred way to install this bundle is to rely on Composer:, _(*7)

composer require spomky-labs/role-hierarchy-bundle

Step 2: Enable the bundle

Finally, enable the bundle in the kernel:, _(*8)

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new SpomkyLabs\RoleHierarchyBundle\SpomkyLabsRoleHierarchyBundle(),
    );
}

Step 3: Create model class

This bundle needs to persist roles to a database:, _(*9)

Your first job, then, is to create a role class for your application. This class can look and act however you want: add any properties or methods you find useful., _(*10)

There is just a few requirements:, _(*11)

• They must be sure that role names are unique
• They should follow naming conventions

In the following sections, you'll see an example of how your class should look., _(*12)

Your class can live inside any bundle in your application. For example, if you work at "Acme" company, then you might create a bundle called AcmeRoleBundle and place your classs in it., _(*13)

This bundle is able to support Doctrine ORM, ODM, CouchDB or MongoDB. Please note that only ORM has been tested., _(*14)

Doctrine ORM

If you are persisting your data via the Doctrine ORM, then your class should live in the Entity namespace of your bundle and look like this to start:, _(*15)

<?php
// src/Acme/RoleBundle/Entity/Role.php

namespace Acme\RoleBundle\Entity;

use SpomkyLabs\RoleHierarchyBundle\Entity\Role as Base;
use Doctrine\ORM\Mapping as ORM;

/**
 * Role
 *
 * @ORM\Table(name="roles")
 * @ORM\Entity()
 */
class Role extends Base
{
    /**
     * @var integer $id
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * @ORM\ManyToOne(targetEntity="Role")
     * @ORM\JoinColumn(name="parent_id", referencedColumnName="id")
     **/
    protected $parent;

    public function getId() {
        return $this->id;
    }
}

Doctrine ODM

To be written, _(*16)

Couch DB

To be written, _(*17)

Mongo DB

To be written, _(*18)

Step 4: Configure your application

# app/config/config.yml
spomkylabs_role_hierarchy:
    role_class: "Acme\RoleBundle\Entity\Role"

If you have your own roles manager, you can use it. It just needs to implement SpomkyLabs\RoleHierarchyBundle\Model\RoleManagerInterface., _(*19)

# app/config/config.yml
spomkylabs_role_hierarchy:
    ...
    role_manager: "my.custom.role.manager"