ExplicitReadWriteModelPermissions Class Reference

Public Member Functions

 addReadOnlyPermitable (Permitable $permitable)
 addReadWritePermitable (Permitable $permitable)
 addReadOnlyPermitableToRemove (Permitable $permitable)
 addReadWritePermitableToRemove (Permitable $permitable)
 removeAllReadWritePermitables ()
 getReadOnlyPermitablesCount ()
 getReadWritePermitablesCount ()
 getReadOnlyPermitablesToRemoveCount ()
 getReadWritePermitablesToRemoveCount ()
 getReadOnlyPermitables ()
 getReadWritePermitables ()
 getReadOnlyPermitablesToRemove ()
 getReadWritePermitablesToRemove ()
 isReadOrReadWritePermitable (Permitable $permitable)
 resolvePermitableKey (Permitable $permitable)

Protected Member Functions

 resolveIsReadOnlySupported ()

Protected Attributes

 $readOnlyPermitables = array()
 $readWritePermitables = array()
 $readOnlyPermitablesToRemove = array()
 $readWritePermitablesToRemove = array()

Detailed Description

Class helps interaction between the user interface, forms, and controllers that are involved in setting the explicit permissions on a model. This class merges permission concepts together to form easier to understand structures for the user interface. Currently this only supports either readOnly or readWrite permission combinations against a model for a user or group.

See also:
ExplicitReadWriteModelPermissionsElement
ExplicitReadWriteModelPermissionsUtil

Definition at line 45 of file ExplicitReadWriteModelPermissions.php.


Member Function Documentation

addReadOnlyPermitable ( Permitable permitable  ) 

Add a permitable object to the read only array.

Parameters:
object $permitable
Exceptions:
NotSupportedException 

Definition at line 78 of file ExplicitReadWriteModelPermissions.php.

addReadWritePermitable ( Permitable permitable  ) 

Add a permitable object to the read write array.

Parameters:
object $permitable
Exceptions:
NotSupportedException 

Definition at line 98 of file ExplicitReadWriteModelPermissions.php.

addReadOnlyPermitableToRemove ( Permitable permitable  ) 

Add a permitable object that needs to be removed from the securable item.

Parameters:
object $permitable
Exceptions:
NotSupportedException 

Definition at line 117 of file ExplicitReadWriteModelPermissions.php.

addReadWritePermitableToRemove ( Permitable permitable  ) 

Add a permitable object that needs to be removed from the securable item.

Parameters:
object $permitable
Exceptions:
NotSupportedException 

Definition at line 137 of file ExplicitReadWriteModelPermissions.php.

getReadOnlyPermitablesCount (  ) 
Returns:
integer count of read only permitables

Definition at line 166 of file ExplicitReadWriteModelPermissions.php.

getReadWritePermitablesCount (  ) 
Returns:
integer count of read/write permitables

Definition at line 174 of file ExplicitReadWriteModelPermissions.php.

getReadOnlyPermitablesToRemoveCount (  ) 
Returns:
integer count of read only permitables to remove from a securable item.

Definition at line 182 of file ExplicitReadWriteModelPermissions.php.

getReadWritePermitablesToRemoveCount (  ) 
Returns:
integer count of read/write permitables to remove from a securable item.

Definition at line 190 of file ExplicitReadWriteModelPermissions.php.

getReadOnlyPermitables (  ) 
Returns:
array of read only permitables

Definition at line 198 of file ExplicitReadWriteModelPermissions.php.

getReadWritePermitables (  ) 
Returns:
array of read/write permitables

Definition at line 206 of file ExplicitReadWriteModelPermissions.php.

getReadOnlyPermitablesToRemove (  ) 
Returns:
array of read only permitables to remove from a securable item.

Definition at line 214 of file ExplicitReadWriteModelPermissions.php.

getReadWritePermitablesToRemove (  ) 
Returns:
array of read/write permitables to remove to remove from a securable item.

Definition at line 222 of file ExplicitReadWriteModelPermissions.php.

isReadOrReadWritePermitable ( Permitable permitable  ) 

Given a permitable, is that permitable in the read only data or the read write data?

Parameters:
Permitable $permitable
Returns:
boolean true if it is in one of the data arrays.

Definition at line 232 of file ExplicitReadWriteModelPermissions.php.

resolvePermitableKey ( Permitable permitable  ) 

Returns the related id from permitable models. This is unique for every Permitable child. Public for tests

Parameters:
Permitable $permitable
Returns:
int

Definition at line 250 of file ExplicitReadWriteModelPermissions.php.

resolveIsReadOnlySupported (  )  [protected]

If the read munge is also used for the write munge, then use of read only is not supported. Change the processReadMungeAsWriteMunge param to false in order to properly use readOnly. In the future the performance improvement from processReadMungeAsWriteMunge will be refactored to fully support readOnly.

Returns:
NotSupportedException

Definition at line 262 of file ExplicitReadWriteModelPermissions.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Wed Sep 18 07:10:53 2019