PHP Класс Pop\Auth\Role

Автор: Nick Sagona, III ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$children array Role children
$name string Role name
$parent Role Role parent
$permissions array Role permissions

Открытые методы

Метод Описание
__construct ( string $name ) : Role Constructor
__toString ( ) : string Method to return the string value of the name of the role
addChild ( mixed $role ) : Role Method to add a child role
addPermission ( string $name ) : Role Method to add a permission to the role
factory ( string $name ) : Role Static method to instantiate the role object and return itself to facilitate chaining methods together.
getName ( ) : string Method to get the role name
getParent ( ) : Role Method to get the role parent
hasParent ( ) : Role Method to see if the role has a parent
hasPermission ( string $name ) : boolean Method to check if a role has a permission
setParent ( Role $parent ) : Role Method to set the role parent

Описание методов

__construct() публичный Метод

Instantiate the role object
public __construct ( string $name ) : Role
$name string
Результат Role

__toString() публичный Метод

Method to return the string value of the name of the role
public __toString ( ) : string
Результат string

addChild() публичный Метод

Method to add a child role
public addChild ( mixed $role ) : Role
$role mixed
Результат Role

addPermission() публичный Метод

Method to add a permission to the role
public addPermission ( string $name ) : Role
$name string
Результат Role

factory() публичный статический Метод

Static method to instantiate the role object and return itself to facilitate chaining methods together.
public static factory ( string $name ) : Role
$name string
Результат Role

getName() публичный Метод

Method to get the role name
public getName ( ) : string
Результат string

getParent() публичный Метод

Method to get the role parent
public getParent ( ) : Role
Результат Role

hasParent() публичный Метод

Method to see if the role has a parent
public hasParent ( ) : Role
Результат Role

hasPermission() публичный Метод

Method to check if a role has a permission
public hasPermission ( string $name ) : boolean
$name string
Результат boolean

setParent() публичный Метод

Method to set the role parent
public setParent ( Role $parent ) : Role
$parent Role
Результат Role

Описание свойств

$children защищенное свойство

Role children
protected array $children
Результат array

$name защищенное свойство

Role name
protected string $name
Результат string

$parent защищенное свойство

Role parent
protected Role,Pop\Auth $parent
Результат Role

$permissions защищенное свойство

Role permissions
protected array $permissions
Результат array