Docs For Class Wicked

Description

Wicked_Sync:: defines an API for implementing synchronization backends for Wicked.

$Horde: wicked/lib/Sync.php,v 1.1.2.1 2009/01/06 15:28:43 jan Exp $

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.fsf.org/copyleft/gpl.html.

author: Duck <duck@obala.net>

Located in /lib/Sync.php (line 16)

Direct descendents

Class	Description
Wicked_Sync_wicked	Wicked_Driver:: defines an API for implementing storage backends for Wicked.

Variable Summary

array $_params

Method Summary

Wicked_Sync Wicked_Sync ([array $params = array()])

boolean editPage (string $pagename, string $text, [string $changelog = ''], [boolean $minorchange = false])

Wicked_Sync factory ([string $driver = 'wicked'], [array $params = array()])

mixed getMultiplePageInfo ([array $pages = array()])

array getPageHistory (string $pagename)

mixed getPageInfo (string $pageName)

mixed getPageSource ( $pageName, string $name)

array listPages ()

Variables

array $_params = array() (line 23)

Hash containing connection parameters.

Methods

Constructor Wicked_Sync (line 66)

Constructs a new Wicked driver object.

Wicked_Sync Wicked_Sync ([array $params = array()])

array $params: A hash containing connection parameters.

editPage (line 140)

Updates content of a wiki page. If the page does not exist it is created.

return: | PEAR_Error True on success, PEAR_Error on failure.

boolean editPage (string $pagename, string $text, [string $changelog = ''], [boolean $minorchange = false])

string $pagename: Page to edit
string $text: Page content
string $changelog: Description of the change
boolean $minorchange: True if this is a minor change

Redefined in descendants as:

Wicked_Sync_wicked::editPage() : Updates content of a wiki page. If the page does not exist it is created.

factory (line 39)

Attempts to return a concrete Wicked_Sync instance based on $driver.

return: The newly created concrete Wicked_Sync instance, or false on an error.

Wicked_Sync factory ([string $driver = 'wicked'], [array $params = array()])

string $driver: The type of the concrete Wicked_Sync subclass to return. The class name is based on the sync driver ($driver). The code is dynamically included.
array $params: A hash containing any additional configuration or connection parameters a subclass might need.

getMultiplePageInfo (line 112)

Return basic information of .multiple pages

return: Array of pages data on success; PEAR_Error on failure

mixed getMultiplePageInfo ([array $pages = array()])

array $pages: Page names to get info for

Redefined in descendants as:

Wicked_Sync_wicked::getMultiplePageInfo() : Return basic pages information.

getPageHistory (line 124)

Return page history.

return: An array of page parameters.

array getPageHistory (string $pagename)

string $pagename: Page name

Redefined in descendants as:

Wicked_Sync_wicked::getPageHistory() : Return page history.

getPageInfo (line 100)

Return basic page information.

return: Array of page data on success; PEAR_Error on failure

mixed getPageInfo (string $pageName)

string $pageName: Page name

Redefined in descendants as:

Wicked_Sync_wicked::getPageInfo() : Return basic page information.

getPageSource (line 88)

Get the wiki source of a page specified by its name.

return: Array of page data on success; PEAR_Error on failure

mixed getPageSource ( $pageName, string $name)

string $name: The name of the page to fetch
$pageName

Redefined in descendants as:

Wicked_Sync_wicked::getPageSource() : Get the wiki source of a page specified by its name.

listPages (line 76)

Returns a list of available pages.

return: An array of all available pages.

array listPages ()

Redefined in descendants as:

Wicked_Sync_wicked::listPages() : Returns a list of available pages.