1573. Class

1573.1. Zend\Permissions\Acl\Role\Registry

1573.1.1. Methods

1573.1.1.1. add

add()

Adds a Role having an identifier unique to the registry

The $parents parameter may be a reference to, or the string identifier for, a Role existing in the registry, or $parents may be passed as an array of these - mixing string identifiers and objects is ok - to indicate the Roles from which the newly added Role will directly inherit.

In order to resolve potential ambiguities with conflicting rules inherited from different parents, the most recently added parent takes precedence over parents that were previously added. In other words, the first parent added will have the least priority, and the last parent added will have the highest priority.

Parameters:

• RoleInterface –
• RoleInterface|string|array –

Throws ExceptionInvalidArgumentException:   Return type:

Registry Provides a fluent interface

1573.1.1.2. get

get()

Returns the identified Role

The $role parameter can either be a Role or a Role identifier.

Parameters:RoleInterface|string – Throws ExceptionInvalidArgumentException:   Return type:RoleInterface

1573.1.1.3. has

has()

Returns true if and only if the Role exists in the registry

The $role parameter can either be a Role or a Role identifier.

Parameters:RoleInterface|string – Return type:bool

1573.1.1.4. getParents

getParents()

Returns an array of an existing Role’s parents

The array keys are the identifiers of the parent Roles, and the values are the parent Role instances. The parent Roles are ordered in this array by ascending priority. The highest priority parent Role, last in the array, corresponds with the parent Role most recently added.

If the Role does not have any parents, then an empty array is returned.

Parameters:RoleInterface|string – Return type:array

1573.1.1.5. inherits

inherits()

Returns true if and only if $role inherits from $inherit

Both parameters may be either a Role or a Role identifier. If $onlyParents is true, then $role must inherit directly from $inherit in order to return true. By default, this method looks through the entire inheritance DAG to determine whether $role inherits from $inherit through its ancestor Roles.

Parameters:

• RoleInterface|string –
• RoleInterface|string –
• bool –

Throws ExceptionInvalidArgumentException:   Return type:

bool

1573.1.1.6. remove

remove()

Removes the Role from the registry

The $role parameter can either be a Role or a Role identifier.

Parameters:RoleInterface|string – Throws ExceptionInvalidArgumentException:   Return type:Registry Provides a fluent interface

1573.1.1.7. removeAll

removeAll()

Removes all Roles from the registry

Return type:Registry Provides a fluent interface

1573.1.1.8. getRoles

getRoles()

Get all roles in the registry

Return type:array