LocalHref
extends Href
in package
LocalHref property.
Like the Href property, this element represents {DAV:}href. The difference is that this is used strictly for paths on the server. The LocalHref property will prepare the path so it's a valid URI.
These two objects behave identically: new LocalHref($path) new Href(\Sabre\HTTP\encodePath($path))
LocalPath basically ensures that your spaces are %20, and everything that needs to be is uri encoded.
Tags
Table of Contents
- $hrefs : array<string|int, mixed>
- List of uris.
- __construct() : mixed
- Constructor.
- getHref() : string|null
- Returns the first Href.
- getHrefs() : array<string|int, mixed>
- Returns the hrefs as an array.
- 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
$hrefs
List of uris.
protected
array<string|int, mixed>
$hrefs
Methods
__construct()
Constructor.
public
__construct(string|array<string|int, string> $hrefs) : mixed
You must either pass a string for a single href, or an array of hrefs.
If auto-prefix is set to false, the hrefs will be treated as absolute and not relative to the servers base uri.
Parameters
- $hrefs : string|array<string|int, string>
Return values
mixed —getHref()
Returns the first Href.
public
getHref() : string|null
Return values
string|null —getHrefs()
Returns the hrefs as an array.
public
getHrefs() : 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.
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