eZPublishCommunityProject  2013.5
eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway Class Reference

Base class for content type gateways. More...

+ Inheritance diagram for eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway:

Public Member Functions

 addPolicy ($roleId, Policy $policy)
 Adds a policy to a role. More...
 
 addPolicyLimitations ($policyId, array $limitations)
 Adds limitations to an existing policy. More...
 
 createRole (Role $role)
 Create new role. More...
 
 deleteRole ($roleId)
 Delete the specified role. More...
 
 loadPoliciesByUserId ($userId)
 Returns the user policies associated with the user. More...
 
 loadRole ($roleId)
 Loads a specified role by $roleId. More...
 
 loadRoleAssignmentsByGroupId ($groupId, $inherited=false)
 Loads role assignments for specified content ID. More...
 
 loadRoleByIdentifier ($identifier)
 Loads a specified role by $identifier. More...
 
 loadRoles ()
 Loads all roles. More...
 
 loadRolesForContentObjects ($contentIds)
 Loads all roles associated with the given content objects. More...
 
 removePolicy ($policyId)
 Removes a policy from a role. More...
 
 removePolicyLimitations ($policyId)
 Removes a policy from a role. More...
 
 updateRole (RoleUpdateStruct $role)
 Update role. More...
 

Detailed Description

Base class for content type gateways.

Member Function Documentation

eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway::addPolicy (   $roleId,
Policy  $policy 
)
abstract

Adds a policy to a role.

Parameters
mixed$roleId
Policy$policy
Returns
void
eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway::addPolicyLimitations (   $policyId,
array  $limitations 
)
abstract

Adds limitations to an existing policy.

Parameters
int$policyId
array$limitations
Returns
void
eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway::createRole ( Role  $role)
abstract

Create new role.

Parameters
Role$role
Returns
Role
eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway::deleteRole (   $roleId)
abstract

Delete the specified role.

Parameters
mixed$roleId
eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway::loadPoliciesByUserId (   $userId)
abstract

Returns the user policies associated with the user.

Parameters
mixed$userId
Returns
UserPolicy[]
eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway::loadRole (   $roleId)
abstract

Loads a specified role by $roleId.

Parameters
mixed$roleId
Returns
array
eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway::loadRoleAssignmentsByGroupId (   $groupId,
  $inherited = false 
)
abstract

Loads role assignments for specified content ID.

Parameters
mixed$groupId
boolean$inherited
Returns
array
eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway::loadRoleByIdentifier (   $identifier)
abstract

Loads a specified role by $identifier.

Parameters
string$identifier
Returns
array
eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway::loadRoles ( )
abstract

Loads all roles.

Returns
array
eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway::loadRolesForContentObjects (   $contentIds)
abstract

Loads all roles associated with the given content objects.

Parameters
array$contentIds
Returns
array
eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway::removePolicy (   $policyId)
abstract

Removes a policy from a role.

Parameters
mixed$policyId
Returns
void
eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway::removePolicyLimitations (   $policyId)
abstract

Removes a policy from a role.

Parameters
mixed$policyId
Returns
void
eZ\Publish\Core\Persistence\Legacy\User\Role\Gateway::updateRole ( RoleUpdateStruct  $role)
abstract

Update role.

Parameters
RoleUpdateStruct$role

The documentation for this class was generated from the following file: