Class: ClientImages

Source Location: /coreplugins/images/client/ClientImages.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientImages

Client part of Images plugin

Variables

Constants

Methods

Child classes:

ClientProjectImages

Inherited Variables

Class: ClientPlugin

ClientPlugin::$cartoclient
ClientPlugin::$config

Class: PluginBase

PluginBase::$basePath
PluginBase::$name

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::getCartoclient()
ClientPlugin::getConfig()
ClientPlugin::getHttpValue(): Returns the user-submitted $key data if it is set.
ClientPlugin::initializeConfig(): Initializes plugin configuration

Class: PluginBase

PluginBase::__construct(): Constructor
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::replacePlugin(): Returns name of parent plugin in case of plugin extension
PluginBase::setBasePath()
PluginBase::setExtendedName()
PluginBase::setName()

Class Details

[line 52]
Client part of Images plugin

[ Top ]

Class Variables

$imagesResult =

[line 70]

Last server result

Tags:

access:

private

Type:

ImagesResult

[ Top ]

$imagesState =

[line 64]

Current session state

Tags:

access:

private

Type:

ImagesState

[ Top ]

$log =

[line 58]

Tags:

access:

private

Type:	Logger
Overrides:	Array

[ Top ]

$mapSizes =

[line 76]

Possible map sizes

Tags:

access:

private

Type:

array

[ Top ]

Class Methods

method adjustExportMapRequest [line 355]

void adjustExportMapRequest(
ExportConfiguration
$configuration, MapRequest
$mapRequest)

Tags:

access:	public
see:	Exportable::adjustExportMapRequest()

[ Top ]

method buildMapRequest [line 216]

void buildMapRequest(
mixed
$mapRequest)

Tags:

access:	public
see:	ServerCaller::buildMapRequest()

[ Top ]

method createSession [line 106]

void createSession(
MapInfo
$mapInfo, InitialMapState
$initialMapState)

Tags:

access:	public
see:	Sessionable::createSession()

[ Top ]

constructor __construct [line 91]

ClientImages __construct(
)

Constructor

Tags:

access:

public

Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method drawMapSizes [line 295]

string drawMapSizes(
)

Draws map sizes choice

Tags:

return:	Smarty generated HTML content
access:	private

[ Top ]

method getImageUrl [line 258]

string getImageUrl(
mixed
$path)

Tags:

return:	The URL to the image, as put inside the html template
access:	private

[ Top ]

method getMainmapDimensions [line 170]

Dimension getMainmapDimensions(
)

Returns the dimensions of the main map. It may be used by other plugins.

Tags:

access:

public

[ Top ]

method getMapSizes [line 178]

array getMapSizes(
)

Returns the list of map sizes to display.

Tags:

return:	Array of map sizes (Map with label, with and height keys)
access:	private

[ Top ]

method handleHttpGetRequest [line 162]

void handleHttpGetRequest(
mixed
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpPostRequest()

[ Top ]

method handleHttpPostRequest [line 152]

void handleHttpPostRequest(
mixed
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpPostRequest()

[ Top ]

method handleMapSize [line 124]

void handleMapSize(
array
$request, [boolean
$check = false])

Handles map sizes dropdown box

Tags:

access:

private

Parameters:

array	$request	HTTP request
boolean	$check	checks?

[ Top ]

method handleResult [line 253]

void handleResult(
mixed
$imagesResult)

Tags:

access:	public
see:	ServerCaller::handleResult()

[ Top ]

method initializeResult [line 242]

void initializeResult(
mixed
$imagesResult)

Tags:

access:	public
see:	ServerCaller::initializeResult()

[ Top ]

method initMapSizes [line 268]

array initMapSizes(
)

Reads map sizes from configuration

Tags:

return:	Array of map sizes (Map with label, with and height keys)
access:	private

[ Top ]

method loadSession [line 98]

void loadSession(
mixed
$sessionObject)

Tags:

access:	public
see:	Sessionable::loadSession()

[ Top ]

method renderForm [line 311]

void renderForm(
Smarty
$template)

Tags:

access:	public
see:	GuiProvider::renderForm()

Overridden in child classes as:

ClientProjectImages::renderForm()

[ Top ]

method saveSession [line 347]

void saveSession(
)

Tags:

access:	public
see:	Sessionable::saveSession()

[ Top ]

method setMapDimensions [line 194]

void setMapDimensions(
int
&$mapWidth, int
&$mapHeight)

Sets map width and height

Sets from:

Selected size from predefined list, if config's mapSizesActive = true
Fixed size from config file
Default size

Tags:

access:

private

Parameters:

int	&$mapWidth	width to be set
int	&$mapHeight	height to be set

[ Top ]

Class Constants

DEF_MAP_HEIGHT = 200

[line 86]

Default map height, if not specified in config

[ Top ]

DEF_MAP_WIDTH = 400

[line 81]

Default map width, if not specified in config

[ Top ]

Documentation generated on Wed, 6 Apr 2005 12:06:31 +0200 by phpDocumentor 1.3.0RC3