Zend Framework
Back to top  

 Methods

Add a child.

addRole(string | \Zend\Permissions\Rbac\RoleInterface $child, array | \Zend\Permissions\Rbac\RoleInterface | null $parents) : \Zend\Permissions\Rbac\self

Parameters

$child

string\Zend\Permissions\Rbac\RoleInterface

$parents

array\Zend\Permissions\Rbac\RoleInterfacenull

Exceptions

\Zend\Permissions\Rbac\Exception\InvalidArgumentException

Returns

\Zend\Permissions\Rbac\self

(PHP 5 &gt;= 5.0.0)<br/> Return the current element

current() : mixed
Inherited

link http://php.net/manual/en/iterator.current.php
inherited_from \Zend\Permissions\Rbac\AbstractIterator::current()

Returns

mixedCan return any type.

(PHP 5 &gt;= 5.1.0)<br/> Returns an iterator for the current entry.

getChildren() : \RecursiveIterator
Inherited

link http://php.net/manual/en/recursiveiterator.getchildren.php
inherited_from \Zend\Permissions\Rbac\AbstractIterator::getChildren()

Returns

\RecursiveIteratorAn iterator for the current entry.

getCreateMissingRoles() 

getCreateMissingRoles() : bool

Returns

bool

Get a child.

getRole(\Zend\Permissions\Rbac\RoleInterface | string $objectOrName) : \Zend\Permissions\Rbac\RoleInterface

Parameters

$objectOrName

\Zend\Permissions\Rbac\RoleInterfacestring

Exceptions

\Zend\Permissions\Rbac\Exception\InvalidArgumentException

Returns

\Zend\Permissions\Rbac\RoleInterface

(PHP 5 &gt;= 5.1.0)<br/> Returns if an iterator can be created fot the current entry.

hasChildren() : bool
Inherited

link http://php.net/manual/en/recursiveiterator.haschildren.php
inherited_from \Zend\Permissions\Rbac\AbstractIterator::hasChildren()

Returns

booltrue if the current entry can be iterated over, otherwise returns false.

Is a child with $name registered?

hasRole(\Zend\Permissions\Rbac\RoleInterface | string $objectOrName) : bool

Parameters

$objectOrName

\Zend\Permissions\Rbac\RoleInterfacestring

Returns

bool

Determines if access is granted by checking the role and child roles for permission.

isGranted(\Zend\Permissions\Rbac\RoleInterface | string $role, string $permission, \Zend\Permissions\Rbac\AssertionInterface | \Zend\Permissions\Rbac\Callable | null $assert) : bool

Parameters

$role

\Zend\Permissions\Rbac\RoleInterfacestring

$permission

string

$assert

\Zend\Permissions\Rbac\AssertionInterface\Zend\Permissions\Rbac\Callablenull

Exceptions

\Zend\Permissions\Rbac\Exception\InvalidArgumentException

Returns

bool

(PHP 5 &gt;= 5.0.0)<br/> Return the key of the current element

key() : int | null
Inherited

link http://php.net/manual/en/iterator.key.php
inherited_from \Zend\Permissions\Rbac\AbstractIterator::key()

Returns

intnullscalar on success, or null on failure.

(PHP 5 &gt;= 5.0.0)<br/> Rewind the Iterator to the first element

rewind() : void
Inherited

link http://php.net/manual/en/iterator.rewind.php
inherited_from \Zend\Permissions\Rbac\AbstractIterator::rewind()

setCreateMissingRoles() 

setCreateMissingRoles(bool $createMissingRoles) : \Zend\Permissions\Rbac\Rbac

Parameters

$createMissingRoles

bool

Returns

\Zend\Permissions\Rbac\Rbac

(PHP 5 &gt;= 5.0.0)<br/> Checks if current position is valid

valid() : bool
Inherited

link http://php.net/manual/en/iterator.valid.php
inherited_from \Zend\Permissions\Rbac\AbstractIterator::valid()

Returns

boolThe return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

 Properties

 

$children

$children : array
Inherited

inherited_from \Zend\Permissions\Rbac\AbstractIterator::$$children
 

flag: whether or not to create roles automatically if they do not exist.

$createMissingRoles : bool

 

$index

$index : int
Inherited

inherited_from \Zend\Permissions\Rbac\AbstractIterator::$$index