constructor __construct [line 378]
Cartoclient __construct(
)
|
|
Constructor
Initializes:
- Project handler
- MapInfo cache
- Client objects
- Session
Plugins cannot call internationalization functions in constructor and in preInitialize().
Tags:
method addMessage [line 606]
void addMessage(
string
$message, [int
$channel = Message::CHANNEL_USER])
|
|
Adds a message to the list of message to display to the user
Tags:
Parameters:
method areViewsEnable [line 632]
boolean areViewsEnable(
)
|
|
Tells if views are enabled in configuration.
Tags:
method callEnabledPluginImplementing [line 724]
void callEnabledPluginImplementing(
int
$enableLevel, string
$pluginName, string
$interface, string
$functionName)
|
|
Calls a given $pluginName implementing an interface if its enable level is equal or higher than the given $enableLevel Interfaces are declared in
ClientPlugin.
Tags:
Parameters:
method callEnabledPluginsImplementing [line 705]
void callEnabledPluginsImplementing(
int
$enableLevel, string
$interface, string
$functionName)
|
|
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.
Tags:
Parameters:
method callPluginsImplementing [line 687]
void callPluginsImplementing(
string
$interface, string
$functionName)
|
|
Calls plugins implementing an interface
Interfaces are declared in ClientPlugin.
Tags:
Parameters:
method clientAllowed [line 985]
Returns whether the current user has privileges to access cartoweb. It
reads the securityAllowedRoles variable in client.ini
Tags:
method doExport [line 1159]
string doExport(
ExportPlugin
$plugin)
|
|
Alternative processing of doMain() when exporting data.
Tags:
Parameters:
method doMain [line 1006]
Main method
- Plugins initialization
- HTTP request handling
- Map request construction
- Server call
- Result handling
- Display
- Session save
Tags:
method getAjaxAction [line 567]
Returns the requested AJAX action
Tags:
method getCartoForm [line 480]
method getCartoserverService [line 522]
method getClientSession [line 494]
method getClientVersion [line 590]
array getClientVersion(
)
|
|
Returns CartoWeb version and revision strings of the Cartoclient
Tags:
method getConfig [line 452]
method getCorePluginNames [line 582]
array getCorePluginNames(
)
|
|
Returns the names of core plugins
Tags:
Overrides
Cartocommon::getCorePluginNames() (Returns the names of core plugins shared by client and server)
method getFormRenderer [line 515]
method getHttpRequestHandler [line 501]
method getInitialMapState [line 873]
Retrieves initialMapState data depending on detected initialMapStateId.
initialMapStateId is determined using (by order of priority): $_REQUEST, $_ENV, client.ini, auto (first initialMapState found).
Tags:
method getInstance [line 442]
Returns the instance of this class. There is only one during the cartoclient lifetime.
Tags:
method getMapInfo [line 751]
Returns Map Info, get it from cache if not yet set
Tags:
method getMapInfoCache [line 739]
Returns the MapInfoCache
Tags:
method getMapRequest [line 931]
Initializes map request with current mapId
Tags:
method getMapResult [line 487]
method getMapResultFromRequest [line 946]
Calls Cartoserver service to get results
Also checks that MapInfo is up-to-date. If not, MapInfo cache reloads it.
Tags:
Parameters:
method getMessages [line 614]
method getOutputType [line 643]
Returns the current output type (pdf, csv, html, etc.).
Tags:
method getPluginManager [line 508]
method getProjectHandler [line 462]
method getResourceHandler [line 469]
method getSelfUrl [line 977]
Returns current base URL.
Tags:
method getSessionName [line 768]
Builds and returns session name.
Tags:
method getValidExportType [line 1228]
mixed getValidExportType(
)
|
|
Tells if an export plugin is available for current output and returns it.
Tags:
method getViewManager [line 621]
method initializeObjects [line 1205]
void initializeObjects(
)
|
|
Initializes client objects
Initializes:
- Configuration
- I18n
- UTF/ISO Encoding
- Plugins
- Cartoserver service
- HTTP request handler
- Form renderer
Tags:
method initializePlugins [line 666]
void initializePlugins(
)
|
|
Initializes core and normal client plugins
Tags:
method initializeSession [line 839]
void initializeSession(
)
|
|
Initializes session
If the mapId's session is not created yet, it is created and initialized. For creation and reload, plugins are called to manage their session data.
Tags:
method isAjaxMode [line 531]
Tells if the Cartoclient runs in AJAX mode
Tags:
method isInterruptFlow [line 969]
Returns true if the flow of operation has to be interrupted, and the template displayed without calling server.
Tags:
method main [line 1246]
method manageViewsSystem [line 1178]
void manageViewsSystem(
)
|
|
Detects if views controller must be launched.
Tags:
method prepareAjax [line 1125]
void prepareAjax(
string
$ajaxAction)
|
|
Prepares the AJAX mode by setting plugins enable level according the given ajaxAction.
Tags:
Parameters:
method saveSession [line 805]
Saves session data in a different container for each mapId
Tags:
method setAjaxAction [line 539]
string setAjaxAction(
mixed
$ajaxAction)
|
|
Sets the current AJAX action
Tags:
method setClientSession [line 574]
method setInterruptFlow [line 960]
void setInterruptFlow(
boolean
$interruptFlow)
|
|
Tells the Cartoclient that the normal control flow has to be interrupted.
When true, the server will not be called, and the final template drawing step is invoked.
Tags:
Parameters:
method setOutputType [line 651]
void setOutputType(
string
$outputType)
|
|
Set the current output type (pdf, csv, html, etc.).
Tags:
Parameters:
method setPreventSaveSession [line 659]
void setPreventSaveSession(
bool
$preventSaveSession)
|
|
Activate session bypass
Tags:
Parameters:
