Server
[ class tree: Server ] [ index: Server ] [ all elements ]

Class: ServerContext

Source Location: /server/ServerContext.php

Class Overview




Variables

Methods



Class Details

[line 45]


[ Top ]


Class Variables

$config =

[line 100]



Tags:

access:  private

Type:   ServerConfig


[ Top ]

$globalMap =  false

[line 136]

If true, complete mapfile is used, if false, switch mapfile is used



Tags:

access:  public

Type:   boolean


[ Top ]

$imageType =

[line 70]



Tags:

access:  private

Type:   int


[ Top ]

$log =

[line 50]



Tags:

access:  private

Type:   Logger


[ Top ]

$mapId =

[line 55]



Tags:

access:  private

Type:   string


[ Top ]

$mapInfo =

[line 80]



Tags:

access:  private

Type:   MapInfo


[ Top ]

$mapInfoHandler =

[line 85]



Tags:

access:  private

Type:   MapInfoHandler


[ Top ]

$mapRequest =

[line 90]



Tags:

access:  private

Type:   MapRequest


[ Top ]

$mapResult =

[line 95]



Tags:

access:  private

Type:   MapResult


[ Top ]

$mapscriptLoaded =

[line 130]



Tags:

var:  True when mapscript module has beed loaded
access:  private

Type:   boolean


[ Top ]

$maxExtent =

[line 65]



Tags:

var:  RectObj
access:  private

Type:   Mapscript


[ Top ]

$messages = array()

[line 105]



Tags:

access:  private

Type:   array


[ Top ]

$msMainmapImage =

[line 75]



Tags:

var:  ImageObj
access:  private

Type:   Mapscript


[ Top ]

$msMapObj =

[line 60]



Tags:

var:  MapObj
access:  private

Type:   Mapscript


[ Top ]

$pluginManager =

[line 125]



Tags:

access:  private

Type:   PluginManager


[ Top ]

$plugins =

[line 120]



Tags:

access:  private

Type:   array


[ Top ]

$projectHandler =

[line 110]



Tags:

access:  private

Type:   ProjectHandler


[ Top ]

$resourceHandler =

[line 115]



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 213]

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 400]

void checkMsErrors( )

Throws an exception if Mapserver errors are detected.



Tags:

access:  public


[ Top ]

method getConfig [line 442]

ServerConfig getConfig( )



Tags:

access:  public


[ Top ]

method getCorePluginNames [line 450]

array getCorePluginNames( )

Returns list of coreplugins names.



Tags:

access:  private


[ Top ]

method getIdAttribute [line 546]

string getIdAttribute( string $layerId)

Returns the default id attribute for given layer.



Tags:

access:  public


Parameters:

string   $layerId   layer id

[ Top ]

method getIdAttributeString [line 521]

string getIdAttributeString( string $layerId)

Returns Mapserver id_attribute_string for given layer.



Tags:

access:  private


Parameters:

string   $layerId   layer id

[ Top ]

method getIdAttributeType [line 561]

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 359]

int getImageType( )



Tags:

access:  public


[ Top ]

method getMapId [line 167]

string getMapId( )

Returns the current mapId.



Tags:

access:  public


[ Top ]

method getMapInfo [line 376]

MapInfo getMapInfo( )



Tags:

access:  public


[ Top ]

method getMapInfoHandler [line 366]

MapInfoHandler getMapInfoHandler( )



Tags:

access:  public


[ Top ]

method getMapIniPath [line 268]

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 313]

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 235]

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 421]

MapRequest getMapRequest( )



Tags:

access:  public


[ Top ]

method getMapResult [line 435]

MapResult getMapResult( )



Tags:

access:  public


[ Top ]

method getMaxExtent [line 352]

Mapscript getMaxExtent( )



Tags:

return:  RectObj
access:  public


[ Top ]

method getMessages [line 224]

array getMessages( )

Returns messages list.



Tags:

access:  public


[ Top ]

method getMsMainmapImage [line 190]

Mapscript getMsMainmapImage( )



Tags:

return:  ImageObj
access:  public


[ Top ]

method getPluginManager [line 488]

PluginManager getPluginManager( )

Returns the plugin manager



Tags:

access:  public


[ Top ]

method getProjectHandler [line 496]

ProjectHandler getProjectHandler( )

Returns the project handler



Tags:

access:  public


[ Top ]

method getResourceHandler [line 504]

ResourceHandler getResourceHandler( )

Returns the resource handler



Tags:

access:  public


[ Top ]

method getTimestamp [line 281]

int getTimestamp( )

Returns mean (mapfile & INI file) modification time.



Tags:

access:  public


[ Top ]

method isDevelMessagesEnabled [line 200]

boolean isDevelMessagesEnabled( )

Tells (from INI file) if developpers messages must be shown.



Tags:

access:  public


[ Top ]

method loadPlugins [line 459]

void loadPlugins( )

Loads the server plugins.



Tags:

access:  public


[ Top ]

method reset [line 174]

void reset( )

Resets map result object.



Tags:

access:  public


[ Top ]

method resetMsErrors [line 386]

void resetMsErrors( )

Clears lists of Mapserver errors.



Tags:

access:  public


[ Top ]

method setMapRequest [line 428]

void setMapRequest( MapRequest $mapRequest)



Tags:

access:  public


Parameters:

MapRequest   $mapRequest  

[ Top ]

method setMsMainmapImage [line 183]

void setMsMainmapImage( Mapscript $msMainmapImage)



Tags:

access:  public


Parameters:

Mapscript   $msMainmapImage   ImageObj

[ Top ]

method updateStateFromMapObj [line 294]

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, 11 Nov 2005 11:00:13 +0000 by phpDocumentor 1.3.0RC3