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

Class: ResultProvider

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

Class Overview


Provides results Allows to use several sources (i.e. DB, shapefiles, etc.) for one application.


Author(s):

Variables

Methods


Child classes:

DbResultProvider
Provides result from a DB

Class Details

[line 86]
Provides results Allows to use several sources (i.e. DB, shapefiles, etc.) for one application.



Tags:

abstract:  


[ Top ]


Class Variables

$aliases =

[line 111]



Tags:

var:  column aliases
access:  public

Type:   string[]


[ Top ]

$columns =

[line 106]



Tags:

var:  column names
access:  public

Type:   string[]


[ Top ]

$hilight =

[line 121]



Tags:

var:  layer to hilight
access:  public

Type:   string


[ Top ]

$id =

[line 101]



Tags:

var:  ID column
access:  public

Type:   string


[ Top ]

$maxNumber =

[line 96]



Tags:

var:  maximum number of results
access:  public

Type:   int


[ Top ]

$plugin =

[line 91]



Tags:

var:  plugin
access:  protected

Type:   PluginBase


[ Top ]

$recenter =

[line 116]



Tags:

var:  layer to recenter on
access:  public

Type:   string


[ Top ]



Class Methods


constructor __construct [line 126]

ResultProvider __construct( PluginBase $plugin)



Tags:

access:  public


Parameters:

PluginBase   $plugin   plugin

[ Top ]

method getColumnName [line 176]

string getColumnName( string $column)

Gets DB column name, uses alias if needed



Tags:

return:  DB column name
access:  public


Parameters:

string   $column   column name or alias

[ Top ]

method getProviderFromConfig [line 143]

ResultProvider getProviderFromConfig( config $config, mixed $defaultValues, mixed $plugin)

Creates a ResultProvider from a config structure



Tags:

access:  public
static:  


Parameters:

config   $config   structure

[ Top ]

method getResult [line 136]

SearchResult getResult( SearchRequest $request)

Generates search results from a request



Tags:

access:  public
abstract:  


Overridden in child classes as:

DbResultProvider::getResult()

Parameters:

SearchRequest   $request  

[ Top ]


Documentation generated on Thu, 04 Sep 2008 11:39:47 +0200 by phpDocumentor 1.3.0RC3