- Description
-
Class trees
Index of elements
Todo List
Interfaces
Phpfox_Cache_Interface- Phpfox_Database_Interface
- Phpfox_Gateway_Interface
- Phpfox_Image_Interface
- Phpfox_Mail_Interface
- Classes
Database_Driver_Mssql- Database_Driver_Oracle
- Database_Driver_Postgres
- Database_Driver_Sqlite
- Phpfox
- Phpfox_Ajax
- Phpfox_Api
- Phpfox_Archive
- Phpfox_Archive_Export
- Phpfox_Archive_Extension_Tar
- Phpfox_Archive_Extension_Xml
- Phpfox_Archive_Extension_Zip
- Phpfox_Archive_Import
- Phpfox_Archive_Support
- Phpfox_Cache
Phpfox_Cache_Abstract- Phpfox_Cache_Storage_File
- Phpfox_Cache_Storage_Memcache
- Phpfox_Cdn
- Phpfox_Cdn_Abstract
- Phpfox_Cdn_Module_S3
- Phpfox_Component
- Phpfox_Cron
- Phpfox_Database
- Phpfox_Database_Dba
- Phpfox_Database_Driver_Mysql
- Phpfox_Database_Driver_Mysqli
- Phpfox_Database_Export
- Phpfox_Database_Support
- Phpfox_Date
- Phpfox_Debug
- Phpfox_Diff_Md5
- Phpfox_Editor
- Phpfox_Error
- Phpfox_File
- Phpfox_File_Minimize
- Phpfox_Ftp
- Phpfox_Gateway
- Phpfox_Gateway_Api_2checkout
- Phpfox_Gateway_Api_Paypal
- Phpfox_Hash
- Phpfox_Image
- Phpfox_Image_Abstract
- Phpfox_Image_Helper
- Phpfox_Image_Library_Gd
- Phpfox_Locale
- Phpfox_Mail
- Phpfox_Mail_Driver_Phpmailer_Mail
- Phpfox_Mail_Driver_Phpmailer_Smtp
- Phpfox_Module
- Phpfox_Pager
- Phpfox_Parse_Bbcode
- Phpfox_Parse_Css
- Phpfox_Parse_Format
- Phpfox_Parse_Input
- Phpfox_Parse_Output
- Phpfox_Parse_Wiki
- Phpfox_Plugin
- Phpfox_Process
- Phpfox_Request
- Phpfox_Search
- Phpfox_Search_Inline
- Phpfox_Server
- Phpfox_Service
- Phpfox_Session
- Phpfox_Session_Handler
- Phpfox_Session_Handler_Default
- Phpfox_Session_Handler_File
- Phpfox_Session_Handler_Memcache
- Phpfox_Session_Storage_Cookie
- Phpfox_Session_Storage_Session
- Phpfox_Setting
- Phpfox_Spam
- Phpfox_Spam_Hash
- Phpfox_Template
- Phpfox_Url
- Phpfox_Validator
- Phpfox_Xml_Builder
- Phpfox_Xml_Parser
Functions
d- e
- p
Files
2checkout.class.php- abstract.class.php
- abstract.class.php
- abstract.class.php
- ajax.class.php
- api.class.php
- archive.class.php
- bbcode.class.php
- builder.class.php
- cache.class.php
- cdn.class.php
- component.class.php
- cookie.class.php
- cron.class.php
- css.class.php
- database.class.php
- date.class.php
- dba.class.php
- debug.class.php
- default.class.php
- editor.class.php
- error.class.php
- export.class.php
- export.class.php
- file.class.php
- file.class.php
- file.class.php
- format.class.php
- ftp.class.php
- gateway.class.php
- gd.class.php
- handler.class.php
- hash.class.php
- hash.class.php
- helper.class.php
- image.class.php
- import.class.php
- inline.class.php
- input.class.php
- interface.class.php
- interface.class.php
- interface.class.php
- interface.class.php
- interface.class.php
- locale.class.php
- mail.class.php
- mail.class.php
- md5.class.php
- memcache.class.php
- memcache.class.php
- minimize.class.php
- module.class.php
- mssql.class.php
- mysql.class.php
- mysqli.class.php
- oracle.class.php
- output.class.php
- pager.class.php
- parser.class.php
- paypal.class.php
- phpfox.class.php
- plugin.class.php
- postgres.class.php
- process.class.php
- request.class.php
- s3.class.php
- search.class.php
- server.class.php
- service.class.php
- session.class.php
- session.class.php
- setting.class.php
- smtp.class.php
- spam.class.php
- sqlite.class.php
- support.class.php
- support.class.php
- tar.class.php
- template.class.php
- url.class.php
- validator.class.php
- wiki.class.php
- xml.class.php
- zip.class.php
Template-
- Classes
- Phpfox_Template_Cache
- Files
- cache.class.php
Phpfox_Search
Description
Search Class is used to perform searches on all sections on the site.
Located in /include/library/phpfox/search/search.class.php (line 17)
Variable Summary
Method Summary
Variables
array
$_aConditions
= array() (line 31)
SQL conditions.
array
$_aConds
= array() (line 54)
SQL conditions.
array
$_aHtml
= array() (line 24)
Holds HTML form.
array
$_aParams
= array() (line 110)
Search settings.
array
$_aSearch
= array() (line 89)
Search results.
bool
$_bCache
= false (line 96)
Define if we should cache the search results.
bool
$_bIsSearch
= false (line 75)
Check if a search has been performed.
bool
$_bLiveQuery
= false (line 117)
Perform a live search with no caching or storage.
int
$_iSearchPage
= 0 (line 61)
Current page the search is on.
int
$_iSearchTotal
= 0 (line 68)
Total search results.
object
$_oReq
= null (line 39)
Request object.
object
$_oUrl
= null (line 47)
URL object.
string
$_sSearchResults
(line 103)
Search results as a string.
string
$_sType
(line 82)
Type of search we are performing.
Methods
Constructor __construct (line 123)
Class constructor that loads request and url objects.
Phpfox_Search
__construct
()
cacheResults (line 390)
Cache a search into the database.
mixed
cacheResults
(string $sSearch, array $aIds, [array $aExtraParams = null])
- string $sSearch: Search value.
- array $aIds: ARRAY of value IDs.
- array $aExtraParams: Extra params you want to store in the database.
clear (line 359)
Clear the current search form.
void
clear
()
get (line 517)
Get a specific search value.
mixed
get
(string $sName)
- string $sName: Search name.
getConditions (line 321)
Get all SQL conditions.
array
getConditions
()
getCustom (line 590)
Get custom search results.
array
getCustom
()
getDisplay (line 301)
Get the display.
string
getDisplay
()
getPage (line 527)
Get the current page we are on.
int
getPage
()
getSearch (line 452)
Get the search we cached in the database.
mixed
getSearch
(int $iId, int $iPage, int $iPageSize)
- int $iId: Search ID#.
- int $iPage: Current page we are on.
- int $iPageSize: How many rows to display per page.
getSearchTotal (line 538)
Get the search total.
int
getSearchTotal
(int $iDef)
- int $iDef: Default search total.
getSort (line 271)
Get the current sorting order.
string
getSort
()
highlight (line 550)
Highlight a search string.
string
highlight
(string $sSearch, string $sStr)
- string $sSearch: Search value.
- string $sStr: String to find and highlight the search value.
isSearch (line 227)
Check if we submitted the search form.
bool
isSearch
()
isSearching (line 217)
Check to see if we are currently trying to perform a search.
bool
isSearching
()
live (line 190)
Define that this is a live search.
object Return
live
()
search (line 372)
Build a search ARRAY based on the SQL driver.
void
search
(string $sType, mixed $mFields, string $sSearch)
- string $sType: Type of search we are performing.
- mixed $mFields: SQL fields to check.
- string $sSearch: Search value.
set (line 135)
Build the search form.
object Return
set
(array $aParams)
- array $aParams: Search fields and settings.
setCondition (line 311)
Set an SQL condition.
void
setCondition
(string $sValue)
- string $sValue
setRequests (line 202)
Force to set search requests.
object Return
setRequests
()
setSort (line 261)
Set the sorting order of the search.
void
setSort
(string $sSort)
- string $sSort
shorten (line 568)
Shorten a search result.
string
shorten
(string $sSearch, string $sStr, int $iStart, int $iEnd)
- string $sSearch: Search value.
- string $sStr: Search string.
- int $iStart: Define when to look into the search.
- int $iEnd: Define when to end the search.
_getParam (line 617)
Get a search param.
string
_getParam
(string $sVar)
- string $sVar: Param name.
_getQueries (line 637)
Process the search routine.
void
_getQueries
()
_getVar (line 732)
Get a search value.
string
_getVar
(string $sName)
- string $sName: Search name.
_prepare (line 741)
Prepare and build the search form.
void
_prepare
()
_reset (line 626)
Reset a search.
void
_reset
()
Documentation generated on Tue, 28 Sep 2010 10:36:43 +0200 by phpDocumentor 1.4.0a2