Class Wicked_Sync_wicked

Description
Description | Vars (details) | Methods (details)

Wicked_Driver:: defines an API for implementing storage backends for Wicked.

Located in /lib/Sync/wicked.php (line 23) 

Wicked_Sync
   |
   --Wicked_Sync_wicked
Variable Summary
Description | Vars (details) | Methods (details)
mixed $_client
Method Summary
Description | Vars (details) | Methods (details)
boolean editPage (string $pagename, string $text, [string $changelog = ''], [boolean $minorchange = false])
mixed getMultiplePageInfo ([array $pages = array()])
array getPageHistory (string $pagename)
mixed getPageInfo (string $pageName)
mixed getPageSource ( $pageName, string $name)
array listPages ()
mixed _getData (string $method, [array $params = array()])
Variables
Description | Vars (details) | Methods (details)
mixed $_client (line 30)

Returns a list of available pages.

  • return: An array of all available pages.

Inherited Variables

Inherited from Wicked_Sync

Wicked_Sync::$_params
Methods
Description | Vars (details) Methods (details)
editPage (line 101)

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
Redefinition of:
Wicked_Sync::editPage()
Updates content of a wiki page. If the page does not exist it is created.
getMultiplePageInfo (line 73)

Return basic pages information.

  • return: Array of pages data on success; PEAR_Error on failure
mixed getMultiplePageInfo ([array $pages = array()])
  • array $pages: Page names to get info for
Redefinition of:
Wicked_Sync::getMultiplePageInfo()
Return basic information of .multiple pages
getPageHistory (line 85)

Return page history.

  • return: An array of page parameters.
array getPageHistory (string $pagename)
  • string $pagename: Page name
Redefinition of:
Wicked_Sync::getPageHistory()
Return page history.
getPageInfo (line 61)

Return basic page information.

  • return: Array of page data on success; PEAR_Error on failure
mixed getPageInfo (string $pageName)
  • string $pageName: Page name
Redefinition of:
Wicked_Sync::getPageInfo()
Return basic page information.
getPageSource (line 49)

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

  • return: String of page data on success; PEAR_Error on fail
mixed getPageSource ( $pageName, string $name)
  • string $name: The name of the page to fetch
  • $pageName
Redefinition of:
Wicked_Sync::getPageSource()
Get the wiki source of a page specified by its name.
listPages (line 37)

Returns a list of available pages.

  • return: An array of all available pages.
array listPages ()
Redefinition of:
Wicked_Sync::listPages()
Returns a list of available pages.
_getData (line 114)

Process remote call

  • return: Array of pages data on success; PEAR_Error on failure
mixed _getData (string $method, [array $params = array()])
  • string $method: Method name to call
  • array $params: Array of parameters

Inherited Methods

Inherited From Wicked_Sync

Wicked_Sync::Wicked_Sync()
Wicked_Sync::editPage()
Wicked_Sync::factory()
Wicked_Sync::getMultiplePageInfo()
Wicked_Sync::getPageHistory()
Wicked_Sync::getPageInfo()
Wicked_Sync::getPageSource()
Wicked_Sync::listPages()

Documentation generated on Sun, 30 Jan 2011 05:42:58 +0000 by phpDocumentor 1.4.3