Overview

Packages

  • None
  • Wicked

Classes

  • Text_Wiki_Parse_Heading2
  • Text_Wiki_Parse_Toc2
  • Text_Wiki_Render_Latex_Heading2
  • Text_Wiki_Render_Latex_Toc2
  • Text_Wiki_Render_Plain_Heading2
  • Text_Wiki_Render_Plain_Toc2
  • Text_Wiki_Render_Rst
  • Text_Wiki_Render_Rst_Blockquote
  • Text_Wiki_Render_Rst_Bold
  • Text_Wiki_Render_Rst_Code
  • Text_Wiki_Render_Rst_Deflist
  • Text_Wiki_Render_Rst_Emphasis
  • Text_Wiki_Render_Rst_Freelink
  • Text_Wiki_Render_Rst_Heading2
  • Text_Wiki_Render_Rst_Links
  • Text_Wiki_Render_Rst_List
  • Text_Wiki_Render_Rst_Newline
  • Text_Wiki_Render_Rst_Paragraph
  • Text_Wiki_Render_Rst_Raw
  • Text_Wiki_Render_Rst_Toc2
  • Text_Wiki_Render_Rst_Tt
  • Text_Wiki_Render_Rst_Url
  • Text_Wiki_Render_Xhtml_Attribute
  • Text_Wiki_Render_Xhtml_Code2
  • Text_Wiki_Render_Xhtml_Freelink2
  • Text_Wiki_Render_Xhtml_Heading2
  • Text_Wiki_Render_Xhtml_Image2
  • Text_Wiki_Render_Xhtml_Interwiki
  • Text_Wiki_Render_Xhtml_Registrylink
  • Text_Wiki_Render_Xhtml_Toc2
  • Text_Wiki_Render_Xhtml_Url
  • Text_Wiki_Render_Xhtml_Wickedblock
  • Text_Wiki_Render_Xhtml_Wikilink2
  • Wicked
  • Wicked_Api
  • Wicked_Driver
  • Wicked_Driver_Sql
  • Wicked_Exception
  • Wicked_Factory_Driver
  • Wicked_Page
  • Wicked_Page_AddPage
  • Wicked_Page_AllPages
  • Wicked_Page_AttachedFiles
  • Wicked_Page_BackLinks
  • Wicked_Page_DeletePage
  • Wicked_Page_EditPage
  • Wicked_Page_LeastPopular
  • Wicked_Page_LikePages
  • Wicked_Page_MergeOrRename
  • Wicked_Page_MostPopular
  • Wicked_Page_NewPage
  • Wicked_Page_RecentChanges
  • Wicked_Page_RevertPage
  • Wicked_Page_Search
  • Wicked_Page_StandardHistoryPage
  • Wicked_Page_StandardPage
  • Wicked_Page_SyncDiff
  • Wicked_Page_SyncPages
  • Wicked_Sync
  • Wicked_Sync_Wicked
  • Wicked_Test
  • Overview
  • Package
  • Class
  • Tree

Class Wicked_Driver_Sql

Wicked storage implementation for the Horde_Db database abstraction layer.

Wicked_Driver
Extended by Wicked_Driver_Sql
Package: Wicked
Author: Tyler Colbert tyler@colberts.us
Author: Chuck Hagenbuch chuck@horde.org
Author: Jan Schneider jan@horde.org
Located at Driver/Sql.php
Methods summary
public
# __construct( array $params = array() )

Constructor.

Constructor.

Parameters

$params
A hash containing connection parameters.

Overrides

Wicked_Driver::__construct()
public array
# retrieveByName( string $pagename )

Retrieves the page of a particular name from the database.

Retrieves the page of a particular name from the database.

Parameters

$pagename
The name of the page to retrieve.

Returns

array

Throws

Wicked_Exception
public array
# retrieveHistory( string $pagename, string $version )

Retrieves a historic version of a page.

Retrieves a historic version of a page.

Parameters

$pagename
The name of the page to retrieve.
$version
The version to retrieve.

Returns

array
The page hash.

Throws

Wicked_Exception
public
# getPageById( mixed $id )

Overrides

Wicked_Driver::getPageById()
public
# getAllPages( )
public
# getHistory( mixed $pagename )
public array
# getRecentChanges( integer $days = 3 )

Returns the most recently changed pages.

Returns the most recently changed pages.

Parameters

$days
The number of days to look back.

Returns

array
Pages.

Throws

Wicked_Exception
public array
# mostPopular( integer $limit = 10 )

Returns the most popular pages.

Returns the most popular pages.

Parameters

$limit
The number of most popular pages to return.

Returns

array
Pages.

Throws

Wicked_Exception
public array
# leastPopular( integer $limit = 10 )

Returns the least popular pages.

Returns the least popular pages.

Parameters

$limit
The number of least popular pages to return.

Returns

array
Pages.

Throws

Wicked_Exception
public
# searchTitles( mixed $searchtext )
public array
# searchText( string $searchtext, boolean $title = true )

Finds pages with matches in text or title.

Finds pages with matches in text or title.

Parameters

$searchtext
The search expression (Google-like).
$title
Search both page title and text?

Returns

array
A list of pages.

Throws

Wicked_Exception
public
# getBackLinks( mixed $pagename )
public
# getMatchingPages( mixed $searchtext, mixed $matchType = Wicked_Page::MATCH_ANY )
public
# getLikePages( mixed $pagename )
public array
# getAttachedFiles( string $pageId, boolean $allversions = false )

Retrieves data on files attached to a page.

Retrieves data on files attached to a page.

Parameters

$pageId
<p>This is the Id of the page for which we'd like to find attached files.</p>
$allversions
<p>Whether to include all versions. If false or omitted, only the most recent version of each attachment is returned.</p>

Returns

array

An array of key/value arrays describing the attached files.

Throws

Wicked_Exception
public
# removeAttachment( integer $pageId, string $attachment, string $version = null )

Removes a single version or all versions of an attachment from $pageId.

Removes a single version or all versions of an attachment from $pageId.

Parameters

$pageId
The Id of the page the file is attached to.
$attachment
The name of the file.
$version
<p>If specified, the version to delete. If null, then all versions of $attachment will be removed.</p>

Throws

Wicked_Exception

Overrides

Wicked_Driver::removeAttachment()
public
# removeAllAttachments( integer $pageId )

Removes all attachments from a page.

Removes all attachments from a page.

Parameters

$pageId
A page ID.

Throws

Wicked_Exception

Overrides

Wicked_Driver::removeAllAttachments()
public
# logPageView( string $pagename )

Logs a page view.

Logs a page view.

Parameters

$pagename
The page that was viewed.

Throws

Wicked_Exception
public
# logAttachmentDownload( integer $pageid, string $attachment )

Logs an attachment download.

Logs an attachment download.

Parameters

$pageid
The page with the attachment.
$attachment
The attachment name.

Throws

Wicked_Exception
public
# newPage( string $pagename, string $text )

Creates a new page.

Creates a new page.

Parameters

$pagename
The new page's name.
$text
The new page's text.

Throws

Wicked_Exception
public
# renamePage( string $pagename, string $newname )

Renames a page, keeping the page's history.

Renames a page, keeping the page's history.

Parameters

$pagename
The name of the page to rename.
$newname
The page's new name.

Throws

Wicked_Exception
public
# updateText( mixed $pagename, mixed $text, mixed $changelog )
public
# getPages( mixed $special = true, mixed $no_cache = false )

Overrides

Wicked_Driver::getPages()
public
# removeVersion( mixed $pagename, mixed $version )
public
# removeAllVersions( mixed $pagename )

Overrides

Wicked_Driver::removeAllVersions()
public string
# getCharset( )

Returns the charset used by the backend.

Returns the charset used by the backend.

Returns

string
The backend's charset

Overrides

Wicked_Driver::getCharset()
Methods inherited from Wicked_Driver
attachFile(), getAttachmentContents(), getPage(), getPageId(), getSpecialPages(), getVFS(), pageExists()
API documentation generated by ApiGen