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

Class: ClientSearch

Source Location: /plugins/search/client/ClientSearch.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientSearch

Client search plugin


Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: ClientPlugin

ClientPlugin::__construct()
Constructor
ClientPlugin::checkBool()
Checks if variable $variable has a boolean (0 or 1) value $value.
ClientPlugin::checkInt()
Checks if variable $variable has an integer positive or zero value $value.
ClientPlugin::checkNumeric()
Checks if variable $variable has a numeric value $value.
ClientPlugin::disable()
Sets the enable level to ClientPlugin::ENABLE_LEVEL_SERVERCALL.
ClientPlugin::enable()
Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL.
ClientPlugin::getCartoclient()
ClientPlugin::getConfig()
ClientPlugin::getEnabledLevel()
Returns the enable level.
ClientPlugin::getFolderId()
get folder id if set in plugin config
ClientPlugin::getHttpValue()
Returns the user-submitted $key data if it is set.
ClientPlugin::initializeConfig()
Initializes plugin configuration
ClientPlugin::isEnabledAtLevel()
Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL.
ClientPlugin::setEnableLevel()
Sets the enable level (to be used with the AJAX mode).

Class: PluginBase

PluginBase::__construct()
Constructor
PluginBase::account()
Records an accounting message for plugins
PluginBase::getBasePath()
PluginBase::getExtendedName()
PluginBase::getName()
PluginBase::getRequest()
Get plugin's request or result out of MapRequest or MapResult
PluginBase::initialize()
Plugin initialization (can be extended in custom plugins)
PluginBase::initializeConfig()
Initializes plugin
PluginBase::preInitialize()
Plugin pre initialization. In most cases, plugins should use
PluginBase::replacePlugin()
Returns name of parent plugin in case of plugin extension
PluginBase::setBasePath()
PluginBase::setExtendedName()
PluginBase::setName()

Class Details

[line 128]
Client search plugin



[ Top ]


Class Variables

$configs =

[line 137]



Tags:

var:  Search configurations
access:  protected

Type:   SearchConfig[]


[ Top ]

$searchRequest =

[line 142]



Tags:

var:  the request
access:  protected

Type:   SearchRequest


[ Top ]

$searchResult =

[line 147]



Tags:

var:  the result
access:  protected

Type:   SearchResult


[ Top ]



Class Methods


method ajaxGetPluginResponse [line 314]

void ajaxGetPluginResponse( AjaxPluginResponse $ajaxPluginResponse)



Tags:

access:  public
see:  Ajaxable::ajaxGetPluginResponse()


[ Top ]

method ajaxHandleAction [line 338]

void ajaxHandleAction( mixed $actionName, PluginEnabler $pluginEnabler)



Tags:

access:  public
see:  Ajaxable::ajaxHandleAction()


[ Top ]

method buildRequest [line 281]

void buildRequest( )



Tags:

access:  public
see:  ServerCaller::buildRequest()


[ Top ]

method buildSearchRequest [line 195]

SearchRequest buildSearchRequest( array $request)

Converts HTTP request to Search request



Tags:

access:  public


Parameters:

array   $request   HTTP request

[ Top ]

method filterGetRequest [line 254]

void filterGetRequest( FilterRequestModifier $request)



Tags:

access:  public
see:  GuiProvider::filterGetRequest()


[ Top ]

method filterPostRequest [line 216]

void filterPostRequest( FilterRequestModifier $request)



Tags:

access:  public
see:  GuiProvider::filterPostRequest()


[ Top ]

method handleHttpGetRequest [line 265]

void handleHttpGetRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpGetRequest()


[ Top ]

method handleHttpPostRequest [line 260]

void handleHttpPostRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpPostRequest()


[ Top ]

method handleResult [line 309]

void handleResult( mixed $outlineResult)



Tags:

access:  public
see:  ServerCaller::handleResult()


[ Top ]

method initialize [line 152]

void initialize( )



Tags:

access:  public
see:  PluginBase::initialize()


Overrides PluginBase::initialize() (Plugin initialization (can be extended in custom plugins))

[ Top ]

method initializeResult [line 295]

void initializeResult( mixed $result)



Tags:

access:  public
see:  ServerCaller::initializeResult()


[ Top ]

method renderForm [line 270]

void renderForm( Smarty $template)



Tags:

access:  public
see:  GuiProvider::renderForm()


[ Top ]


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