model/modx/modprincipal.class.php
- abstract
- package
- modx
- Classes
- modPrincipal
Description
Represents a person or system that will access modX.
{@internal Implement a derivative to define the behavior and attributes of an actual user or system that is intended to access modX or a modX service.}
\modPrincipal
- Extends from
- \xPDOSimpleObject
- abstract
- package
- modx
- Properties
- $_attributes
- Methods
- getAttributes
- loadAttributes
Description
Represents a person or system that will access modX.
{@internal Implement a derivative to define the behavior and attributes of an actual user or system that is intended to access modX or a modX service.}
Properties
$_attributes
array $_attributes = 'null'Stores a collection of key-value pairs identifying policy authority.
Details
- array
- visibility
- protected
- default
- null
- final
- false
- static
- false
- access
- protected
Methods
getAttributes
getAttributes(
$targets
=
array, $context, $reload
=
false
)
:
Arguments
- $targets
- $context
- $reload
Details
- visibility
- public
- final
- false
- static
- false
loadAttributes
loadAttributes(
$target, string $context, boolean $reload
=
false
)
:
Load attributes of the principal that define access to secured objects.
{@internal Implement this function in derivatives to control how your user class uses the MODX ABAC (Attribute-Based Access Control) security model}
Arguments
- $target
- $context
- string
Context to check within, defaults to current context. - $reload
- boolean
If true, the attributes will be reloaded and the session updated.
Details
- visibility
- public
- final
- false
- static
- false
- abstract
- access
- protected