Class: DbResultProvider

Source Location: /plugins/search/common/Search.php

Class Overview

ResultProvider
   |
   --DbResultProvider

Provides result from a DB

Author(s):

Variables

Methods

Child classes:

TableResultProvider: Provides result from a table

Inherited Variables

Class: ResultProvider

ResultProvider::$aliases
ResultProvider::$columns
ResultProvider::$hilight
ResultProvider::$id
ResultProvider::$maxNumber
ResultProvider::$plugin
ResultProvider::$recenter

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 189]
Provides result from a DB

Tags:

see:

ResultProvider

[ Top ]

Class Variables

$db =

[line 239]

Tags:

var:	connection
access:	protected

Type:

[ Top ]

$dbConnection =

[line 199]

Tags:

var:	Database connection string
access:	public

Type:

string

[ Top ]

$dbFile =

[line 204]

Tags:

var:	Database file path
access:	public

Type:

string

[ Top ]

$dbType =

[line 194]

Tags:

var:	Database type (pgsql, sqlite, ...)
access:	public

Type:

string

[ Top ]

$dsn =

[line 209]

Tags:

var:	DSN
access:	public

Type:

string

[ Top ]

$encodingContext =

[line 214]

Tags:

var:	context for the encoding
access:	public

Type:

string

[ Top ]

$sortColumn =

[line 224]

Tags:

var:	default sort column
access:	public

Type:

string

[ Top ]

$sortDirection =

[line 229]

Tags:

var:	default sort direction
access:	public

Type:

string

[ Top ]

$sortPriorities =

[line 234]

Tags:

var:	defines order for other sort columns
access:	public

Type:

array

[ Top ]

$sql =

[line 219]

Tags:

var:	SQL query
access:	public

Type:

string

[ Top ]

Class Methods

method getDsn [line 244]

string getDsn(
)

Tags:

access:

protected

[ Top ]

method getOrderBy [line 266]

string getOrderBy(
SearchRequest
$request)

Tags:

access:

protected

Parameters:

SearchRequest

$request

[ Top ]

method getResult [line 310]

void getResult(
SearchRequest
$request)

Tags:

access:	public
see:	ResultProvider::getResult()

Overrides ResultProvider::getResult() (Generates search results from a request)

[ Top ]

method getSql [line 298]

string getSql(
SearchRequest
$request)

Parameters:

SearchRequest

$request

[ Top ]

Documentation generated on Wed, 22 May 2013 13:31:24 +0200 by phpDocumentor 1.3.0RC3