icybee/module-users-roles

Provides roles for users.

Installs: 149

Dependents: 1

Suggesters: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:icanboogie-module

v3.0.0 2016-07-09 11:19 UTC

README

Release Build Status HHVM Code Quality Code Coverage Packagist

Provides roles for users.

Bindings

The following prototype bindings are provided for User instances:

  • $roles: The roles associated with a user.

     $user->roles; // Icybee\Modules\Users\Roles\Role[]
  • $role: The aggregate role associated with a user.

     $user->role; // Icybee\Modules\Users\Roles\Role

Requirement

The package requires PHP 5.5 or later.

Installation

The recommended way to install this package is through Composer:

$ composer require icybee/module-users-roles

This module is part of the modules required by Icybee.

Cloning the repository

The package is available on GitHub, its repository can be cloned with the following command line:

$ git clone https://github.com/Icybee/module-users-roles.git users.roles

Documentation

The package is documented as part of the Icybee CMS documentation. The documentation for the package and its dependencies can be generated with the make doc command. The documentation is generated in the docs directory using ApiGen. The package directory can later by cleaned with the make clean command.

License

The module is licensed under the New BSD License - See the LICENSE file for details.