Class Wicked_Sync
Wicked_Sync defines an API for implementing synchronization backends for
Wicked.
Copyright 2008-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (GPL). If you
did not receive this file, see http://www.horde.org/licenses/gpl.
Methods summary
public
Wicked_Sync
|
#
factory( string $driver = 'Wicked', array $params = array() )
Attempts to return a concrete Wicked_Sync instance based on $driver.
Attempts to return a concrete Wicked_Sync instance based on $driver.
Parameters
- $driver
- <p>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.</p>
- $params
- <p>A hash containing any additional configuration
or connection parameters a subclass might need.</p>
Returns
Wicked_SyncThe newly created concrete Wicked_Sync
instance, or false on an error.
|
public
|
#
__construct( array $params = array() )
Constructs a new Wicked driver object.
Constructs a new Wicked driver object.
Parameters
- $params
- A hash containing connection parameters.
|
abstract public
array
|
#
listPages( )
Returns a list of available pages.
Returns a list of available pages.
Returns
array
An array of all available pages.
Throws
|
abstract public
array
|
#
getPageSource( string $pageName )
Get the wiki source of a page specified by its name.
Get the wiki source of a page specified by its name.
Parameters
- $pageName
- $name The name of the page to fetch
Returns
array
Page data.
Throws
|
abstract public
array
|
#
getPageInfo( string $pageName )
Return basic page information.
Return basic page information.
Parameters
Returns
array
Page data.
Throws
|
abstract public
array
|
#
getMultiplePageInfo( array $pages = array() )
Return basic information of .multiple pages
Return basic information of .multiple pages
Parameters
- $pages
- Page names to get info for
Returns
array
Pages data.
Throws
|
abstract public
array
|
#
getPageHistory( string $pagename )
Return page history.
Parameters
Returns
array
An array of page parameters.
Throws
|
abstract public
|
#
editPage( string $pagename, string $text, string $changelog = '' )
Updates content of a wiki page. If the page does not exist it is
created.
Updates content of a wiki page. If the page does not exist it is
created.
Parameters
- $pagename
- Page to edit
- $text
- Page content
- $changelog
- Description of the change
Throws
|