Server
[ class tree: Server ] [ index: Server ] [ all elements ]
Packages:
Client
Common
CorePlugins
Plugins
Scripts
Server
Tests


Files:
Cartoserver.php
Encoding.php
MapInfoHandler.php
MapResultCache.php
ServerContext.php
ServerPlugin.php
ServerPluginHelper.php
SoapXMLCache.php

Classes:
Cartoserver
CartoserverException
ClientResponder
ClientResponderAdapter
ClientResponderHelper
CoreProvider
CoreProviderHelper
Encoder
InitProvider
InitProviderHelper
MapInfoHandler
MapResultCache
ServerConfig
ServerContext
ServerMapInfoCache
ServerPlugin
ServerPluginConfig
ServerPluginHelper
SoapXMLCache

Class: ServerContext

Source Location: /server/ServerContext.php

Class Overview


















Variables







Methods
























Class Details



[line 39]






[ Top ]







Class Variables



	
	

	
$config = 

	
[line 94]

  



Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      ServerConfig
    

      

	



	
[ Top ]


	
	

	
$imageType = 

	
[line 64]

  



Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      int
    

      

	



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


	
	

	
$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 125]

	

    

    

		ServerContext __construct(
string
$mapId)
    

    


	
		Constructor





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $mapId  
        map id
      

        

    


        
[ Top ]

  

  

	
	
method addMessage [line 194]

	

    

    

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

	

    

    

		void checkMsErrors(
)
    

    


	
		Throws an exception if Mapserver errors are detected.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getConfig [line 383]

	

    

    

		ServerConfig getConfig(
)
    

    


	
		



Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getCorePluginNames [line 391]

	

    

    

		array getCorePluginNames(
)
    

    


	
		Returns list of coreplugins names.





Tags:





  

    access:  private
  










        
[ Top ]

  

  

	
	
method getIdAttribute [line 484]

	

    

    

		string getIdAttribute(
string
$layerId)
    

    


	
		Returns the default id attribute for given layer.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $layerId  
        layer id
      

        

    


        
[ Top ]

  

  

	
	
method getIdAttributeString [line 462]

	

    

    

		string getIdAttributeString(
string
$layerId)
    

    


	
		Returns Mapserver id_attribute_string for given layer.





Tags:





  

    access:  private
  










        
Parameters:

    

    

          

        string  
        $layerId  
        layer id
      

        

    


        
[ Top ]

  

  

	
	
method getIdAttributeType [line 499]

	

    

    

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

	

    

    

		int getImageType(
)
    

    


	
		



Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getMapId [line 150]

	

    

    

		string getMapId(
)
    

    


	
		Returns the current mapId.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getMapInfo [line 317]

	

    

    

		MapInfo getMapInfo(
)
    

    


	
		



Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getMapInfoHandler [line 307]

	

    

    

		MapInfoHandler getMapInfoHandler(
)
    

    


	
		



Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getMapIniPath [line 227]

	

    

    

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

	

    

    

		Mapscript getMapObj(
)
    

    


	
		Instanciates a new Mapserver MapObj object.





Tags:





  

    return:  MapObj
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getMapPath [line 213]

	

    

    

		string getMapPath(
)
    

    


	
		Returns mapfile location.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getMapRequest [line 362]

	

    

    

		MapRequest getMapRequest(
)
    

    


	
		



Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getMapResult [line 376]

	

    

    

		MapResult getMapResult(
)
    

    


	
		



Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getMaxExtent [line 293]

	

    

    

		Mapscript getMaxExtent(
)
    

    


	
		



Tags:





  

    return:  RectObj
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getMessages [line 205]

	

    

    

		array getMessages(
)
    

    


	
		Returns messages list.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getMsMainmapImage [line 171]

	

    

    

		Mapscript getMsMainmapImage(
)
    

    


	
		



Tags:





  

    return:  ImageObj
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getPluginManager [line 429]

	

    

    

		PluginManager getPluginManager(
)
    

    


	
		Returns the plugin manager





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getProjectHandler [line 437]

	

    

    

		ProjectHandler getProjectHandler(
)
    

    


	
		Returns the project handler





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getResourceHandler [line 445]

	

    

    

		ResourceHandler getResourceHandler(
)
    

    


	
		Returns the resource handler





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getTimestamp [line 240]

	

    

    

		int getTimestamp(
)
    

    


	
		Returns mean (mapfile & INI file) modification time.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method isDevelMessagesEnabled [line 181]

	

    

    

		boolean isDevelMessagesEnabled(
)
    

    


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





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method loadPlugins [line 400]

	

    

    

		void loadPlugins(
)
    

    


	
		Loads the server plugins.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method reset [line 157]

	

    

    

		void reset(
)
    

    


	
		Resets map result object.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method resetMsErrors [line 327]

	

    

    

		void resetMsErrors(
)
    

    


	
		Clears lists of Mapserver errors.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method setMapRequest [line 369]

	

    

    

		void setMapRequest(
MapRequest
$mapRequest)
    

    


	
		



Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        MapRequest  
        $mapRequest  
        
      

        

    


        
[ Top ]

  

  

	
	
method setMsMainmapImage [line 164]

	

    

    

		void setMsMainmapImage(
Mapscript
$msMainmapImage)
    

    


	
		



Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        Mapscript  
        $msMainmapImage  
        ImageObj
      

        

    


        
[ Top ]

  

  

	
	
method updateStateFromMapObj [line 253]

	

    

    

		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 Wed,  6 Apr 2005 12:06:56 +0200 by phpDocumentor 1.3.0RC3