Documentation

Permission extends EntityBase
in package

cloudrexx

core

access

Permission

Properties

$allowedMethods : array<string|int, mixed>: Allowed access methods
$allowedOrigins : array<string|int, mixed>
$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: Route methods like getName(), getType(), getDirectory(), etc.
__construct() : mixed: Constructor Calback may only be used for virtual instances
__get() : mixed: This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
__toString() : string: Returns this entity's identifying value
addReadDataAccess() : Permission: Add readDataAccesses
addWriteDataAccess() : Permission: Add writeDataAccesses
getAllowedMethods() : array<string|int, mixed>: Get the allowed methods
getAllowedOrigins() : array<string|int, mixed>: Returns the additionally allowed origin domains
getAllowedProtocols() : array<string|int, mixed>: Get the allowed protocols
getCallback() : callable: Get the callback
getComponentController() : SystemComponent: Returns the component controller for this component
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: Returns the value of a translatable field using fallback mechanisms
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: Set $this->validators
isVirtual() : bool: Returns the virtuality of the entity
removeReadDataAccess() : mixed: Remove readDataAccesses
removeWriteDataAccess() : mixed: Remove writeDataAccesses
setAllowedMethods() : mixed: Set the allowed methods
setAllowedOrigins() : void: Sets the additionally allowed origin domains
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
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

$allowedMethods

Allowed access methods


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

$allowedOrigins


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

List of allowed origins (protocol and domain)

$allowedProtocols

Allowed protocols


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

$callback

Callback function name


        protected
            string
    $callback
     = null

$id


        protected
            int
    $id

$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>, ...))

$nestingCount

Counts the nesting level of __call()


        protected
        static    int
    $nestingCount
     = 0

$readDataAccesses


        protected
            Collection
    $readDataAccesses

$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

$stringRepresentationFields

List of fields that should be available in the string representation


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

List of field names

$stringRepresentationFormat

Sprintf format for the string representation


        protected
            string
    $stringRepresentationFormat
     = ''

Sprintf format string

$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.

$writeDataAccesses


        protected
            Collection
    $writeDataAccesses

__call()

Route methods like getName(), getType(), getDirectory(), etc.


    public
                    __call(string $methodName, array<string|int, mixed> $arguments) : mixed

Parameters

$methodName : string: Name of method to call
$arguments : array<string|int, mixed>: List of arguments for the method to call

Return values

mixed —

Return value of the method to call

__construct()

Constructor Calback may only be used for virtual instances


    public
                    __construct([array<string|int, mixed> $allowedProtocols = array('http', 'https') ][, array<string|int, mixed> $allowedMethods = array('get', 'post') ][, bool $requiresLogin = true ][, array<string|int, mixed> $validUserGroups = array() ][, array<string|int, mixed> $validAccessIds = array() ][, callable $callback = null ][, array<string|int, mixed> $allowedOrigins = array() ]) : mixed

Parameters

$allowedProtocols : array<string|int, mixed> = array('http', 'https')
$allowedMethods : array<string|int, mixed> = array('get', 'post')
$requiresLogin : bool = true
$validUserGroups : array<string|int, mixed> = array()
$validAccessIds : array<string|int, mixed> = array()
$callback : callable = null
$allowedOrigins : array<string|int, mixed> = array(): List of additionally allowed origins

__get()

This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.


    public
                    __get(mixed $name) : mixed

Parameters

$name : mixed

#[ReturnTypeWillChange]

__toString()

Returns this entity's identifying value


    public
                    __toString() : string

By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.

Return values

string —

Identifying value for this entity

addReadDataAccess()

Add readDataAccesses


    public
                    addReadDataAccess(DataAccess $readDataAccesses) : Permission

Parameters

$readDataAccesses : DataAccess

Return values

Permission

addWriteDataAccess()

Add writeDataAccesses


    public
                    addWriteDataAccess(DataAccess $writeDataAccesses) : Permission

Parameters

$writeDataAccesses : DataAccess

Return values

Permission

getAllowedMethods()

Get the allowed methods


    public
                    getAllowedMethods() : array<string|int, mixed>

Return values

array<string|int, mixed>

getAllowedOrigins()

Returns the additionally allowed origin domains


    public
                    getAllowedOrigins() : array<string|int, mixed>

An empty array means only the registered domains (see DomainRepository) are allowed to perform requests to this permission. Domain names may contain wildcards "*".

Return values

array<string|int, mixed> —

List of origins (protocol and domain)

getAllowedProtocols()

Get the allowed protocols


    public
                    getAllowedProtocols() : array<string|int, mixed>

Return values

array<string|int, mixed>

getCallback()

Get the callback


    public
                    getCallback() : callable

Return values

callable —

Callback for custom permission management

getComponentController()

Returns the component controller for this component


    public
                    getComponentController() : SystemComponent

Return values

SystemComponent

getId()

Get the id


    public
                    getId() : int

Return values

int

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

getReadDataAccesses()

Get the read data access


    public
                    getReadDataAccesses() : type

Return values

type

getRequiresLogin()

Get the requires login


    public
                    getRequiresLogin() : bool

Return values

bool

getTranslatedFieldValue()

Returns the value of a translatable field using fallback mechanisms


    public
                    getTranslatedFieldValue(string $fieldName) : mixed

If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):

Current locale
Default locale
All other locales

Parameters

$fieldName : string: Name of a translatable field

getvalidAccessIds()

Get the valid access ids


    public
                    getvalidAccessIds() : array<string|int, mixed>

Return values

array<string|int, mixed>

getValidUserGroups()

Get the valid user groups


    public
                    getValidUserGroups() : array<string|int, mixed>

Return values

array<string|int, mixed>

getWriteDataAccesses()

Get the read data access


    public
                    getWriteDataAccesses() : type

Return values

type

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

initializeValidators()

Set $this->validators


    public
                    initializeValidators() : mixed

Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called

isVirtual()

Returns the virtuality of the entity


    public
                    isVirtual() : bool

Return values

bool —

TRUE if the entity is virtual, otherwise FALSE

removeReadDataAccess()

Remove readDataAccesses


    public
                    removeReadDataAccess(DataAccess $readDataAccesses) : mixed

Parameters

$readDataAccesses : DataAccess

removeWriteDataAccess()

Remove writeDataAccesses


    public
                    removeWriteDataAccess(DataAccess $writeDataAccesses) : mixed

Parameters

$writeDataAccesses : DataAccess

setAllowedMethods()

Set the allowed methods


    public
                    setAllowedMethods(array<string|int, mixed> $allowedMethods) : mixed

Parameters

$allowedMethods : array<string|int, mixed>

setAllowedOrigins()

Sets the additionally allowed origin domains


    public
                    setAllowedOrigins(array<string|int, mixed> $origins) : void

An empty array means only the registered domains (see DomainRepository) are allowed to perform requests to this permission. Domain names may contain wildcards "*".

Parameters

$origins : array<string|int, mixed>: List of origins (protocol and domain)

setAllowedProtocols()

Set the allowed protocols


    public
                    setAllowedProtocols(array<string|int, mixed> $allowedProtocols) : mixed

Parameters

$allowedProtocols : array<string|int, mixed>

setCallback()

Set the callback Callback may only be used for virtual instances


    public
                    setCallback(callable $callback) : mixed

Parameters

$callback : callable

setReadDataAccesses()

Set the read data access


    public
                    setReadDataAccesses(DataAccess $dataAccess) : mixed

Parameters

$dataAccess : DataAccess

setRequiresLogin()

Set the requires login


    public
                    setRequiresLogin(bool $requiresLogin) : mixed

Parameters

$requiresLogin : bool

setValidAccessIds()

Set the valid user groups


    public
                    setValidAccessIds(array<string|int, mixed> $validAccessIds) : mixed

Parameters

$validAccessIds : array<string|int, mixed>

setValidUserGroups()

Set the valid user groups


    public
                    setValidUserGroups(array<string|int, mixed> $validUserGroups) : mixed

Parameters

$validUserGroups : array<string|int, mixed>

setVirtual()

Set virtual Callback may only be used for virtual instances


    public
                    setVirtual(bool $virtual) : mixed

Parameters

$virtual : bool

setWriteDataAccesses()

Set the write data access


    public
                    setWriteDataAccesses(DataAccess $dataAccess) : mixed

Parameters

$dataAccess : DataAccess

validate()


    public
                    validate() : mixed

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)

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

Permission extends EntityBase in package cloudrexx core access

Tags

Table of Contents

Properties

Methods

Properties

$allowedMethods

$allowedOrigins

$allowedProtocols

$callback

$id

$localeCodes

Tags

$nestingCount

$readDataAccesses

$requiresLogin

$stringRepresentationBlank

Tags

$stringRepresentationFields

Tags

$stringRepresentationFormat

Tags

$validAccessIds

$validators

$validUserGroups

$virtual

$writeDataAccesses

Methods

__call()

Parameters

Tags

Attributes

Return values

__construct()

Parameters

__get()

Parameters

Attributes

__toString()

Return values

addReadDataAccess()

Parameters

Return values

addWriteDataAccess()

Parameters

Return values

getAllowedMethods()

Return values

getAllowedOrigins()

Return values

getAllowedProtocols()

Return values

getCallback()

Return values

getComponentController()

Return values

getId()

Return values

getKeyAsString()

Parameters

Return values

getReadDataAccesses()

Return values

getRequiresLogin()

Return values

getTranslatedFieldValue()

Parameters

getvalidAccessIds()

Return values

getValidUserGroups()

Return values

getWriteDataAccesses()

Return values

hasAccess()

Parameters

Return values

initializeValidators()

isVirtual()

Return values

removeReadDataAccess()

Permission extends EntityBase
in package

cloudrexx

core

access