Element index for package Client
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ j ]
[ k ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ q ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ z ]
[ _ ]
_
- _get_compile_path
- in file Smarty_Cartoclient.php, method Smarty_Cartoclient::_get_compile_path()
Overrides Smarty's resource compile path
- __construct
- in file Smarty_Cartoclient.php, method Smarty_Plugin::__construct()
Constructor
- __construct
- in file Smarty_Cartoclient.php, method Smarty_Cartoclient::__construct()
Constructor
- __construct
- in file HttpRequestHandler.php, method HttpRequestHandler::__construct()
Constructor
- __construct
- in file ExportPlugin.php, method ExportOutput::__construct()
Constructor
- __construct
- in file FormRenderer.php, method FormRenderer::__construct()
Constructor
- __construct
- in file Views.php, method ViewContainer::__construct()
Constructor
- __construct
- in file Views.php, method ViewDbContainer::__construct()
Constructor
- __construct
- in file Views.php, method ViewManager::__construct()
Constructor
- __construct
- in file Views.php, method ViewUpgrader::__construct()
Constructor
- __construct
- in file Views.php, method ViewHooks::__construct()
Constructor.
- __construct
- in file Views.php, method ViewFilter::__construct()
Constructor
- __construct
- in file Views.php, method ViewFileContainer::__construct()
Constructor
- __construct
- in file ClientProjectHandler.php, method ClientProjectHandler::__construct()
Constructor
- __construct
- in file ClientPluginHelper.php, method ClientPluginHelper::__construct()
Constructor
- __construct
- in file Cartoclient.php, method ClientPluginConfig::__construct()
Constructor
- __construct
- in file CartoserverService.php, method CartoserverService::__construct()
Constructor
- __construct
- in file Cartoclient.php, method ClientConfig::__construct()
Constructor
- __construct
- in file Cartoclient.php, method Cartoclient::__construct()
Constructor
- __construct
- in file AjaxHelper.php, method PluginEnabler::__construct()
Constructor
- __construct
- in file CartoserverService.php, method SoapFaultWrapper::__construct()
Constructor
- __construct
- in file ClientAccounting.php, method ClientAccountingImpl::__construct()
Constructor
- __construct
- in file ClientPlugin.php, method FilterRequestModifier::__construct()
Constructor
- __construct
- in file ClientPlugin.php, method ToolDescription::__construct()
Constructor
- __construct
- in file ClientPlugin.php, method ClientPlugin::__construct()
Constructor
- __construct
- in file ClientMapInfoCache.php, method ClientMapInfoCache::__construct()
Constructor
- __construct
- in file ClientExportRtf.php, method ClientExportRtf::__construct()
Constructor
- __construct
- in file AjaxHelper.php, method AjaxPluginResponse::__construct()
Constructor
top
a
- $action
- in file Views.php, variable ViewContainer::$action
- $addedInputs
- in file ClientExportRtf.php, variable ClientExportRtf::$addedInputs
- $addedValues
- in file ClientExportRtf.php, variable ClientExportRtf::$addedValues
- $ajaxAction
- in file Cartoclient.php, variable Cartoclient::$ajaxAction
Current AJAX action, null if no AJAX action requested
- $appliesTo
- in file ClientPlugin.php, variable ToolDescription::$appliesTo
- add
- in file Views.php, method ViewUpgrader::add()
Adds a new property.
- addHtmlCode
- in file AjaxHelper.php, method AjaxPluginResponse::addHtmlCode()
Adds HTML code to AJAX response.
- addMessage
- in file Cartoclient.php, method Cartoclient::addMessage()
Adds a message to the list of message to display to the user
- addVariable
- in file AjaxHelper.php, method AjaxPluginResponse::addVariable()
Adds a value to AJAX response.
- adjustExportMapRequest
- in file ClientPlugin.php, method Exportable::adjustExportMapRequest()
Adjust map request to get a ready for export result
- Ajaxable
- in file ClientPlugin.php, class Ajaxable
Interface for plugins that generate AJAX responses
- AjaxException
- in file AjaxHelper.php, class AjaxException
AJAX specific exception
- ajaxGetPluginResponse
- in file ClientPlugin.php, method Ajaxable::ajaxGetPluginResponse()
Populates a plugin XML response to AJAX request
- ajaxHandleAction
- in file ClientPlugin.php, method Ajaxable::ajaxHandleAction()
Modifies plugins enable level for the given action
- AjaxPluginResponse
- in file AjaxHelper.php, class AjaxPluginResponse
Container for plugins' AJAX responses
- areViewsEnable
- in file Cartoclient.php, method Cartoclient::areViewsEnable()
Tells if views are enabled in configuration.
- arrayFromPhp
- in file AjaxHelper.php, method Json::arrayFromPhp()
Serializes a PHP variable to a JSON array
- assignCommonVariables
- in file Smarty_Cartoclient.php, method Smarty_Cartoclient::assignCommonVariables()
Fills some smarty variables common to all template objects
- BASE_METAS
- in file Views.php, class constant ViewManager::BASE_METAS
- BASE_WEIGHT
- in file Views.php, class constant ViewContainer::BASE_WEIGHT
- AjaxHelper.php
- procedural page AjaxHelper.php
- MAINMAP
- in file ClientPlugin.php, class constant ToolDescription::MAINMAP
Bitmask for tools
top
top
c
- $cartoclient
- in file Smarty_Cartoclient.php, variable Smarty_Cartoclient::$cartoclient
- $cartoclient
- in file FormRenderer.php, variable FormRenderer::$cartoclient
- $cartoclient
- in file AjaxHelper.php, variable PluginEnabler::$cartoclient
- $cartoclient
- in file Views.php, variable ViewFileContainer::$cartoclient
- $cartoclient
- in file Views.php, variable ViewFilter::$cartoclient
- $cartoclient
- in file Views.php, variable ViewManager::$cartoclient
- $cartoclient
- in file Views.php, variable ViewHooks::$cartoclient
- $cartoclient
- in file ClientMapInfoCache.php, variable ClientMapInfoCache::$cartoclient
- $cartoclient
- in file ClientPlugin.php, variable ClientPlugin::$cartoclient
- $cartoForm
- in file Cartoclient.php, variable Cartoclient::$cartoForm
- $cartoserver
- in file CartoserverService.php, variable CartoserverService::$cartoserver
- $cartoserverService
- in file Cartoclient.php, variable Cartoclient::$cartoserverService
- $catalog
- in file Views.php, variable ViewContainer::$catalog
- $catalogFile
- in file Views.php, variable ViewFileContainer::$catalogFile
- $clientSession
- in file Cartoclient.php, variable Cartoclient::$clientSession
- $config
- in file CartoserverService.php, variable CartoserverService::$config
- $config
- in file Cartoclient.php, variable Cartoclient::$config
- $config
- in file ClientPlugin.php, variable ClientPlugin::$config
- $contents
- in file ExportPlugin.php, variable ExportOutput::$contents
- $customForm
- in file FormRenderer.php, variable FormRenderer::$customForm
- $customTitle
- in file FormRenderer.php, variable FormRenderer::$customTitle
- callDirect
- in file CartoserverService.php, method CartoserverService::callDirect()
Calls function using direct mode
- callEnabledPluginImplementing
- in file Cartoclient.php, method Cartoclient::callEnabledPluginImplementing()
Calls a given $pluginName implementing an interface if its enable level is equal or higher than the given $enableLevel Interfaces are declared in ClientPlugin.
- callEnabledPluginsImplementing
- in file Cartoclient.php, method Cartoclient::callEnabledPluginsImplementing()
Calls enabled plugins implementing an interface A plugin is enabled if its enable level is equal or higher than the given $enableLevel Interfaces are declared in ClientPlugin.
- callFilters
- in file Views.php, method ViewUpgrader::callFilters()
Executes upgrade filters. To be redefined in extended filters.
- callFunction
- in file CartoserverService.php, method CartoserverService::callFunction()
Calls a function using either direct or SOAP mode
- callPluginsImplementing
- in file Cartoclient.php, method Cartoclient::callPluginsImplementing()
Calls plugins implementing an interface
- Cartoclient
- in file Cartoclient.php, class Cartoclient
Main Cartoclient class
- CartoclientException
- in file Cartoclient.php, class CartoclientException
Cartoclient exception
- CartoForm
- in file Cartoclient.php, class CartoForm
Stores if mainmap or keymap were clicked, and if yes where
- CartoserverService
- in file CartoserverService.php, class CartoserverService
Wrapper for server calls
- checkBool
- in file ClientPlugin.php, method ClientPlugin::checkBool()
Checks if variable $variable has a boolean (0 or 1) value $value.
- checkClickedButtons
- in file HttpRequestHandler.php, method HttpRequestHandler::checkClickedButtons()
Checks if one map was clicked
- checkInt
- in file ClientPlugin.php, method ClientPlugin::checkInt()
Checks if variable $variable has an integer positive or zero value $value.
- checkKeymapButton
- in file HttpRequestHandler.php, method HttpRequestHandler::checkKeymapButton()
Returns true if key map was clicked and stores the point selected on key map into $cartoForm.
- checkLoaded
- in file AjaxHelper.php, method PluginEnabler::checkLoaded()
- checkMainmapButton
- in file HttpRequestHandler.php, method HttpRequestHandler::checkMainmapButton()
Returns true if main map was clicked
- checkMapInfoTimestamp
- in file ClientMapInfoCache.php, method ClientMapInfoCache::checkMapInfoTimestamp()
Checks if MapInfo is up-to-date, reload it from server if it's not
- checkNumeric
- in file ClientPlugin.php, method ClientPlugin::checkNumeric()
Checks if variable $variable has a numeric value $value.
- checkVersion
- in file Views.php, method ViewFilter::checkVersion()
Checks that view format is not outdated. If yes, tries to "repair".
- checkViewId
- in file Views.php, method ViewManager::checkViewId()
Checks view ID validity (non zero positive integer).
- ClientAccountingImpl
- in file ClientAccounting.php, class ClientAccountingImpl
Client implementation of accounting management.
- clientAllowed
- in file Cartoclient.php, method Cartoclient::clientAllowed()
Returns whether the current user has privileges to access cartoweb. It
- ClientConfig
- in file Cartoclient.php, class ClientConfig
Configuration for client side
- ClientExportRtf
- in file ClientExportRtf.php, class ClientExportRtf
Overall class for generating RTF
- ClientMapInfoCache
- in file ClientMapInfoCache.php, class ClientMapInfoCache
Client side MapInfo cache implementation
- ClientPlugin
- in file ClientPlugin.php, class ClientPlugin
Client plugin
- ClientPluginConfig
- in file Cartoclient.php, class ClientPluginConfig
Configuration for client plugins
- ClientPluginHelper
- in file ClientPluginHelper.php, class ClientPluginHelper
Helper for client plugin interfaces
- ClientProjectHandler
- in file ClientProjectHandler.php, class ClientProjectHandler
Project handler for the client
- ClientSession
- in file Cartoclient.php, class ClientSession
Data stored in session
- closeResource
- in file Views.php, method ViewDbContainer::closeResource()
- closeResource
- in file Views.php, method ViewFileContainer::closeResource()
Closes view-storage file.
- closeResource
- in file Views.php, method ViewContainer::closeResource()
Closes connection to storage resource.
- computeLocationId
- in file Views.php, method ViewContainer::computeLocationId()
Returns ID of view located right after current view.
- computeMapInfo
- in file ClientMapInfoCache.php, method ClientMapInfoCache::computeMapInfo()
- computeWeight
- in file Views.php, method ViewContainer::computeWeight()
Computes weight of current view to determine its location in the views list.
- convertName
- in file ClientPluginHelper.php, method ToolProviderHelper::convertName()
Converts a name one_toto_two ==> OneTotoTwo
- convert_to_rtf_image
- in file ClientExportRtf.php, method ClientExportRtf::convert_to_rtf_image()
Returns an hexadecimal representation of an image
- coordsToPoints
- in file HttpRequestHandler.php, method DhtmlSelectionParser::coordsToPoints()
Parses coords array data and converts it to an array of Point
- coordToPoint
- in file HttpRequestHandler.php, method DhtmlSelectionParser::coordToPoint()
Parses coord data and converts it to Point
- createSession
- in file ClientPlugin.php, method Sessionable::createSession()
Initializes session data
- Cartoclient.php
- procedural page Cartoclient.php
- CartoserverService.php
- procedural page CartoserverService.php
- ClientMapInfoCache.php
- procedural page ClientMapInfoCache.php
- ClientPluginHelper.php
- procedural page ClientPluginHelper.php
- ClientPlugin.php
- procedural page ClientPlugin.php
- ClientProjectHandler.php
- procedural page ClientProjectHandler.php
top
d
- $data
- in file Views.php, variable ViewManager::$data
- $data
- in file Views.php, variable ViewContainer::$data
- $db
- in file Views.php, variable ViewDbContainer::$db
- $defaultSession
- in file Views.php, variable ViewFilter::$defaultSession
- $dsn
- in file Views.php, variable ViewDbContainer::$dsn
- decapsulate
- in file Views.php, method ViewFilter::decapsulate()
Extracts view data from its XML storage.
- decode
- in file Encoding.php, method EncoderISO::decode()
- decode
- in file Encoding.php, method EncoderUTF::decode()
- decode
- in file Encoding.php, method EncoderInterface::decode()
Wrapper for function decode
- delete
- in file Views.php, method ViewContainer::delete()
Wrapper for 'delete' action.
- delete
- in file Views.php, method ViewFileContainer::delete()
Deletes given view.
- DhtmlSelectionParser
- in file HttpRequestHandler.php, class DhtmlSelectionParser
Parses dhtml HTTP Requests, and returns a shape for the drawn selection.
- disable
- in file ClientPlugin.php, method ClientPlugin::disable()
Sets the enable level to ClientPlugin::ENABLE_LEVEL_SERVERCALL.
- disableCoreplugins
- in file AjaxHelper.php, method PluginEnabler::disableCoreplugins()
Disables all coreplugins: set their enable level to ClientPlugin::ENABLE_LEVEL_LOAD.
- disablePlugin
- in file AjaxHelper.php, method PluginEnabler::disablePlugin()
Disables the given plugin name: set its enable level to to ClientPlugin::ENABLE_LEVEL_LOAD.
- disablePlugins
- in file AjaxHelper.php, method PluginEnabler::disablePlugins()
Disables all plugins that are not coreplugins: set their enable level to ClientPlugin::ENABLE_LEVEL_LOAD.
- doAction
- in file Views.php, method ViewContainer::doAction()
Performs view processing.
- doExport
- in file Cartoclient.php, method Cartoclient::doExport()
Alternative processing of doMain() when exporting data.
- doMain
- in file Cartoclient.php, method Cartoclient::doMain()
Main method
- drawJavascriptFolders
- in file FormRenderer.php, method FormRenderer::drawJavascriptFolders()
Sets template variables for displaying the javascript folders.
- drawMessages
- in file FormRenderer.php, method FormRenderer::drawMessages()
Draws user and developer messages
- drawProjectsChooser
- in file FormRenderer.php, method FormRenderer::drawProjectsChooser()
Draw a drop-down list with project names.
- drawTools
- in file FormRenderer.php, method FormRenderer::drawTools()
Draws tool bar
- drawUserAndRoles
- in file FormRenderer.php, method FormRenderer::drawUserAndRoles()
Sets some variables in the template about the current user and its roles.
- drawUserForm
- in file ClientExportRtf.php, method ClientExportRtf::drawUserForm()
Returns a String of the user form that will be injected in the cartoclient.tpl
top
e
- $enabledLevel
- in file ClientPlugin.php, variable ClientPlugin::$enabledLevel
Enable level of the plugin (used for AJAX calls).
- $exportRtfFormState
- in file ClientExportRtf.php, variable ClientExportRtf::$exportRtfFormState
- ExportPlugin.php
- procedural page ExportPlugin.php
- enable
- in file ClientPlugin.php, method ClientPlugin::enable()
Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL.
- enablePlugin
- in file AjaxHelper.php, method PluginEnabler::enablePlugin()
Enables the given plugin name: set its enable level to to ClientPlugin::ENABLE_LEVEL_LOAD.
- encapsulate
- in file Views.php, method ViewFilter::encapsulate()
Encapsulates view data within an XML document.
- encode
- in file Encoding.php, method EncoderInterface::encode()
Wrapper for function encode
- encode
- in file Encoding.php, method EncoderISO::encode()
- encode
- in file Encoding.php, method EncoderUTF::encode()
- EncoderInterface
- in file Encoding.php, class EncoderInterface
Encoder interface
- EncoderISO
- in file Encoding.php, class EncoderISO
ISO-8859-1 en/decoder
- EncoderUTF
- in file Encoding.php, class EncoderUTF
UTF8 en/decoder
- escapeQuotes
- in file AjaxHelper.php, method Json::escapeQuotes()
Escapes single quotes (using a backslash)
- Exportable
- in file ClientPlugin.php, class Exportable
Interface for plugins that may modify requests before an export
- ExportConfiguration
- in file ExportPlugin.php, class ExportConfiguration
Export configuration
- ExportOutput
- in file ExportPlugin.php, class ExportOutput
Output of an export
- ExportPlugin
- in file ExportPlugin.php, class ExportPlugin
Export plugin
- KEYMAP
- in file ClientPlugin.php, class constant ToolDescription::KEYMAP
- SELECTION_COORDS
- in file HttpRequestHandler.php, class constant DhtmlSelectionParser::SELECTION_COORDS
- SELECTION_TYPE
- in file HttpRequestHandler.php, class constant DhtmlSelectionParser::SELECTION_TYPE
top
f
- $fileName
- in file Views.php, variable ViewFileContainer::$fileName
- $fileName
- in file ExportPlugin.php, variable ExportOutput::$fileName
- $filePath
- in file ExportPlugin.php, variable ExportOutput::$filePath
- $formRenderer
- in file Cartoclient.php, variable Cartoclient::$formRenderer
- FormRenderer.php
- procedural page FormRenderer.php
- fetchRtfImage
- in file ClientExportRtf.php, method ClientExportRtf::fetchRtfImage()
Returns an RTF string containing an RTF compatible image
- fetchRtfQueryResult
- in file ClientExportRtf.php, method ClientExportRtf::fetchRtfQueryResult()
Returns an RTF string containing the query result in form of tables
- filterGetRequest
- in file ClientPlugin.php, method FilterProvider::filterGetRequest()
Modifies GET requests
- filterMetas
- in file Views.php, method ViewDbContainer::filterMetas()
Performs some manipulations on metadata.
- filterPostRequest
- in file ClientPlugin.php, method FilterProvider::filterPostRequest()
Modifies POST requests
- FilterProvider
- in file ClientPlugin.php, class FilterProvider
Interface for plugins that may modify HTTP GET requests
- FilterRequestModifier
- in file ClientPlugin.php, class FilterRequestModifier
This class is used by plugins to modify HTTP Get requests
- filterViewable
- in file Views.php, function filterViewable()
- FormRenderer
- in file FormRenderer.php, class FormRenderer
Class responsible for GUI display
- fromPhpArray
- in file AjaxHelper.php, method Json::fromPhpArray()
Serializes a PHP array to a JSON array (respects object/array types during recursion)
- fromPhpArrayToJsonArray
- in file AjaxHelper.php, method Json::fromPhpArrayToJsonArray()
Serializes a PHP array to a JSON array
- fromPhpArrayToJsonObject
- in file AjaxHelper.php, method Json::fromPhpArrayToJsonObject()
Serializes a PHP array to a JSON array
- fromPhpObject
- in file AjaxHelper.php, method Json::fromPhpObject()
Serializes a PHP object to a JSON object (respects object/array types during recursion)
- fromPhpObjectToJsonArray
- in file AjaxHelper.php, method Json::fromPhpObjectToJsonArray()
Serializes a PHP object to a JSON array
- fromPhpObjectToJsonObject
- in file AjaxHelper.php, method Json::fromPhpObjectToJsonObject()
Serializes a PHP object to a JSON object
top
g
- $group
- in file ClientPlugin.php, variable ToolDescription::$group
- getActionSuccess
- in file Views.php, method ViewManager::getActionSuccess()
- getActionSuccess
- in file Views.php, method ViewContainer::getActionSuccess()
- getAjaxAction
- in file Cartoclient.php, method Cartoclient::getAjaxAction()
Returns the requested AJAX action
- getBasePath
- in file Cartoclient.php, method ClientPluginConfig::getBasePath()
Returns base path
- getBasePath
- in file Cartoclient.php, method ClientConfig::getBasePath()
Returns base path
- getBbox
- in file ExportPlugin.php, method ExportConfiguration::getBbox()
- getBool
- in file Views.php, method ViewDbContainer::getBool()
Tells if given value is true or false.
- getButtonPixelPoint
- in file HttpRequestHandler.php, method HttpRequestHandler::getButtonPixelPoint()
Returns point where button was clicked
- getCartoclient
- in file ClientPlugin.php, method ClientPlugin::getCartoclient()
- getCartoForm
- in file Cartoclient.php, method Cartoclient::getCartoForm()
- getCartoserver
- in file CartoserverService.php, method CartoserverService::getCartoserver()
Returns Cartoserver object, creates it if needed
- getCartoserverService
- in file Cartoclient.php, method Cartoclient::getCartoserverService()
- getCartoserverUrl
- in file CartoserverService.php, method CartoserverService::getCartoserverUrl()
Constructs Cartoserver URL depending on configuration base URL
- getCatalog
- in file Views.php, method ViewContainer::getCatalog()
Returns views catalog.
- getCatalog
- in file Views.php, method ViewManager::getCatalog()
Returns view catalog.
- getCharset
- in file Encoding.php, method EncoderISO::getCharset()
- getCharset
- in file Encoding.php, method EncoderInterface::getCharset()
Wrapper for function getCharset
- getCharset
- in file Encoding.php, method EncoderUTF::getCharset()
- getCircleShape
- in file HttpRequestHandler.php, method DhtmlSelectionParser::getCircleShape()
Parses coords array data stored in $_REQUEST and converts it to a Circle
- getClientSession
- in file Cartoclient.php, method Cartoclient::getClientSession()
- getClientVersion
- in file Cartoclient.php, method Cartoclient::getClientVersion()
Returns CartoWeb version and revision strings of the Cartoclient
- getConfig
- in file ClientAccounting.php, method ClientAccountingImpl::getConfig()
- getConfig
- in file ClientPlugin.php, method ClientPlugin::getConfig()
- getConfig
- in file Cartoclient.php, method Cartoclient::getConfig()
- getConfiguration
- in file ClientExportRtf.php, method ClientExportRtf::getConfiguration()
Builds export configuration.
- getContents
- in file ExportPlugin.php, method ExportOutput::getContents()
Returns contents if it is not null, contents of file otherwise
- getCorepluginNames
- in file AjaxHelper.php, method PluginEnabler::getCorepluginNames()
Wrapper method for PluginManager::getCorepluginNames().
- getCorePluginNames
- in file Cartoclient.php, method Cartoclient::getCorePluginNames()
Returns the names of core plugins
- getDefaultData
- in file Views.php, method ViewFilter::getDefaultData()
Returns cached session plugin storage.
- getDefaultSessionData
- in file Views.php, method ViewManager::getDefaultSessionData()
Returns default session.
- getDefaultSessionData
- in file Views.php, method ViewUpgrader::getDefaultSessionData()
Retrieves default session data.
- getDeveloperMessages
- in file FormRenderer.php, method FormRenderer::getDeveloperMessages()
Returns a developers messages array
- getEnabledLevel
- in file ClientPlugin.php, method ClientPlugin::getEnabledLevel()
Returns the enable level.
- getExport
- in file ExportPlugin.php, method ExportPlugin::getExport()
Renders export
- getExport
- in file ClientExportRtf.php, method ClientExportRtf::getExport()
- getExportResult
- in file ExportPlugin.php, method ExportPlugin::getExportResult()
Retrieves MapResult
- getExportUrl
- in file ExportPlugin.php, method ExportPlugin::getExportUrl()
Returns base export plugin URL.
- getFileName
- in file ExportPlugin.php, method ExportOutput::getFileName()
Returns file name if the file exists, null otherwise
- getFileName
- in file Views.php, method ViewFileContainer::getFileName()
Returns view-storage filepath.
- getFilterFilePath
- in file Views.php, method ViewFilter::getFilterFilePath()
Returns path of plugin view filters file.
- getFiltersSequence
- in file Views.php, method ViewFilter::getFiltersSequence()
Detects sequence of filters needed to upgrade data.
- getFormRenderer
- in file Cartoclient.php, method Cartoclient::getFormRenderer()
- getFromDefaultSession
- in file Views.php, method ViewUpgrader::getFromDefaultSession()
Retrieves some data in cached default session
- getGfxPath
- in file ClientExportRtf.php, method ClientExportRtf::getGfxPath()
Returns the absolute URL of $gfx, using the ResourceHandler
- getHtmlCode
- in file AjaxHelper.php, method AjaxPluginResponse::getHtmlCode()
Returns an array of HTML code.
- getHttpRequestHandler
- in file Cartoclient.php, method Cartoclient::getHttpRequestHandler()
- getHttpValue
- in file ClientPlugin.php, method ClientPlugin::getHttpValue()
Returns the user-submitted $key data if it is set.
- getId
- in file Views.php, method ViewManager::getId()
Gets id from given request parameter and checks its validity.
- getInitialMapState
- in file Cartoclient.php, method Cartoclient::getInitialMapState()
Retrieves initialMapState data depending on detected initialMapStateId.
- getInstance
- in file Cartoclient.php, method Cartoclient::getInstance()
Returns the instance of this class. There is only one during the cartoclient lifetime.
- getKind
- in file Cartoclient.php, method ClientConfig::getKind()
Returns config type
- getKind
- in file Cartoclient.php, method ClientPluginConfig::getKind()
Returns plugin config type
- getKind
- in file ClientAccounting.php, method ClientAccountingImpl::getKind()
- getLastBbox
- in file ClientExportRtf.php, method ClientExportRtf::getLastBbox()
- getLastMapImage
- in file ClientExportRtf.php, method ClientExportRtf::getLastMapImage()
function kept for future developments
- getLastMapRequest
- in file ExportPlugin.php, method ExportPlugin::getLastMapRequest()
Returns session-saved last MapRequest.
- getLastMapResult
- in file ExportPlugin.php, method ExportPlugin::getLastMapResult()
Returns session-saved last MapResult.
- getLayerIds
- in file ExportPlugin.php, method ExportConfiguration::getLayerIds()
- getLineShape
- in file HttpRequestHandler.php, method DhtmlSelectionParser::getLineShape()
Parses coords array data stored in $_REQUEST and converts it to a Line
- getLocales
- in file Internationalization.php, method I18n::getLocales()
Returns available locales
- getLocationId
- in file Views.php, method ViewContainer::getLocationId()
- getLocationType
- in file ExportPlugin.php, method ExportConfiguration::getLocationType()
- getMainmapShape
- in file HttpRequestHandler.php, method DhtmlSelectionParser::getMainmapShape()
Converts coords array data to a Shape
- getMap
- in file CartoserverService.php, method CartoserverService::getMap()
Retrieves MapResult from server
- getMapAngle
- in file ExportPlugin.php, method ExportConfiguration::getMapAngle()
- getMapHeight
- in file ExportPlugin.php, method ExportConfiguration::getMapHeight()
- getMapId
- in file ClientAccounting.php, method ClientAccountingImpl::getMapId()
- getMapInfo
- in file Cartoclient.php, method Cartoclient::getMapInfo()
Returns Map Info, get it from cache if not yet set
- getMapInfo
- in file CartoserverService.php, method CartoserverService::getMapInfo()
Retrieves MapInfo from server
- getMapInfoCache
- in file Cartoclient.php, method Cartoclient::getMapInfoCache()
Returns the MapInfoCache
- getMapInfoFile
- in file ClientMapInfoCache.php, method ClientMapInfoCache::getMapInfoFile()
- getMapRequest
- in file Cartoclient.php, method Cartoclient::getMapRequest()
Initializes map request with current mapId
- getMapResult
- in file Cartoclient.php, method Cartoclient::getMapResult()
- getMapResultFromRequest
- in file Cartoclient.php, method Cartoclient::getMapResultFromRequest()
Calls Cartoserver service to get results
- getMapWidth
- in file ExportPlugin.php, method ExportConfiguration::getMapWidth()
- getMessage
- in file Views.php, method ViewManager::getMessage()
Returns result message if any.
- getMessage
- in file Views.php, method ViewContainer::getMessage()
- getMessages
- in file FormRenderer.php, method FormRenderer::getMessages()
Returns CartoWeb's user and developer messages
- getMessages
- in file Cartoclient.php, method Cartoclient::getMessages()
- getMetas
- in file Views.php, method ViewManager::getMetas()
Returns metadata.
- getMetas
- in file Views.php, method ViewContainer::getMetas()
Returns metadata.
- getMetasList
- in file Views.php, method ViewManager::getMetasList()
Returns ViewManager::metasList, list of metadata fields.
- getOutputType
- in file Cartoclient.php, method Cartoclient::getOutputType()
Returns the current output type (pdf, csv, html, etc.).
- getPath
- in file Cartoclient.php, method ClientPluginConfig::getPath()
Returns directory where .ini are located
- getPlugin
- in file AjaxHelper.php, method PluginEnabler::getPlugin()
Wrapper method for PluginManager::getPlugin().
- getPluginManager
- in file Cartoclient.php, method Cartoclient::getPluginManager()
- getPluginName
- in file Views.php, method ViewFilter::getPluginName()
Returns plugin base name.
- getPlugins
- in file AjaxHelper.php, method PluginEnabler::getPlugins()
Wrapper method for PluginManager::getPlugins().
- getPluginSession
- in file Views.php, method ViewManager::getPluginSession()
- getPoint
- in file ExportPlugin.php, method ExportConfiguration::getPoint()
- getPointShape
- in file HttpRequestHandler.php, method DhtmlSelectionParser::getPointShape()
Parses coords array data stored in $_REQUEST and converts it to Point
- getPolygonShape
- in file HttpRequestHandler.php, method DhtmlSelectionParser::getPolygonShape()
Parses coords array data stored in $_REQUEST and converts it to a Polygon
- getPrintOutline
- in file ExportPlugin.php, method ExportConfiguration::getPrintOutline()
- getProfileParameters
- in file Cartoclient.php, method ClientConfig::getProfileParameters()
{@see Config::getProfileParameters()})
- getProjectHandler
- in file Cartoclient.php, method Cartoclient::getProjectHandler()
- getProjectName
- in file ClientProjectHandler.php, method ClientProjectHandler::getProjectName()
Returns project name
- getQueryBbox
- in file ExportPlugin.php, method ExportConfiguration::getQueryBbox()
- getQuerySelections
- in file ExportPlugin.php, method ExportConfiguration::getQuerySelections()
- getRecorderVersion
- in file Views.php, method ViewFilter::getRecorderVersion()
Returns current version of given plugin session container.
- getRectangleShape
- in file HttpRequestHandler.php, method DhtmlSelectionParser::getRectangleShape()
Parses coords array data stored in $_REQUEST and converts it to a Rectangle
- getRequest
- in file ClientPlugin.php, method FilterRequestModifier::getRequest()
- getRequestValue
- in file Views.php, method ViewManager::getRequestValue()
Returns value of given request parameter if exists.
- getResolution
- in file ExportPlugin.php, method ExportConfiguration::getResolution()
- getResourceHandler
- in file Cartoclient.php, method Cartoclient::getResourceHandler()
- getScale
- in file ExportPlugin.php, method ExportConfiguration::getScale()
- getSelfUrl
- in file Cartoclient.php, method Cartoclient::getSelfUrl()
Returns current base URL.
- getSessionCacheLocation
- in file Views.php, method ViewManager::getSessionCacheLocation()
Returns path of cached session file.
- getSessionName
- in file Cartoclient.php, method Cartoclient::getSessionName()
Builds and returns session name.
- getShowRefMarks
- in file ExportPlugin.php, method ExportConfiguration::getShowRefMarks()
- getSmarty
- in file FormRenderer.php, method FormRenderer::getSmarty()
Returns the Smarty template object used for template rendering. It may be used by plugins if they want to override the template display.
- getSwitchId
- in file ExportPlugin.php, method ExportConfiguration::getSwitchId()
- gettext
- in file Internationalization.php, method I18nInterface::gettext()
Wrapper for function gettext
- gettext
- in file Internationalization.php, method I18nDummy::gettext()
- gettext
- in file Internationalization.php, method I18nGettext::gettext()
- getTools
- in file FormRenderer.php, method FormRenderer::getTools()
Return the list of activated tools, see drawTools()
- getTools
- in file ClientPlugin.php, method ToolProvider::getTools()
Returns the provided tools
- getToolsHelper
- in file ClientPluginHelper.php, method ToolProviderHelper::getToolsHelper()
Calls plugin's ToolProvider::getTools(), updates tools
- getUserMessages
- in file FormRenderer.php, method FormRenderer::getUserMessages()
Returns a user messages array
- getValidExportType
- in file Cartoclient.php, method Cartoclient::getValidExportType()
Tells if an export plugin is available for current output and returns it.
- getValue
- in file ClientPlugin.php, method FilterRequestModifier::getValue()
- getVariables
- in file AjaxHelper.php, method AjaxPluginResponse::getVariables()
Returns an array of variables.
- getViewablePlugins
- in file Views.php, method ViewManager::getViewablePlugins()
Returns the list of plugins that have their data recorded in views (set in client.ini "viewablePlugins" parameter).
- getViewContainer
- in file Views.php, method ViewManager::getViewContainer()
Returns view container instance (file or DB using).
- getViewId
- in file Views.php, method ViewContainer::getViewId()
- getViewId
- in file Views.php, method ViewManager::getViewId()
Returns current view ID.
- getViewManager
- in file Cartoclient.php, method Cartoclient::getViewManager()
- getWeights
- in file Views.php, method ViewContainer::getWeights()
Returns natural-orderedviews weights list.
- getZoomType
- in file ExportPlugin.php, method ExportConfiguration::getZoomType()
- gt
- in file Internationalization.php, method I18n::gt()
Calls translator's gettext
- guessI18nClass
- in file Internationalization.php, method I18n::guessI18nClass()
Guess the I18nInterface class to use
- GuiProvider
- in file ClientPlugin.php, class GuiProvider
Interface for plugins that interact with HTML forms
top
h
- $handle
- in file Views.php, variable ViewFileContainer::$handle
- $hasIcon
- in file ClientPlugin.php, variable ToolDescription::$hasIcon
- $headerSent
- in file Smarty_Cartoclient.php, variable Smarty_Cartoclient::$headerSent
- $htmlCode
- in file AjaxHelper.php, variable AjaxPluginResponse::$htmlCode
- $httpRequestHandler
- in file Cartoclient.php, variable Cartoclient::$httpRequestHandler
- HttpRequestHandler.php
- procedural page HttpRequestHandler.php
- handleApplicationTool
- in file ClientPlugin.php, method ToolProvider::handleApplicationTool()
Handles tool when stateless application was clicked
- handleHttpGetRequest
- in file ClientPlugin.php, method GuiProvider::handleHttpGetRequest()
Handles data coming from a get request
- handleHttpGetRequest
- in file ClientExportRtf.php, method ClientExportRtf::handleHttpGetRequest()
- handleHttpPostRequest
- in file ClientPlugin.php, method GuiProvider::handleHttpPostRequest()
Handles data coming from a post request
- handleHttpPostRequest
- in file ClientExportRtf.php, method ClientExportRtf::handleHttpPostRequest()
- handleHttpRequest
- in file HttpRequestHandler.php, method HttpRequestHandler::handleHttpRequest()
Handles buttons and tools.
- handleInit
- in file ClientPlugin.php, method InitUser::handleInit()
Handles initialization object taken from MapInfo
- handleInitHelper
- in file ClientPluginHelper.php, method InitUserHelper::handleInitHelper()
Gets init object and calls plugin's InitProvider::handleInit()
- handleKeymapTool
- in file ClientPlugin.php, method ToolProvider::handleKeymapTool()
Handles tool when keymap was clicked
- handleMainmapTool
- in file ClientPlugin.php, method ToolProvider::handleMainmapTool()
Handles tool when main map was clicked
- handlePreLoading
- in file Views.php, method ViewHooks::handlePreLoading()
Processes view data before it is loaded.
- handleResult
- in file ClientPlugin.php, method ServerCaller::handleResult()
Handles server result
- handleResultHelper
- in file ClientPluginHelper.php, method ServerCallerHelper::handleResultHelper()
Gets plugin specific result out of MapResult and calls
- handleTool
- in file HttpRequestHandler.php, method HttpRequestHandler::handleTool()
Handles HTTP request for one tool of one plugin
- handleTools
- in file HttpRequestHandler.php, method HttpRequestHandler::handleTools()
Handles HTTP request for selected plugin tool
- handleView
- in file Views.php, method ViewManager::handleView()
Main view handler: detects what action to perform.
- hasRole
- in file Views.php, method ViewManager::hasRole()
Checks that user is allowed to perform special view actions.
- HttpRequestHandler
- in file HttpRequestHandler.php, class HttpRequestHandler
Does common actions on HTTP request
top
i
- $i18n
- in file Internationalization.php, variable I18n::$i18n
Translator
- $id
- in file ClientPlugin.php, variable ToolDescription::$id
- $initialMapState
- in file Cartoclient.php, variable Cartoclient::$initialMapState
- $instance
- in file Cartoclient.php, variable Cartoclient::$instance
Singleton
- $interruptFlow
- in file Cartoclient.php, variable Cartoclient::$interruptFlow
When true, the cartoweb flow of operation will be interrupted and the html will be displayed.
- $isActionSuccess
- in file Views.php, variable ViewContainer::$isActionSuccess
- $isActionSuccess
- in file Views.php, variable ViewManager::$isActionSuccess
- $isNewSession
- in file Cartoclient.php, variable Cartoclient::$isNewSession
- Internationalization.php
- procedural page Internationalization.php
- I18n
- in file Internationalization.php, class I18n
Translator selection
- I18nDummy
- in file Internationalization.php, class I18nDummy
Dummy translator (does nothing)
- I18nGettext
- in file Internationalization.php, class I18nGettext
Gettext translator
- I18nInterface
- in file Internationalization.php, class I18nInterface
Translator interface
- init
- in file Internationalization.php, method I18n::init()
Initializes locales
- initializeConfig
- in file ClientPlugin.php, method ClientPlugin::initializeConfig()
Initializes plugin configuration
- initializeObjects
- in file Cartoclient.php, method Cartoclient::initializeObjects()
Initializes client objects
- initializePlugins
- in file Cartoclient.php, method Cartoclient::initializePlugins()
Initializes core and normal client plugins
- initializeResult
- in file ClientPlugin.php, method ServerCaller::initializeResult()
Initializes plugin state depending on server result
- initializeResultHelper
- in file ClientPluginHelper.php, method ServerCallerHelper::initializeResultHelper()
Gets plugin specific result out of MapResult and calls
- initializeSession
- in file Cartoclient.php, method Cartoclient::initializeSession()
Initializes session
- InitUser
- in file ClientPlugin.php, class InitUser
Interface for plugins with MapInfo specific data
- InitUserHelper
- in file ClientPluginHelper.php, class InitUserHelper
Helper for InitUser
- insert
- in file Views.php, method ViewContainer::insert()
Wrapper for 'insert' action.
- isAjaxMode
- in file Cartoclient.php, method Cartoclient::isAjaxMode()
Tells if the Cartoclient runs in AJAX mode
- isButtonPushed
- in file HttpRequestHandler.php, method HttpRequestHandler::isButtonPushed()
Returns true if button was clicked
- isCoreplugin
- in file AjaxHelper.php, method PluginEnabler::isCoreplugin()
Returns true if the given plugin is a coreplugin
- isEmpty
- in file AjaxHelper.php, method AjaxPluginResponse::isEmpty()
Returns true if both HTML and variables content are empty
- isEnabledAtLevel
- in file ClientPlugin.php, method ClientPlugin::isEnabledAtLevel()
Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL.
- isInterruptFlow
- in file Cartoclient.php, method Cartoclient::isInterruptFlow()
Returns true if the flow of operation has to be interrupted, and the template displayed without calling server.
- isLoaded
- in file AjaxHelper.php, method PluginEnabler::isLoaded()
Returns true if the given plugin name is loaded.
- isMainmapClicked
- in file HttpRequestHandler.php, method DhtmlSelectionParser::isMainmapClicked()
Returns true if main map was clicked
- isRenderKeymap
- in file ExportPlugin.php, method ExportConfiguration::isRenderKeymap()
- isRenderMap
- in file ExportPlugin.php, method ExportConfiguration::isRenderMap()
- isRenderScalebar
- in file ExportPlugin.php, method ExportConfiguration::isRenderScalebar()
- is_vector
- in file AjaxHelper.php, method Json::is_vector()
Tells if an array indexes are all numeric (not necessarily sequenctial)
top
j
- AJAXACTION_PARAM_NAME
- in file Cartoclient.php, class constant Cartoclient::AJAXACTION_PARAM_NAME
HTTP parameter name for AJAX actions
- Json
- in file AjaxHelper.php, class Json
PHP to JSON type converter (incomplete)
top
top
l
- $langList
- in file Internationalization.php, variable I18n::$langList
Order and restrict lang list
- $lastMapRequest
- in file Cartoclient.php, variable ClientSession::$lastMapRequest
Last request sent to server (useful for export, see
- $lastMapResult
- in file Cartoclient.php, variable ClientSession::$lastMapResult
Last result received from server (useful for export, see
- $layerIds
- in file ExportPlugin.php, variable ExportConfiguration::$layerIds
- $locationId
- in file Views.php, variable ViewContainer::$locationId
- $locationType
- in file ExportPlugin.php, variable ExportConfiguration::$locationType
- $log
- in file CartoserverService.php, variable CartoserverService::$log
- $log
- in file HttpRequestHandler.php, variable HttpRequestHandler::$log
- $log
- in file Views.php, variable ViewContainer::$log
- $log
- in file Views.php, variable ViewManager::$log
- $log
- in file Views.php, variable ViewFilter::$log
- $log
- in file FormRenderer.php, variable FormRenderer::$log
- $log
- in file ClientPlugin.php, variable ClientPlugin::$log
- $log
- in file ClientMapInfoCache.php, variable ClientMapInfoCache::$log
- $log
- in file Cartoclient.php, variable Cartoclient::$log
- $log
- in file ClientPluginHelper.php, variable ClientPluginHelper::$log
- $log
- in file ClientProjectHandler.php, variable ClientProjectHandler::$log
- CLIENT_SESSION_KEY
- in file Cartoclient.php, class constant Cartoclient::CLIENT_SESSION_KEY
Prefix for session key.
- loadSession
- in file ClientPlugin.php, method Sessionable::loadSession()
Reloads data from session object
- loadSessionHelper
- in file ClientPluginHelper.php, method SessionableHelper::loadSessionHelper()
Loads client session and calls plugin's
- localesSort
- in file Internationalization.php, method I18n::localesSort()
Sort locales array accordingly to reference array
- lockResource
- in file Views.php, method ViewContainer::lockResource()
Locks access to storage resource.
- lockResource
- in file Views.php, method ViewDbContainer::lockResource()
- lockResource
- in file Views.php, method ViewFileContainer::lockResource()
top
m
- $mainmapShape
- in file Cartoclient.php, variable CartoForm::$mainmapShape
- $mapAngle
- in file ExportPlugin.php, variable ExportConfiguration::$mapAngle
- $mapHeight
- in file ExportPlugin.php, variable ExportConfiguration::$mapHeight
- $mapInfo
- in file Cartoclient.php, variable Cartoclient::$mapInfo
- $mapInfoCache
- in file Cartoclient.php, variable Cartoclient::$mapInfoCache
- $mapResult
- in file Cartoclient.php, variable Cartoclient::$mapResult
- $mapWidth
- in file ExportPlugin.php, variable ExportConfiguration::$mapWidth
- $message
- in file Views.php, variable ViewManager::$message
- $message
- in file Views.php, variable ViewContainer::$message
- $messages
- in file Cartoclient.php, variable Cartoclient::$messages
Array of user/developer messages
- $metas
- in file Views.php, variable ViewManager::$metas
- $metas
- in file Views.php, variable ViewContainer::$metas
- $metasList
- in file Views.php, variable ViewDbContainer::$metasList
- $metasList
- in file Views.php, variable ViewManager::$metasList
- MapInfoCache.php
- procedural page MapInfoCache.php
- main
- in file Cartoclient.php, method Cartoclient::main()
Main entry point.
- makeMetasSql
- in file Views.php, method ViewDbContainer::makeMetasSql()
Builds the metadata querystring
- makeSessionCache
- in file Views.php, method ViewManager::makeSessionCache()
Writes cached session file.
- manageViewsSystem
- in file Cartoclient.php, method Cartoclient::manageViewsSystem()
Detects if views controller must be launched.
top
top
top
p
- $plugin
- in file ClientPlugin.php, variable ToolDescription::$plugin
- $pluginManager
- in file Cartoclient.php, variable Cartoclient::$pluginManager
- $pluginName
- in file Views.php, variable ViewUpgrader::$pluginName
- $pluginStorage
- in file Cartoclient.php, variable ClientSession::$pluginStorage
Plugins data
- $pluginsVersions
- in file Views.php, variable ViewFilter::$pluginsVersions
- $point
- in file ExportPlugin.php, variable ExportConfiguration::$point
- $preventSaveSession
- in file Cartoclient.php, variable Cartoclient::$preventSaveSession
Boolean value allowing to bypass the saveSession() call, hence the
- $printOutline
- in file ExportPlugin.php, variable ExportConfiguration::$printOutline
- $projectHandler
- in file Smarty_Cartoclient.php, variable Smarty_Cartoclient::$projectHandler
- $projectHandler
- in file Cartoclient.php, variable Cartoclient::$projectHandler
- $projectName
- in file ClientProjectHandler.php, variable ClientProjectHandler::$projectName
Used for caching the project name.
- $pushedButton
- in file Cartoclient.php, variable CartoForm::$pushedButton
- APPLICATION
- in file ClientPlugin.php, class constant ToolDescription::APPLICATION
- pixel2Coord
- in file HttpRequestHandler.php, method PixelCoordsConverter::pixel2Coord()
Computes pixel to geographical coordinates transformation
- PixelCoordsConverter
- in file HttpRequestHandler.php, class PixelCoordsConverter
Converter from pixel to geographical coordinates
- PluginEnabler
- in file AjaxHelper.php, class PluginEnabler
Abstraction class for defining plugins' enable level
- point2Coords
- in file HttpRequestHandler.php, method PixelCoordsConverter::point2Coords()
Converts a point coordinates from pixel to geographical.
- prepareAjax
- in file Cartoclient.php, method Cartoclient::prepareAjax()
Prepares the AJAX mode by setting plugins enable level according the given ajaxAction.
- processResource
- in file Views.php, method ViewDbContainer::processResource()
- processResource
- in file Views.php, method ViewContainer::processResource()
Processes (read/write) content of storage resource.
- processResource
- in file Views.php, method ViewFileContainer::processResource()
top
top
r
- $renderKeymap
- in file ExportPlugin.php, variable ExportConfiguration::$renderKeymap
- $renderMap
- in file ExportPlugin.php, variable ExportConfiguration::$renderMap
- $renderScalebar
- in file ExportPlugin.php, variable ExportConfiguration::$renderScalebar
- $request
- in file ClientPlugin.php, variable FilterRequestModifier::$request
- $resolution
- in file ExportPlugin.php, variable ExportConfiguration::$resolution
- $resourceHandler
- in file Cartoclient.php, variable Cartoclient::$resourceHandler
- $rtf
- in file ClientExportRtf.php, variable ClientExportRtf::$rtf
- PROJECT_ENV_VAR
- in file ClientProjectHandler.php, class constant ClientProjectHandler::PROJECT_ENV_VAR
Environment variable which contains project name
- PROJECT_REQUEST
- in file ClientProjectHandler.php, class constant ClientProjectHandler::PROJECT_REQUEST
Request name which contains the project name
- readCatalog
- in file Views.php, method ViewContainer::readCatalog()
Reads views catalog content.
- readCatalog
- in file Views.php, method ViewDbContainer::readCatalog()
- readCatalog
- in file Views.php, method ViewFileContainer::readCatalog()
- readXmlContent
- in file Views.php, method ViewFileContainer::readXmlContent()
Reads XML content and assigns view info.
- remove
- in file Views.php, method ViewUpgrader::remove()
Removes given property.
- rename
- in file Views.php, method ViewUpgrader::rename()
Updates name of property.
- render
- in file FormRenderer.php, method FormRenderer::render()
- renderForm
- in file ClientExportRtf.php, method ClientExportRtf::renderForm()
- renderForm
- in file ClientPlugin.php, method GuiProvider::renderForm()
Manages form output rendering
- render_rtf
- in file ClientExportRtf.php, method ClientExportRtf::render_rtf()
Returns an RTF string containing the map and other choosen data
top
s
- $scale
- in file ExportPlugin.php, variable ExportConfiguration::$scale
- $selectedTool
- in file Cartoclient.php, variable ClientSession::$selectedTool
Tool currently selected
- $sessionCacheLocation
- in file Views.php, variable ViewManager::$sessionCacheLocation
- $sessionData
- in file Views.php, variable ViewUpgrader::$sessionData
- $sessionName
- in file Cartoclient.php, variable Cartoclient::$sessionName
- $showDevMsg
- in file Views.php, variable ViewDbContainer::$showDevMsg
- $showRefMarks
- in file ExportPlugin.php, variable ExportConfiguration::$showRefMarks
- $smarty
- in file FormRenderer.php, variable FormRenderer::$smarty
- $specialOutput
- in file FormRenderer.php, variable FormRenderer::$specialOutput
- $stateless
- in file ClientPlugin.php, variable ToolDescription::$stateless
- $storage
- in file Views.php, variable ViewUpgrader::$storage
- $switchId
- in file ExportPlugin.php, variable ExportConfiguration::$switchId
- Smarty_Cartoclient.php
- procedural page Smarty_Cartoclient.php
- ServerMapInfoCache.php
- procedural page ServerMapInfoCache.php
- saveSession
- in file Cartoclient.php, method Cartoclient::saveSession()
Saves session data in a different container for each mapId
- saveSession
- in file ClientPlugin.php, method Sessionable::saveSession()
Saves session data
- saveSessionHelper
- in file ClientPluginHelper.php, method SessionableHelper::saveSessionHelper()
Gets plugin's session data and save it
- select
- in file Views.php, method ViewContainer::select()
Wrapper for 'select' action.
- serialize
- in file AjaxHelper.php, method Json::serialize()
Serializes a PHP variable to a Javascript variable representation
- ServerCaller
- in file ClientPlugin.php, class ServerCaller
Interface for plugins that may call server
- ServerCallerHelper
- in file ClientPluginHelper.php, class ServerCallerHelper
Helper for ServerCaller
- Sessionable
- in file ClientPlugin.php, class Sessionable
Interface for plugins with session data
- SessionableHelper
- in file ClientPluginHelper.php, class SessionableHelper
Helper for Sessionable
- setAjaxAction
- in file Cartoclient.php, method Cartoclient::setAjaxAction()
Sets the current AJAX action
- setBbox
- in file ExportPlugin.php, method ExportConfiguration::setBbox()
- setClientSession
- in file Cartoclient.php, method Cartoclient::setClientSession()
- setContents
- in file ExportPlugin.php, method ExportOutput::setContents()
Sets contents
- setCustomForm
- in file FormRenderer.php, method FormRenderer::setCustomForm()
Sets a different template resource to be used for display. If false, the Smarty display will be skipped. This is needed if a plugin does the html output on its own.
- setCustomTitle
- in file FormRenderer.php, method FormRenderer::setCustomTitle()
Sets a different title
- setEnableLevel
- in file ClientPlugin.php, method ClientPlugin::setEnableLevel()
Sets the enable level (to be used with the AJAX mode).
- setEnableLevel
- in file AjaxHelper.php, method PluginEnabler::setEnableLevel()
Sets the enable level of the given plugin name to the given enable level value.
- setFile
- in file ExportPlugin.php, method ExportOutput::setFile()
Sets file name and path
- setInterruptFlow
- in file Cartoclient.php, method Cartoclient::setInterruptFlow()
Tells the Cartoclient that the normal control flow has to be interrupted.
- setLayerIds
- in file ExportPlugin.php, method ExportConfiguration::setLayerIds()
- setLocale
- in file Internationalization.php, method I18n::setLocale()
Sets the locale depending on URL, browser or config
- setLocationType
- in file ExportPlugin.php, method ExportConfiguration::setLocationType()
- setMapAngle
- in file ExportPlugin.php, method ExportConfiguration::setMapAngle()
- setMapHeight
- in file ExportPlugin.php, method ExportConfiguration::setMapHeight()
- setMapWidth
- in file ExportPlugin.php, method ExportConfiguration::setMapWidth()
- setMetasFromRequest
- in file Views.php, method ViewManager::setMetasFromRequest()
Sets metadata from request.
- setOutputType
- in file Cartoclient.php, method Cartoclient::setOutputType()
Set the current output type (pdf, csv, html, etc.).
- setPoint
- in file ExportPlugin.php, method ExportConfiguration::setPoint()
- setPreventSaveSession
- in file Cartoclient.php, method Cartoclient::setPreventSaveSession()
Activate session bypass
- setPrintOutline
- in file ExportPlugin.php, method ExportConfiguration::setPrintOutline()
- setQueryBbox
- in file ExportPlugin.php, method ExportConfiguration::setQueryBbox()
- setQuerySelections
- in file ExportPlugin.php, method ExportConfiguration::setQuerySelections()
- setRenderKeymap
- in file ExportPlugin.php, method ExportConfiguration::setRenderKeymap()
- setRenderMap
- in file ExportPlugin.php, method ExportConfiguration::setRenderMap()
- setRenderScalebar
- in file ExportPlugin.php, method ExportConfiguration::setRenderScalebar()
- setRequestHelper
- in file ClientPluginHelper.php, method ServerCallerHelper::setRequestHelper()
Sets plugin's request
- setResolution
- in file ExportPlugin.php, method ExportConfiguration::setResolution()
- setScale
- in file ExportPlugin.php, method ExportConfiguration::setScale()
- setSelectData
- in file Views.php, method ViewContainer::setSelectData()
Sets various data while loading a view.
- setSelectData
- in file Views.php, method ViewDbContainer::setSelectData()
- setShowRefMarks
- in file ExportPlugin.php, method ExportConfiguration::setShowRefMarks()
- setSpecialOutput
- in file FormRenderer.php, method FormRenderer::setSpecialOutput()
Sets special output to display in addition of standard output.
- setSwitchId
- in file ExportPlugin.php, method ExportConfiguration::setSwitchId()
- setValue
- in file ClientPlugin.php, method FilterRequestModifier::setValue()
- setViewId
- in file Views.php, method ViewContainer::setViewId()
Computes next available view ID.
- setWeightMeta
- in file Views.php, method ViewDbContainer::setWeightMeta()
- setWeightMeta
- in file Views.php, method ViewContainer::setWeightMeta()
Updates metadata with weight info and removes viewLocationId info.
- setZoomType
- in file ExportPlugin.php, method ExportConfiguration::setZoomType()
- showAjaxPluginResponse
- in file FormRenderer.php, method FormRenderer::showAjaxPluginResponse()
Polls and displays all Ajaxable plugins responses,
- showFailure
- in file FormRenderer.php, method FormRenderer::showFailure()
Displays failure using failure.tpl Smarty templates
- showForm
- in file FormRenderer.php, method FormRenderer::showForm()
Displays GUI using cartoclient.tpl Smarty template
- smartyResource
- in file Smarty_Cartoclient.php, method Smarty_Cartoclient::smartyResource()
Smarty block function for resources
- smartyTranslate
- in file Smarty_Cartoclient.php, method Smarty_Cartoclient::smartyTranslate()
Smarty block function, provides gettext support for Smarty
- smartyTranslateModifier
- in file Smarty_Cartoclient.php, method Smarty_Cartoclient::smartyTranslateModifier()
Smarty modifier function, provides gettext support for Smarty
- Smarty_Cartoclient
- in file Smarty_Cartoclient.php, class Smarty_Cartoclient
Specific Smarty engine for Cartoclient
- Smarty_Plugin
- in file Smarty_Cartoclient.php, class Smarty_Plugin
Specific Smarty engine for plugins
- SoapFaultWrapper
- in file CartoserverService.php, class SoapFaultWrapper
This class extends SoapFault and adds a toString() method.
- strarg
- in file Smarty_Cartoclient.php, method Smarty_Cartoclient::strarg()
Replace arguments in a string with their values
top
top
u
- BUTTON_APPLICATION
- in file Cartoclient.php, class constant CartoForm::BUTTON_APPLICATION
- BUTTON_KEYMAP
- in file Cartoclient.php, class constant CartoForm::BUTTON_KEYMAP
- BUTTON_MAINMAP
- in file Cartoclient.php, class constant CartoForm::BUTTON_MAINMAP
- BUTTON_NONE
- in file Cartoclient.php, class constant CartoForm::BUTTON_NONE
- CURRENT_PROJECT_FILE
- in file ClientProjectHandler.php, class constant ClientProjectHandler::CURRENT_PROJECT_FILE
Current project filename
- OUTPUT_HTML_VIEWER
- in file Cartoclient.php, class constant Cartoclient::OUTPUT_HTML_VIEWER
Output formats constants.
- OUTPUT_IMAGE
- in file Cartoclient.php, class constant Cartoclient::OUTPUT_IMAGE
- unlockResource
- in file Views.php, method ViewContainer::unlockResource()
Unlocks access to storage resource.
- unlockResource
- in file Views.php, method ViewFileContainer::unlockResource()
- unlockResource
- in file Views.php, method ViewDbContainer::unlockResource()
- unserializeInit
- in file ClientPluginHelper.php, method InitUserHelper::unserializeInit()
Unserializes init object specific to plugin
- update
- in file Views.php, method ViewContainer::update()
Wrapper for 'update' action.
- updateCatalog
- in file Views.php, method ViewContainer::updateCatalog()
Adds new/updated view in views catalog.
- updateMetasList
- in file Views.php, method ViewDbContainer::updateMetasList()
Removes/adds some metas titles.
- updateTool
- in file ClientPluginHelper.php, method ToolProviderHelper::updateTool()
Updates tools info plugin name and weight
- upgrade
- in file Views.php, method ViewUpgrader::upgrade()
Upgrades given plugin storage.
- upgrade
- in file Views.php, method ViewFilter::upgrade()
Tries to upgrade view data format.
top
v
- $variables
- in file AjaxHelper.php, variable AjaxPluginResponse::$variables
- $viewablePlugins
- in file Views.php, variable ViewManager::$viewablePlugins
- $viewFilter
- in file Views.php, variable ViewUpgrader::$viewFilter
- $viewId
- in file Views.php, variable ViewContainer::$viewId
- $viewId
- in file Views.php, variable ViewManager::$viewId
- $viewManager
- in file Cartoclient.php, variable Cartoclient::$viewManager
- $viewOn
- in file Cartoclient.php, variable Cartoclient::$viewOn
Indicates if a view is to be processed.
- $viewPath
- in file Views.php, variable ViewFileContainer::$viewPath
- $viewsEnable
- in file Cartoclient.php, variable Cartoclient::$viewsEnable
Indicates if views device is activated.
- Views.php
- procedural page Views.php
- ViewContainer
- in file Views.php, class ViewContainer
Views recording/loading.
- ViewDbContainer
- in file Views.php, class ViewDbContainer
Views recording/loading to/from database.
- ViewFileContainer
- in file Views.php, class ViewFileContainer
Views recording/loading to/from file.
- ViewFilter
- in file Views.php, class ViewFilter
Views writing/reading filters
- ViewHooks
- in file Views.php, class ViewHooks
Extendable class providing various project-specific hooks in views processing.
- ViewManager
- in file Views.php, class ViewManager
Global views management.
- ViewUpgrader
- in file Views.php, class ViewUpgrader
Basis of views upgrade filters
top
w
- $wc
- in file Views.php, variable ViewManager::$wc
- $weight
- in file Views.php, variable ViewContainer::$weight
- $weight
- in file ClientPlugin.php, variable ToolDescription::$weight
- $wf
- in file Views.php, variable ViewManager::$wf
- $wh
- in file Views.php, variable ViewManager::$wh
- $writeActions
- in file Views.php, variable ViewContainer::$writeActions
- writeCatalog
- in file Views.php, method ViewDbContainer::writeCatalog()
- writeCatalog
- in file Views.php, method ViewContainer::writeCatalog()
Writes views catalog content.
- writeCatalog
- in file Views.php, method ViewFileContainer::writeCatalog()
- writeXmlContent
- in file Views.php, method ViewFileContainer::writeXmlContent()
Writes an XML string containing the view data and metadata.
top
top
|
|
