Plugins

# Class: DbResultProvider Source Location: /plugins/search/common/Search.php
### Class Overview
    ResultProvider
       |
       --DbResultProvider
Provides result from a DB #### Author(s): | ### Variables $db $dbConnection $dbFile $dbType $dsn $encodingContext $sortColumn $sortDirection $sortPriorities $sql | ### Methods getDsn getOrderBy getResult getSql
### Child classes: TableResultProvider Provides result from a table | ### Inherited Variables #### Class: ResultProvider ResultProvider::$aliases ResultProvider::$columns ResultProvider::$id ResultProvider::$maxNumber ResultProvider::$plugin | ### Inherited Methods #### Class: ResultProvider ResultProvider::__construct() ResultProvider::getColumnName() Gets DB column name, uses alias if needed ResultProvider::getProviderFromConfig() Creates a ResultProvider from a config structure ResultProvider::getResult() Generates search results from a request
### Class Details [line 178] Provides result from a DB #### Tags:
see: | ResultProvider
[ Top ] ### Class Variables #### $db = [line 228] #### Tags:
var: | connection
access: | protected
Type: | DB
[ Top ] #### $dbConnection = [line 188] #### Tags:
var: | Database connection string
access: | public
Type: | string
[ Top ] #### $dbFile = [line 193] #### Tags:
var: | Database file path
access: | public
Type: | string
[ Top ] #### $dbType = [line 183] #### Tags:
var: | Database type (pgsql, sqlite, ...)
access: | public
Type: | string
[ Top ] #### $dsn = [line 198] #### Tags:
var: | DSN
access: | public
Type: | string
[ Top ] #### $encodingContext = [line 203] #### Tags:
var: | context for the encoding
access: | public
Type: | string
[ Top ] #### $sortColumn = [line 213] #### Tags:
var: | default sort column
access: | public
Type: | string
[ Top ] #### $sortDirection = [line 218] #### Tags:
var: | default sort direction
access: | public
Type: | string
[ Top ] #### $sortPriorities = [line 223] #### Tags:
var: | defines order for other sort columns
access: | public
Type: | array
[ Top ] #### $sql = [line 208] #### Tags:
var: | SQL query
access: | public
Type: | string
[ Top ] ### Class Methods ### method getDsn [line 233]
`string getDsn( )`
#### Tags:
access: | protected
[ Top ] ### method getOrderBy [line 255]
`string getOrderBy( SearchRequest $request)`
#### Tags:
access: | protected
#### Parameters:
SearchRequest | $request |
[ Top ] ### method getResult [line 299]
`void getResult( SearchRequest $request)`
#### Tags:
access: | public
see: | ResultProvider::getResult()
Overrides ResultProvider::getResult() (Generates search results from a request) [ Top ] ### method getSql [line 287]
`string getSql( SearchRequest $request)`
#### Tags:
access: | protected
Overridden in child classes as: TableResultProvider::getSql() #### Parameters:
SearchRequest | $request |
[ Top ] Documentation generated on Fri, 21 Sep 2007 13:31:00 +0200 by phpDocumentor 1.3.0RC3