ResourceType
extends Elements
in package
implements
HtmlOutput
{DAV:}resourcetype property.
This class represents the {DAV:}resourcetype property, as defined in:
https://tools.ietf.org/html/rfc4918#section-15.9
Tags
Interfaces, Classes and Traits
- HtmlOutput
- WebDAV properties that implement this interface are able to generate their own html output for the browser plugin.
Table of Contents
- $value : array<string|int, mixed>
- Value to serialize.
- __construct() : mixed
- Constructor.
- add() : mixed
- Adds a resourcetype value to this property.
- getValue() : array<string|int, mixed>
- Returns the values in clark-notation.
- is() : bool
- Checks if the principal contains a certain value.
- toHtml() : string
- Generate html representation for this value.
- xmlDeserialize() : mixed
- The deserialize method is called during xml parsing.
- xmlSerialize() : mixed
- The xmlSerialize metod is called during xml writing.
Properties
$value
Value to serialize.
protected
array<string|int, mixed>
$value
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed>|string|null $resourceTypes = null ]) : mixed
You can either pass null (for no resourcetype), a string (for a single resourcetype) or an array (for multiple).
The resourcetype must be specified in clark-notation
Parameters
- $resourceTypes : array<string|int, mixed>|string|null = null
Return values
mixed —add()
Adds a resourcetype value to this property.
public
add(string $type) : mixed
Parameters
- $type : string
Return values
mixed —getValue()
Returns the values in clark-notation.
public
getValue() : array<string|int, mixed>
For example array('{DAV:}collection')
Return values
array<string|int, mixed> —is()
Checks if the principal contains a certain value.
public
is(string $type) : bool
Parameters
- $type : 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.
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 metod 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 XmlSerializble 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