Server

# Class: ServerContext Source Location: /server/ServerContext.php
### Class Overview
    Cartocommon
       |
       --ServerContext
| ### Variables $config $globalMap $imageType $instance $log $mapId $mapInfo $mapInfoHandler $mapRequest $mapResult $mapscriptLoaded $maxExtent $messages $msMainmapImage $msMapObj $pluginManager $plugins $projectHandler $resourceHandler | ### Methods __construct addMessage checkMsErrors getConfig getCorePluginNames getIdAttribute getIdAttributeString getIdAttributeType getImageType getInstance getMapId getMapInfo getMapInfoHandler getMapIniPath getMapObj getMapPath getMapRequest getMapResult getMaxExtent getMessages getMsMainmapImage getMsVersion getPluginManager getProjectHandler getResourceHandler getTimestamp isDevelMessagesEnabled isMsNewerOrSameThan loadPlugins reset resetMsErrors setMapRequest setMsMainmapImage updateStateFromMapObj
### Inherited Methods #### Class: Cartocommon Cartocommon::getCorePluginNames() Returns the names of core plugins shared by client and server
### Class Details [line 39] [ Top ] ### Class Variables #### $config = [line 94] #### Tags:
access: | private
Type: | ServerConfig
[ Top ] #### $globalMap = false [line 130] If true, complete mapfile is used, if false, switch mapfile is used #### Tags:
access: | public
Type: | boolean
[ Top ] #### $imageType = [line 64] #### Tags:
access: | private
Type: | int
[ Top ] #### $instance = [line 136] Singleton #### Tags:
static: |
access: | private
Type: | ServerContext
[ Top ] #### $log = [line 44] #### Tags:
access: | private
Type: | Logger
[ Top ] #### $mapId = [line 49] #### Tags:
access: | private
Type: | string
[ Top ] #### $mapInfo = [line 74] #### Tags:
access: | private
Type: | MapInfo
[ Top ] #### $mapInfoHandler = [line 79] #### Tags:
access: | private
Type: | MapInfoHandler
[ Top ] #### $mapRequest = [line 84] #### Tags:
access: | private
Type: | MapRequest
[ Top ] #### $mapResult = [line 89] #### Tags:
access: | private
Type: | MapResult
[ Top ] #### $mapscriptLoaded = [line 124] #### Tags:
var: | True when mapscript module has beed loaded
access: | private
Type: | boolean
[ Top ] #### $maxExtent = [line 59] #### Tags:
var: | RectObj
access: | private
Type: | Mapscript
[ Top ] #### $messages = array() [line 99] #### Tags:
access: | private
Type: | array
[ Top ] #### $msMainmapImage = [line 69] #### Tags:
var: | ImageObj
access: | private
Type: | Mapscript
[ Top ] #### $msMapObj = [line 54] #### Tags:
var: | MapObj
access: | private
Type: | Mapscript
[ Top ] #### $pluginManager = [line 119] #### Tags:
access: | private
Type: | PluginManager
[ Top ] #### $plugins = [line 114] #### Tags:
access: | private
Type: | array
[ Top ] #### $projectHandler = [line 104] #### Tags:
access: | private
Type: | ProjectHandler
[ Top ] #### $resourceHandler = [line 109] #### Tags:
access: | private
Type: | ResourceHandler
[ Top ] ### Class Methods ### constructor __construct [line 142]
`ServerContext __construct( string $mapId)`
Constructor #### Tags:
access: | public
#### Parameters:
string | $mapId | map id
[ Top ] ### method addMessage [line 225]
`void addMessage( PluginBase $plugin, string $messageId, string $message, [int $channel = Message::CHANNEL_USER])`
Adds a message to be returned to the client #### Tags:
access: | public
#### Parameters:
PluginBase | $plugin | the plugin attached to this message
string | $messageId | message identifier, for machine message parsing
string | $message | the text of the message
int | $channel | the channel identifier of the message
[ Top ] ### method checkMsErrors [line 418]
`void checkMsErrors( )`
Throws an exception if Mapserver errors are detected. #### Tags:
access: | public
[ Top ] ### method getConfig [line 510]
`ServerConfig getConfig( )`
#### Tags:
access: | public
[ Top ] ### method getCorePluginNames [line 518]
`array getCorePluginNames( )`
Returns list of coreplugins names. #### Tags:
access: | protected
Overrides Cartocommon::getCorePluginNames() (Returns the names of core plugins shared by client and server) [ Top ] ### method getIdAttribute [line 612]
`string getIdAttribute( string $layerId)`
Returns the default id attribute for given layer. #### Tags:
access: | public
#### Parameters:
string | $layerId | layer id
[ Top ] ### method getIdAttributeString [line 587]
`string getIdAttributeString( string $layerId)`
Returns Mapserver id_attribute_string for given layer. #### Tags:
access: | private
#### Parameters:
string | $layerId | layer id
[ Top ] ### method getIdAttributeType [line 627]
`string getIdAttributeType( string $layerId)`
Returns the type of the default attribute. It may be "string" or "integer" #### Tags:
access: | public
#### Parameters:
string | $layerId | layer id
[ Top ] ### method getImageType [line 377]
`int getImageType( )`
#### Tags:
access: | public
[ Top ] ### method getInstance [line 168]
`void getInstance( )`
Returns the instance of this class. There is only one during the ServerContext lifetime. #### Tags:
static: |
access: | public
[ Top ] ### method getMapId [line 179]
`string getMapId( )`
Returns the current mapId. #### Tags:
access: | public
[ Top ] ### method getMapInfo [line 394]
`MapInfo getMapInfo( )`
#### Tags:
access: | public
[ Top ] ### method getMapInfoHandler [line 384]
`MapInfoHandler getMapInfoHandler( )`
#### Tags:
access: | public
[ Top ] ### method getMapIniPath [line 280]
`string getMapIniPath( )`
Returns the file path of the main .ini file of the current mapfile. It has the same location and name as the mapfile being used, but its extension is .ini instead of .map #### Tags:
return: | the location of the .ini file related to the mapfile
access: | public
[ Top ] ### method getMapObj [line 325]
`Mapscript getMapObj( boolean 0)`
Instanciates a new Mapserver MapObj object. If $global is set to false, will use reduced map file depending on plugin layers switch. #### Tags:
return: | MapObj
access: | public
#### Parameters:
boolean | 0 |
[ Top ] ### method getMapPath [line 247]
`string getMapPath( [mixed $global = false])`
Returns mapfile location. If $global is set to false, will use reduced map file depending on plugin layers switch. #### Tags:
access: | public
[ Top ] ### method getMapRequest [line 489]
`MapRequest getMapRequest( )`
#### Tags:
access: | public
[ Top ] ### method getMapResult [line 503]
`MapResult getMapResult( )`
#### Tags:
access: | public
[ Top ] ### method getMaxExtent [line 370]
`Mapscript getMaxExtent( )`
#### Tags:
return: | RectObj
access: | public
[ Top ] ### method getMessages [line 236]
`array getMessages( )`
Returns messages list. #### Tags:
access: | public
[ Top ] ### method getMsMainmapImage [line 202]
`Mapscript getMsMainmapImage( )`
#### Tags:
return: | ImageObj
access: | public
[ Top ] ### method getMsVersion [line 440]
`string getMsVersion( )`
Returns the MapServer version. #### Tags:
access: | public
static: |
[ Top ] ### method getPluginManager [line 554]
`PluginManager getPluginManager( )`
Returns the plugin manager #### Tags:
access: | public
[ Top ] ### method getProjectHandler [line 562]
`ProjectHandler getProjectHandler( )`
Returns the project handler #### Tags:
access: | public
[ Top ] ### method getResourceHandler [line 570]
`ResourceHandler getResourceHandler( )`
Returns the resource handler #### Tags:
access: | public
[ Top ] ### method getTimestamp [line 293]
`int getTimestamp( )`
Returns mean (mapfile & INI file) modification time. #### Tags:
access: | public
[ Top ] ### method isDevelMessagesEnabled [line 212]
`boolean isDevelMessagesEnabled( )`
Tells (from INI file) if developpers messages must be shown. #### Tags:
access: | public
[ Top ] ### method isMsNewerOrSameThan [line 458]
`boolean isMsNewerOrSameThan( string $version)`
Tells if MapServer version is newer or same than the given version. The reference version might only specify the major version (eg. '4') or the major+minor versions (eg. '4.10') or the full version (eg. '4.10.0'). #### Tags:
access: | public
static: |
#### Parameters:
string | $version | version to compare to
[ Top ] ### method loadPlugins [line 525]
`void loadPlugins( )`
Loads the server plugins. #### Tags:
access: | public
[ Top ] ### method reset [line 186]
`void reset( )`
Resets map result object. #### Tags:
access: | public
[ Top ] ### method resetMsErrors [line 404]
`void resetMsErrors( )`
Clears lists of Mapserver errors. #### Tags:
access: | public
[ Top ] ### method setMapRequest [line 496]
`void setMapRequest( MapRequest $mapRequest)`
#### Tags:
access: | public
#### Parameters:
MapRequest | $mapRequest |
[ Top ] ### method setMsMainmapImage [line 195]
`void setMsMainmapImage( Mapscript $msMainmapImage)`
#### Tags:
access: | public
#### Parameters:
Mapscript | $msMainmapImage | ImageObj
[ Top ] ### method updateStateFromMapObj [line 306]
`void updateStateFromMapObj( )`
Update the ServerContext internal state, from the mapscript MapObj object. This concerns the state that is updated once, when the MapObj has just been created. #### Tags:
access: | public
[ Top ] Documentation generated on Fri, 21 Sep 2007 13:31:02 +0200 by phpDocumentor 1.3.0RC3