Documentation

Permission extends Permission
in package
implements Proxy

DO NOT EDIT THIS FILE - IT WAS CREATED BY DOCTRINE'S PROXY GENERATOR

Table of Contents

Interfaces

Proxy

Properties

$__cloner__  : Closure
$__initializer__  : Closure
$__isInitialized__  : bool
$lazyPropertiesDefaults  : array<string|int, mixed>
$allowedMethods  : array<string|int, mixed>
Allowed access methods
$allowedProtocols  : array<string|int, mixed>
Allowed protocols
$callback  : string
Callback function name
$id  : int
Id
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$nestingCount  : int
Counts the nesting level of __call()
$readDataAccesses  : Collection
$requiresLogin  : bool
is Login required or not
$stringRepresentationBlank  : bool
Whether blank string representations are valid
$stringRepresentationFields  : array<string|int, mixed>
List of fields that should be available in the string representation
$stringRepresentationFormat  : string
Sprintf format for the string representation
$validAccessIds  : array<string|int, mixed>
valid Access ids
$validators  : array<string|int, mixed>
Initialize this array as follows: array( 'columName' => Zend_Validate )
$validUserGroups  : array<string|int, mixed>
Valid User Groups
$virtual  : bool
Defines if an entity is virtual and therefore not persistable.
$writeDataAccesses  : Collection

Methods

__call()  : mixed
{@inheritDoc}
__clone()  : mixed
__construct()  : mixed
Constructor Calback may only be used for virtual instances
__get()  : mixed
{@inheritDoc}
__getCloner()  : mixed
{@inheritDoc}
__getInitializer()  : mixed
{@inheritDoc}
__getLazyProperties()  : mixed
{@inheritDoc}
__isInitialized()  : mixed
{@inheritDoc}
__load()  : mixed
Forces initialization of the proxy
__setCloner()  : mixed
{@inheritDoc}
__setInitialized()  : mixed
{@inheritDoc}
__setInitializer()  : mixed
{@inheritDoc}
__sleep()  : array<string|int, mixed>
__toString()  : mixed
{@inheritDoc}
__wakeup()  : mixed
addReadDataAccess()  : Permission
Add readDataAccesses
addWriteDataAccess()  : Permission
Add writeDataAccesses
getAllowedMethods()  : array<string|int, mixed>
Get the allowed methods
getAllowedProtocols()  : array<string|int, mixed>
Get the allowed protocols
getCallback()  : callable
Get the callback
getComponentController()  : mixed
{@inheritDoc}
getId()  : int
Get the id
getKeyAsString()  : string
Returns this entity's key
getReadDataAccesses()  : type
Get the read data access
getRequiresLogin()  : bool
Get the requires login
getTranslatedFieldValue()  : mixed
{@inheritDoc}
getvalidAccessIds()  : array<string|int, mixed>
Get the valid access ids
getValidUserGroups()  : array<string|int, mixed>
Get the valid user groups
getWriteDataAccesses()  : type
Get the read data access
hasAccess()  : bool
Check the permissions(Is allowed protocol, Is allowed method, user's group access, user's login status)
initializeValidators()  : mixed
{@inheritDoc}
isVirtual()  : mixed
{@inheritDoc}
removeReadDataAccess()  : mixed
Remove readDataAccesses
removeWriteDataAccess()  : mixed
Remove writeDataAccesses
setAllowedMethods()  : mixed
Set the allowed methods
setAllowedProtocols()  : mixed
Set the allowed protocols
setCallback()  : mixed
Set the callback Callback may only be used for virtual instances
setReadDataAccesses()  : mixed
Set the read data access
setRequiresLogin()  : mixed
Set the requires login
setValidAccessIds()  : mixed
Set the valid user groups
setValidUserGroups()  : mixed
Set the valid user groups
setVirtual()  : mixed
Set virtual Callback may only be used for virtual instances
setWriteDataAccesses()  : mixed
Set the write data access
validate()  : mixed
{@inheritDoc}
checkLoginAndUserAccess()  : bool
Check the user's login status and user's group access
getFallbackLocaleCodes()  : array<string|int, mixed>
Returns a list of all locale codes ordered by fallback order
getStringRepresentationBlank()  : bool
Whether blank string representations are valid
getStringRepresentationFields()  : array<string|int, mixed>
Returns a list of fields available in the string representation
getStringRepresentationFormat()  : string
Returns the sprintf() format for the string representation

Properties

$__initializer__

public Closure $__initializer__

the callback responsible for loading properties in the proxy object. This callback is called with three parameters, being respectively the proxy object to be initialized, the method that triggered the initialization process and an array of ordered parameters that were passed to that method.

Tags
see
Proxy::__setInitializer

$lazyPropertiesDefaults

public static array<string|int, mixed> $lazyPropertiesDefaults = array()

properties to be lazy loaded, with keys being the property names and values being their default values

Tags
see
Proxy::__getLazyProperties

$allowedMethods

Allowed access methods

protected array<string|int, mixed> $allowedMethods = array()

$allowedProtocols

Allowed protocols

protected array<string|int, mixed> $allowedProtocols = array()

$localeCodes

List of locale codes ordered by translation fallback order per Cx instance

protected static array<string|int, mixed> $localeCodes = array()

Array in the form: array(<instanceId> => array(<localeCode>, ...))

Tags
see
getFallbackLocaleCodes()

$nestingCount

Counts the nesting level of __call()

protected static int $nestingCount = 0

$requiresLogin

is Login required or not

protected bool $requiresLogin = false

$stringRepresentationBlank

Whether blank string representations are valid

protected bool $stringRepresentationBlank = false

Whether blank string representations are valid

Tags
see
getStringRepresentationBlank()

$stringRepresentationFields

List of fields that should be available in the string representation

protected array<string|int, mixed> $stringRepresentationFields = array()

List of field names

Tags
see
getStringRepresentationFields()

$stringRepresentationFormat

Sprintf format for the string representation

protected string $stringRepresentationFormat = ''

Sprintf format string

Tags
see
getStringRepresentationFormat()

$validAccessIds

valid Access ids

protected array<string|int, mixed> $validAccessIds = array()

$validators

Initialize this array as follows: array( 'columName' => Zend_Validate )

protected array<string|int, mixed> $validators = array()

$validUserGroups

Valid User Groups

protected array<string|int, mixed> $validUserGroups = array()

$virtual

Defines if an entity is virtual and therefore not persistable.

protected bool $virtual = false

Defaults to FALSE - not virtual.

Methods

__construct()

Constructor Calback may only be used for virtual instances

public __construct([Closure $initializer = null ][, Closure $cloner = null ]) : mixed
Parameters
$initializer : Closure = null
$cloner : Closure = null

__setCloner()

{@inheritDoc}

public __setCloner([Closure $cloner = null ]) : mixed
Parameters
$cloner : Closure = null
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

__setInitialized()

{@inheritDoc}

public __setInitialized(mixed $initialized) : mixed
Parameters
$initialized : mixed
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

__setInitializer()

{@inheritDoc}

public __setInitializer([Closure $initializer = null ]) : mixed
Parameters
$initializer : Closure = null
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

getKeyAsString()

Returns this entity's key

public final getKeyAsString([string $separator = '/' ]) : string

If this entity has a composite key, the fields are separated by $separator.

Parameters
$separator : string = '/'

(optional) Separator for composite key fields, default "/"

Return values
string —

Entity key as string

hasAccess()

Check the permissions(Is allowed protocol, Is allowed method, user's group access, user's login status)

public hasAccess([array<string|int, mixed> $params = array() ]) : bool
Parameters
$params : array<string|int, mixed> = array()

Params to pass to callback (if any)

Return values
bool

checkLoginAndUserAccess()

Check the user's login status and user's group access

protected checkLoginAndUserAccess() : bool
Return values
bool

getFallbackLocaleCodes()

Returns a list of all locale codes ordered by fallback order

protected getFallbackLocaleCodes() : array<string|int, mixed>
  • First entry is the current locale
  • Second entry is the default locale (if different from current, it's omitted otherwise)
  • Then all other locales follow (in no particular order)
Tags
todo

Order the array by the fallback order (same as in ContentManager)

Return values
array<string|int, mixed> —

List of locale codes

getStringRepresentationBlank()

Whether blank string representations are valid

protected getStringRepresentationBlank() : bool
Return values
bool —

Whether blank string representations are valid

getStringRepresentationFields()

Returns a list of fields available in the string representation

protected getStringRepresentationFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —

List of field names

getStringRepresentationFormat()

Returns the sprintf() format for the string representation

protected getStringRepresentationFormat() : string
Return values
string —

sprintf() format string


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results