phpDocumentor search
[ class tree: search ] [ index: search ] [ all elements ]

Class: search

Source Location: /lib/search.inc.php

Class search

Class Overview

Located in /lib/search.inc.php [line 11]

ipbwi
   |
   --search
Author(s):
  • Matthias Reuter ($LastChangedBy: matthias $)
Information Tags:
Version:  $LastChangedDate: 2008-10-31 23:53:28 +0000 (Fr, 31 Okt 2008) $
Copyright:  2007-2008 IPBWI development team
Link:  http://ipbwi.com
Since:  2.0
License:  GNU General Public License

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From ipbwi

ipbwi::$DB
ipbwi::$ips

Inherited From ipbwi

ipbwi::addSystemMessage()
adds a system message
ipbwi::date()
Returns textual/timestamp offsetted date by board and by member offset and DST setting.
ipbwi::getBoardVar()
gets the requested board-var
ipbwi::getLibLang()
gets the language-var from actual requested native language-bit
ipbwi::info()
informations about the current IPBWI and PHP installation
ipbwi::makeSafe()
filtering html-strings, e.g. for db-queries
ipbwi::printSystemMessages()
prints system messages
ipbwi::properXHTML()
filtering HTML strings
ipbwi::setLang()
Set's current SDK language
ipbwi::updateSession()
Update Member Session Informations

Inherited From ipbwi

ipbwi::DEV_TEAM
ipbwi::PROJECT_LEADER
ipbwi::TITLE
ipbwi::VERSION
ipbwi::WEBSITE

[ Top ]
Method Summary
array   results()   Returns the search results of a search.
string   simple()   Performs a simple search and returns a search id.

[ Top ]
Methods
results  [line 38]

  array results( int $searchID  )

Returns the search results of a search.

Parameters:
int   $searchID:  ID of the Search

API Tags:
Return:  Search Results or false on failure. BBCode is stripped off the results. To hilight the search string use str_replace() in your main script.
Access:  public

Information Tags:
Author:  Cow <khlo@global-centre.com>
Author:  Andrew Beveridge <andrewthecoder@googlemail.com>
Author:  Matthias Reuter
Author:  Pita <peter@randomnity.com>
Since:  2.0
Sample:  
  1.  $searchID $ipbwi->search->simple('search string');
  2.  $ipbwi->search->results($searchID);

[ Top ]
simple  [line 77]

  string simple( string $string, [string $forums = '*'], [bool $dateorder = false], [bool $recursive = false]  )

Performs a simple search and returns a search id.

Parameters:
string   $string:  Text to search for (SQL rules apply)
string   $forums:  Default: '*' (any), or comma-separated list of forum IDs
bool   $dateorder:  Default: false, true = Order by post_date
bool   $recursive:  Default: false, true = Get subforums, too

API Tags:
Return:  Search ID or false on failure
Access:  public

Information Tags:
Author:  Cow <khlo@global-centre.com>
Author:  Andrew Beveridge <andrewthecoder@googlemail.com>
Author:  Matthias Reuter
Author:  Pita <peter@randomnity.com>
Since:  2.0
Sample:  
  1.  $ipbwi->search->simple('search string');

[ Top ]

Documentation generated on Mon, 02 Mar 2009 23:51:10 +0100 by phpDocumentor 1.4.0