Acl
in package
implements
Element, HtmlOutput
This class represents the {DAV:}acl property.
The {DAV:}acl property is a full list of access control entries for a resource.
{DAV:}acl is used as a WebDAV property, but it is also used within the body of the ACL request.
See: http://tools.ietf.org/html/rfc3744#section-5.5
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
- $prefixBaseUrl : bool
- Whether or not the server base url is required to be prefixed when serializing the property.
- $privileges : array<string|int, mixed>
- List of privileges.
- __construct() : mixed
- Constructor.
- getPrivileges() : array<string|int, mixed>
- Returns the list of privileges for this property.
- 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.
- serializeAce() : mixed
- Serializes a single access control entry.
Properties
$prefixBaseUrl
Whether or not the server base url is required to be prefixed when serializing the property.
protected
bool
$prefixBaseUrl
$privileges
List of privileges.
protected
array<string|int, mixed>
$privileges
Methods
__construct()
Constructor.
public
__construct(array<string|int, mixed> $privileges[, bool $prefixBaseUrl = true ]) : mixed
This object requires a structure similar to the return value from Sabre\DAVACL\Plugin::getACL().
Each privilege is a an array with at least a 'privilege' property, and a 'principal' property. A privilege may have a 'protected' property as well.
The prefixBaseUrl should be set to false, if the supplied principal urls are already full urls. If this is kept to true, the servers base url will automatically be prefixed.
Parameters
- $privileges : array<string|int, mixed>
- $prefixBaseUrl : bool = true
Return values
mixed —getPrivileges()
Returns the list of privileges for this property.
public
getPrivileges() : array<string|int, mixed>
Return values
array<string|int, mixed> —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.
Important note 2: 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
Return values
mixed —serializeAce()
Serializes a single access control entry.
private
serializeAce(Writer $writer, array<string|int, mixed> $ace) : mixed
Parameters
- $writer : Writer
- $ace : array<string|int, mixed>