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

Class: ipbwi_search

Source Location: /ipbwi/lib/search.inc.php

Class Overview

ipbwi
   |
   --ipbwi_search



Author(s):

  • Matthias Reuter ($LastChangedBy: matthias $)

Version:

  • $LastChangedDate: 2008-10-31 23:53:28 +0000 (Fr, 31 Okt 2008) $

Copyright:

  • 2007-2010 IPBWI development team

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: 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::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::sysInfo()
informations about the current IPBWI and PHP installation
ipbwi::__destruct()

Class Details

[line 11]


Tags:

author:  Matthias Reuter ($LastChangedBy: matthias $)
version:  $LastChangedDate: 2008-10-31 23:53:28 +0000 (Fr, 31 Okt 2008) $
copyright:  2007-2010 IPBWI development team
link:  http://ipbwi.com
since:  2.0
license:  GNU General Public License


[ Top ]


Class Methods


method results [line 35]

array results( int $searchID)

Returns the search results of a search.



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.
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $searchID $ipbwi->search->simple('search string');
  2.  $ipbwi->search->results($searchID);
access:  public


Parameters:

int   $searchID   ID of the Search

[ Top ]

method simple [line 71]

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

Performs a simple search and returns a search id.



Tags:

return:  Search ID or false on failure
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->search->simple('search string');
access:  public


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

[ Top ]


Documentation generated on Sat, 23 Oct 2010 23:36:11 +0200 by phpDocumentor 1.4.3