Path

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

eZ Components 2007.2beta1

Webdav: ezcWebdavFlaggedPropertyStorage

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

Class: ezcWebdavFlaggedPropertyStorage

Class to manage instances of ezcWebdavProperty with associated flags. [source]
The stored objects are associated with some user defined flags. Other then that the class does what ezcWebdavPropertyStorage does.

Parents

ezcWebdavBasicPropertyStorage
   |
   --ezcWebdavFlaggedPropertyStorage

Member Variables

protected array $flags = array()
Next ID for a element in the ordered property list, to generate valid IDs even when some contents has been removed.

Inherited Member Variables

From ezcWebdavBasicPropertyStorage:
protected  ezcWebdavBasicPropertyStorage::$properties
protected  ezcWebdavBasicPropertyStorage::$propertyOrder
protected  ezcWebdavBasicPropertyStorage::$propertyOrderNextId
protected  ezcWebdavBasicPropertyStorage::$propertyOrderPosition

Method Summary

public void attach( $property, [$flag = 0] )
Attaches a property to the storage.
public void detach( $name, [$namespace = 'DAV:'] )
Detaches a property from the storage.
public mixed getFlag( $name, [$namespace = 'DAV:'] )
Get flags for property.

Inherited Methods

From ezcWebdavBasicPropertyStorage :
public void ezcWebdavBasicPropertyStorage::attach()
Attaches a property to the storage.
public bool ezcWebdavBasicPropertyStorage::contains()
Returns if the given property exists in the storage.
public int ezcWebdavBasicPropertyStorage::count()
Return property count.
public mixed ezcWebdavBasicPropertyStorage::current()
Implements current() for Iterator
public void ezcWebdavBasicPropertyStorage::detach()
Detaches a property from the storage.
public ezcWebdavBasicPropertyStorage ezcWebdavBasicPropertyStorage::diff()
Diff two property storages.
public ezcWebdavProperty|null ezcWebdavBasicPropertyStorage::get()
Returns a given property.
public array(string=>array(string=>ezcWebdavProperty)) ezcWebdavBasicPropertyStorage::getAllProperties()
Returns all properties contained in the storage.
public array(string=>ezcWebdavProperty) ezcWebdavBasicPropertyStorage::getProperties()
Returns all properties of a given namespace.
public ezcWebdavBasicPropertyStorage ezcWebdavBasicPropertyStorage::intersect()
Intersection between two property storages.
public int ezcWebdavBasicPropertyStorage::key()
Implements key() for Iterator
public mixed ezcWebdavBasicPropertyStorage::next()
Implements next() for Iterator
public void ezcWebdavBasicPropertyStorage::rewind()
Implements rewind() for Iterator
public boolean ezcWebdavBasicPropertyStorage::valid()
Implements valid() for Iterator

Methods

attach

void attach( ezcWebdavProperty $property, [mixed $flag = 0] )
Attaches a property to the storage.
Adds the given $property to the storage. The property can later be accessed by its name in combination with the namespace. Live properties (and only these) reside in the namespace DAV:, which is the default for all accessor methods.
If a property with the same namespace and name is already contained in the storage, it will be overwritten.
You may optionally add some flag of mixed type to the property, which just be stored and may be requested later.

Parameters

Name Type Description
$property ezcWebdavProperty  
$flag mixed  

Redefinition of

Method Description
ezcWebdavBasicPropertyStorage::attach() Attaches a property to the storage.

detach

void detach( string $name, [string $namespace = 'DAV:'] )
Detaches a property from the storage.
Removes the property with the given $name from the storage. If the property did not exist in the storage, the call is silently ignored. If no $namespace is given, the default namespace DAV: is used.

Parameters

Name Type Description
$name string  
$namespace string  

Redefinition of

Method Description
ezcWebdavBasicPropertyStorage::detach() Detaches a property from the storage.

getFlag

mixed getFlag( string $name, [string $namespace = 'DAV:'] )
Get flags for property.
Get the flags of a proerpty from the flagged property storage by its name and optionally the naemspace of the property. If the namespace is not explicitely given it dafults to the default DAV namespace "DAV:".
Will return null, if no flag has been assigned, or the property does not exist.

Parameters

Name Type Description
$name string  
$namespace string  

Last updated: Wed, 28 Nov 2007