CorePlugins

# Class: ClientTables Source Location: /coreplugins/tables/client/ClientTables.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ClientTables
Client part of Tables plugin | ### Variables $log $tableGroups $tableRulesRegistry | ### Methods __construct addTableGroups ajaxGetPluginResponse ajaxHandleAction assignExportCsv getTable getTableGroups getTableRulesRegistry getUrl handleHttpGetRequest handleHttpPostRequest renderForm renderFormPrepare translate
### Inherited Constants #### Class: ClientPlugin ClientPlugin::ENABLE_LEVEL_FULL ClientPlugin::ENABLE_LEVEL_LOAD ClientPlugin::ENABLE_LEVEL_PROCESS ClientPlugin::ENABLE_LEVEL_SERVERCALL | ### Inherited Variables #### Class: ClientPlugin ClientPlugin::$cartoclient ClientPlugin::$config ClientPlugin::$enabledLevel #### Class: PluginBase PluginBase::$basePath PluginBase::$name PluginBase::$overriddenRequest | ### 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::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 37] Client part of Tables plugin Provides table rules registry to client plugins and manages display of tables. [ Top ] ### Class Variables #### $log = [line 43] #### Tags:
access: | private
Type: | Logger
Overrides: | Array
[ Top ] #### $tableGroups = array() [line 55] Tables to be displayed #### Tags:
var: | array of Table
access: | protected
Type: | array
[ Top ] #### $tableRulesRegistry = null [line 49] Registry which contains all client side rules #### Tags:
access: | protected
Type: | TableRulesRegistry
[ Top ] ### Class Methods ### constructor __construct [line 60]
`ClientTables __construct( )`
Constructor #### Tags:
access: | public
Overrides ClientPlugin::__construct() (Constructor) [ Top ] ### method addTableGroups [line 80]
`void addTableGroups( mixed $tables)`
Adds table(s) to the list of tables to be displayed #### Tags:
access: | public
#### Parameters:
mixed | $tables | TableGroup or array of TableGroup's
[ Top ] ### method ajaxGetPluginResponse [line 218]
`void ajaxGetPluginResponse( AjaxPluginResponse $ajaxPluginResponse)`
#### Tags:
access: | public
see: | Ajaxable::ajaxGetPluginResponse() FIXME: when all the values in the $assignArray are to be assigned, 1354
[ Top ] ### method ajaxHandleAction [line 225]
`void ajaxHandleAction( mixed $actionName, PluginEnabler $pluginsDirectives)`
#### Tags:
access: | public
see: | Ajaxable::ajaxHandleAction()
[ Top ] ### method assignExportCsv [line 144]
`void assignExportCsv( Smarty $template)`
Sets URL to CSV export. #### Tags:
access: | protected
#### Parameters:
Smarty | $template |
[ Top ] ### method getTable [line 99]
`Table getTable( string $groupId, string $tableId)`
Returns a table #### Tags:
access: | public
#### Parameters:
string | $groupId |
string | $tableId |
[ Top ] ### method getTableGroups [line 116]
`Table getTableGroups( )`
Returns all table groups #### Tags:
access: | public
[ Top ] ### method getTableRulesRegistry [line 69]
`TableRulesRegistry getTableRulesRegistry( )`
Returns current table rules registry #### Tags:
access: | public
[ Top ] ### method getUrl [line 134]
`string getUrl( )`
Gets CSV export URL from main exportCsv plugin. #### Tags:
access: | protected
[ Top ] ### method handleHttpGetRequest [line 128]
`void handleHttpGetRequest( mixed $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpGetRequest()
[ Top ] ### method handleHttpPostRequest [line 123]
`void handleHttpPostRequest( mixed $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpPostRequest()
[ Top ] ### method renderForm [line 206]
`void renderForm( Smarty $template)`
#### Tags:
access: | public
see: | GuiProvider::renderForm() FIXME: when all the values in the $assignArray are to be assigned, 1354
[ Top ] ### method renderFormPrepare [line 190]
`array renderFormPrepare( )`
This method factors the plugin output for both GuiProvider::renderForm() and Ajaxable::ajaxGetPluginResponse(). #### Tags:
return: | array of variables and html code to be assigned
access: | protected
[ Top ] ### method translate [line 159]
`array translate( array $tableGroups)`
Translates and decodes all tables strings #### Tags:
return: | array of translated table groups
access: | protected
#### Parameters:
array | $tableGroups |
[ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:43 +0200 by phpDocumentor 1.3.0RC3