Zeta Components - high quality PHP components

Zeta Components Manual :: Docs For Class ezcWebdavPluginConfiguration

Webdav::ezcWebdavPluginConfiguration

Class ezcWebdavPluginConfiguration

Base class for plugin configurations.

A plugin must ship at least one class that extends this base class and will be used by ezcWebdavPluginRegistry to configure the plugin on load.

To activate (load) a plugin, the user must instantiate the plugin specific defived configuration class and submit the instance to ezcWebdavPluginRegistry::registerPlugin().

Source for this file: /Webdav/src/plugin_configuration.php

Version:   //autogen//

Descendants

Child Class Description
ezcWebdavLockPluginConfiguration Plugin configuration class for the LOCK plugin.

Method Summary

public abstract array getHooks( )
Returns the hooks this plugin wants to assign to.
public abstract string getNamespace( )
Returns the namespace of this plugin.
public void init( )
Initialize the plugin.

Methods

getHooks

array getHooks( )

Returns the hooks this plugin wants to assign to.

This method is called by ezcWebdavPluginRegistry, as soon as the plugin is registered to be used. The method must return a structured array, representing the hooks the plugin want to be notified about.

The returned array must be of the following structure:

  1.   array(
  2.       '<className>' => array(
  3.           '<hookName>' => array(
  4.               <callback1>,
  5.               <callback2>,
  6.           ),
  7.           '<anotherHookName>' => array(
  8.               <callback3>,
  9.           ),
  10.       ),
  11.       '<secondClassName>' => array(
  12.           '<thirdHookName>' => array(
  13.               <callback1>,
  14.               <callback3>,
  15.           ),
  16.       ),
  17.   )
Redefined in descendants as:
Method Description
ezcWebdavLockPluginConfiguration::getHooks() Returns the hooks this plugin wants to assign to. 

getNamespace

string getNamespace( )

Returns the namespace of this plugin.

The namespace of a plugin is a unique identifier string that allows it to be recognized bejond other plugins. The namespace is used to provide storage for the plugin in the

Redefined in descendants as:
Method Description
ezcWebdavLockPluginConfiguration::getNamespace() Returns the namespace of this plugin. 

init

void init( )

Initialize the plugin.

This method is called after the server has be initialized to make the plugin setup necessary objects and to retreive necessary information from the server.

Redefined in descendants as:
Method Description
ezcWebdavLockPluginConfiguration::init() Initialize the plugin. 
Documentation generated by phpDocumentor 1.4.3