Path

ez components / documentation / api reference / 2007.2alpha1 / webdav


eZ Components 2007.2alpha1

Webdav: ezcWebdavPathFactory

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Interface: ezcWebdavPathFactory

Basic path factory interface. [source]
An object that implements this interface is meant to be used in ezcWebdavTransportOptions as the $pathFactory property. The instance of ezcWebdavTransport utilizes the path factory to translate between external pathes/URIs and internal path representations.
You may want to provide custome implementations for different mappings.

Method Summary

public string generateUriFromPath( $path )
Generates a URI from a local path.
public string parseUriToPath( $uri )
Parses the given URI to a locally understandable path.

Methods

generateUriFromPath

string generateUriFromPath( string $path )
Generates a URI from a local path.
This method receives a local $path string, representing a node in the local WebDAV store and translates it into a full qualified URI to be used as external reference.

Parameters

Name Type Description
$path string  

parseUriToPath

string parseUriToPath( string $uri )
Parses the given URI to a locally understandable path.
This method retrieves a URI (either full qualified or relative) and translates it into a local path, which can be understood by the WebDAV elements.
A locally understandable path MUST NOT contain a trailing slash, but MUST always contain a starting slash. For the root URI the path "/" MUST be used.

Parameters

Name Type Description
$uri string  

Last updated: Mon, 12 Nov 2007