Class \Prado\Security\TAuthorizationRule

TAuthorizationRule class

TAuthorizationRule represents a single authorization rule. A rule is specified by an action (required), a list of users (optional), a list of roles (optional), a verb (optional), and a list of IP rules (optional). Action can be either 'allow' or 'deny'. Guest (anonymous, unauthenticated) users are represented by question mark '?'. All users (including guest users) are represented by asterisk ''. Authenticated users are represented by '@'. Users/roles are case-insensitive. Different users/roles are separated by comma ','. Verb can be either 'get' or 'post'. If it is absent, it means both. IP rules are separated by comma ',' and can contain wild card in the rules (e.g. '192.132.23.33, 192.122..*')

Class hierarchy

\Prado\Security\TAuthorizationRule implements IPriorityItem

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`__construct([string $action = 'allow' ][, string $users = '' ][, string $roles = '' ][, string $verb = '' ][, string $ipRules = '' ][, null\|(numeric) $priority = null ]) : mixed` Constructor.
`public`	`getAction() : string`
`public`	`getAuthenticatedApplied() : bool`
`public`	`getEveryoneApplied() : bool`
`public`	`getGuestApplied() : bool`
`public`	`getIPRules() : array<string\|int, mixed>`
`public`	`getPriority() : numeric-string\|int\|float`
`public`	`getRoles() : array<string\|int, string>`
`public`	`getUsers() : array<string\|int, string>`
`public`	`getVerb() : string`
`public`	`isUserAllowed(IUser $user, string $verb, string $ip[, null\|mixed $extra = null ]) : int`
`protected`	`_getZappableSleepProps(array<string\|int, mixed> &$exprops) : mixed` Returns an array with the names of all variables of this object that should NOT be serialized because their value is the default one or useless to be cached for the next load. Reimplement in derived classes to add new variables, but remember to also to call the parent implementation first.
`private`	`isIpMatched(mixed $ip) : mixed`
`private`	`isRoleMatched(mixed $user) : mixed`
`private`	`isUserMatched(mixed $user) : mixed`
`private`	`isVerbMatched(mixed $verb) : mixed`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getListeningToGlobalEvents, getSubProperty, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, raiseEvent, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Security\TAuthorizationRule

Class hierarchy