HumHub Documentation (unofficial)

DelegateAccessValidator extends ActionAccessValidator
in package

This Validator filters out non action related rules and supports a $strict mode, which will require all validator related rules to pass.

If $strict mode is set to false only one of the validator related rules have pass.

Subclasses of ActionAccessValidator only have to extend the validate() function for validating a single rule.

Table of Contents

Properties

$access  : ControllerAccess
$actionFilter  : bool
$code  : int
$codeCallback  : string
$handler  : mixed
$name  : string
$owner  : mixed
$reason  : string
$strict  : bool

Methods

__call()  : mixed
Calls the named method which is not a class method.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of an object property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets value of an object property.
__unset()  : mixed
Sets an object property to null.
canGetProperty()  : bool
Returns a value indicating whether a property can be read.
canSetProperty()  : bool
Returns a value indicating whether a property can be set.
className()  : string
Returns the fully qualified name of this class.
getCode()  : int
getReason()  : string
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined.
init()  : mixed
Initializes the object.
run()  : bool
Runs the validation against all validator and action related rules.
extractActions()  : array<string|int, mixed>
Extracts actions settings form a given rule.
filterRelatedRules()  : array<string|int, mixed>
Filters out rules not related to the current validator and action.
getRuleName()  : mixed|null
Extracts the ruleName from the given array.
isActionRelated()  : bool
Checks if the current action is contained in the given $rule.
validate()  : mixed

Properties

$actionFilter

public bool $actionFilter = true

determines if this validator is only interested in action related rules or all validator related rules

$code

public int $code

http error code used in case the validation failes

$codeCallback

public string $codeCallback

Name of callback method to run after failed validation

Tags
since
1.8

$strict

public bool $strict = true

if set to true (default) all validator related rules have to pass otherwise only one

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__construct()

Constructor.

public __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call [[init()]].

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
Parameters
$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

__get()

Returns the value of an object property.

public __get(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only

see
__set()
Return values
mixed —

the property value

__isset()

Checks if a property is set, i.e. defined and not null.

public __isset(string $name) : bool

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set (not null).

__set()

Sets value of an object property.

public __set(string $name, mixed $value) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only

see
__get()

__unset()

Sets an object property to null.

public __unset(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ]) : bool

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canSetProperty()
Return values
bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ]) : bool

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

getCode()

public getCode() : int
Return values
int —

http error code used in case the validation fails

getReason()

public getReason() : string
Return values
string —

the error message in case the validation fails

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name) : bool

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Parameters
$name : string

the method name

Return values
bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.

public hasProperty(string $name[, bool $checkVars = true ]) : bool

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

init()

Initializes the object.

public init() : mixed

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

run()

Runs the validation against all validator and action related rules.

public run() : bool

This function will return true, if there is no action related rule for this validator.

Return values
bool

extractActions()

Extracts actions settings form a given rule.

protected extractActions(mixed $rule) : array<string|int, mixed>

Action rules can be either set like:

['ruleName', 'actions' => ['action1', 'action2']]

or in some cases:

['ruleName' => ['action1', 'action2']]

Parameters
$rule : mixed
Return values
array<string|int, mixed>

filterRelatedRules()

Filters out rules not related to the current validator and action.

protected filterRelatedRules([array<string|int, mixed>|null $rules = null ]) : array<string|int, mixed>
Parameters
$rules : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>

getRuleName()

Extracts the ruleName from the given array.

protected getRuleName(mixed $rule) : mixed|null
Parameters
$rule : mixed
Return values
mixed|null

isActionRelated()

Checks if the current action is contained in the given $rule.

protected isActionRelated(mixed $rule) : bool

This is the case either if the current action is contained in the rules action settings or the rule is global (no action restriction).

Parameters
$rule : mixed
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results