CurrentUserPrivilegeSet
in package
implements
Element, HtmlOutput
CurrentUserPrivilegeSet.
This class represents the current-user-privilege-set property. When requested, it contain all the privileges a user has on a specific node.
Tags
Interfaces, Classes and Traits
- Element
- This is the XML element interface.
- HtmlOutput
- WebDAV properties that implement this interface are able to generate their own html output for the browser plugin.
Table of Contents
- $privileges : array<string|int, mixed>
- List of privileges.
- __construct() : mixed
- Creates the object.
- getValue() : array<string|int, mixed>
- Returns the list of privileges.
- has() : bool
- Returns true or false, whether the specified principal appears in the list.
- toHtml() : string
- Generate html representation for this value.
- xmlDeserialize() : mixed
- The deserialize method is called during xml parsing.
- xmlSerialize() : mixed
- The xmlSerialize method is called during xml writing.
Properties
$privileges
List of privileges.
private
array<string|int, mixed>
$privileges
Methods
__construct()
Creates the object.
public
__construct(array<string|int, mixed> $privileges) : mixed
Pass the privileges in clark-notation
Parameters
- $privileges : array<string|int, mixed>
Return values
mixed —getValue()
Returns the list of privileges.
public
getValue() : array<string|int, mixed>
Return values
array<string|int, mixed> —has()
Returns true or false, whether the specified principal appears in the list.
public
has(string $privilegeName) : bool
Parameters
- $privilegeName : string
Return values
bool —toHtml()
Generate html representation for this value.
public
toHtml(HtmlOutputHelper $html) : string
The html output is 100% trusted, and no effort is being made to sanitize it. It's up to the implementor to sanitize user provided values.
The output must be in UTF-8.
The baseUri parameter is a url to the root of the application, and can be used to construct local links.
Parameters
- $html : HtmlOutputHelper
Return values
string —xmlDeserialize()
The deserialize method is called during xml parsing.
public
static xmlDeserialize(Reader $reader) : mixed
This method is called statically, this is because in theory this method may be used as a type of constructor, or factory method.
Often you want to return an instance of the current class, but you are free to return other data as well.
You are responsible for advancing the reader to the next element. Not doing anything will result in a never-ending loop.
If you just want to skip parsing for this element altogether, you can just call $reader->next();
$reader->parseInnerTree() will parse the entire sub-tree, and advance to the next element.
Parameters
- $reader : Reader
Return values
mixed —xmlSerialize()
The xmlSerialize method is called during xml writing.
public
xmlSerialize(Writer $writer) : mixed
Use the $writer argument to write its own xml serialization.
An important note: do not create a parent element. Any element implementing XmlSerializable should only ever write what's considered its 'inner xml'.
The parent of the current element is responsible for writing a containing element.
This allows serializers to be re-used for different element names.
If you are opening new elements, you must also close them again.
Parameters
- $writer : Writer