Class Search

Description

Wicked SearchAll class.

$Horde: wicked/lib/Page/Search.php,v 1.6.2.1 2009/01/06 15:28:45 jan Exp $

Copyright 2003-2009 The Horde Project (http://www.horde.org/)

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

Located in /lib/Page/Search.php (line 19)

Page
   |
   --Search
Variable Summary
Method Summary
 string content ([string $searchtext = ''])
 mixed display (string $searchtext)
 void getContext ( $page,  $searchtext)
 void pageName ()
 void pageTitle ()
 void preDisplay ( $mode,  $params)
Variables
array $supportedModes = array(
WICKED_MODE_CONTENT => true,
WICKED_MODE_DISPLAY => true)
(line 25)

Display modes supported by this page.


Redefinition of:
Page::$supportedModes
Display modes supported by this page. Possible modes:
array $_results (line 33)

Cached search results.

Inherited Variables

Inherited from Page

Page::$_page
Page::$_proc
Methods
content (line 42)

Render this page in Content mode.

  • return: The page content, or PEAR_Error.
string content ([string $searchtext = ''])
  • string $searchtext: The title to search for.
display (line 76)

Render this page in Display mode.

  • return: Returns true or PEAR_Error.
mixed display (string $searchtext)
  • string $searchtext: The title to search for.

Redefinition of:
Page::display()
Render this page in Display mode. You really must override this function if your page is to be anything like a real page.
getContext (line 189)
void getContext ( $page,  $searchtext)
  • $page
  • $searchtext
pageName (line 197)
void pageName ()

Redefinition of:
Page::pageName()
pageTitle (line 202)
void pageTitle ()

Redefinition of:
Page::pageTitle()
preDisplay (line 64)

Perform any pre-display checks for permissions, searches,

etc. Called before any output is sent so the page can do redirects. If the page wants to take control of flow from here, it can, and is entirely responsible for handling the user (should call exit after redirecting, for example).

$param integer $mode The page render mode. $param array $params Any page parameters.

void preDisplay ( $mode,  $params)
  • $mode
  • $params

Redefinition of:
Page::preDisplay()
Perform any pre-display checks for permissions, searches,

Inherited Methods

Inherited From Page

 Page::allows()
 Page::author()
 Page::block()
 Page::diff()
 Page::display()
 Page::displayContents()
 Page::formatVersionCreated()
 Page::getCurrentPage()
 Page::getPage()
 Page::getPermissions()
 Page::getProcessor()
 Page::getText()
 Page::handleAction()
 Page::history()
 Page::hits()
 Page::isLocked()
 Page::isOld()
 Page::isValid()
 Page::lock()
 Page::pageName()
 Page::pageTitle()
 Page::pageUrl()
 Page::preDisplay()
 Page::previousVersion()
 Page::referrer()
 Page::remove()
 Page::render()
 Page::supports()
 Page::unlock()
 Page::updateText()
 Page::version()
 Page::versionCreated()

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