Class humhub\components\access\GuestAccessValidator

All Classes | Properties | Methods
Inheritancehumhub\components\access\GuestAccessValidator » humhub\components\access\AccessValidator » yii\base\BaseObject

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$access humhub\components\access\ControllerAccess Access instance humhub\components\access\AccessValidator
$actionFilter boolean Determines if this validator is only interested in action related rules or all validator related rules humhub\components\access\AccessValidator
$code humhub\components\access\GuestAccessValidator
$name humhub\components\access\GuestAccessValidator
$reason string Validator error message humhub\components\access\AccessValidator

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getCode() humhub\components\access\AccessValidator
getReason() humhub\components\access\AccessValidator
init() humhub\components\access\AccessValidator
run() Responsible for validating the given ruleset. humhub\components\access\GuestAccessValidator

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
extractActions() Extracts actions settings form a given rule. humhub\components\access\AccessValidator
filterRelatedRules() Filters out all rules which are not related to this validator. humhub\components\access\AccessValidator
getRuleName() Extracts the ruleName from the given array. humhub\components\access\AccessValidator
isActionRelated() Checks if the current action is contained in the given $rule. humhub\components\access\AccessValidator

Property Details

$code public property
public $code = 403
$name public property
public $name = 'guestAccess'

Method Details

run() public method

Responsible for validating the given ruleset.

Related rules may be filtered by means of the filterRelatedRules() function. The whole rule set can be retrieved by calling $this->access->rules.

public boolean run ( )
return boolean

True if validation passed otherwise true