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


Files:
AjaxHelper.php
Cartoclient.php
CartoserverService.php
ClientMapInfoCache.php
ClientPlugin.php
ClientPluginHelper.php
ClientProjectHandler.php
ExportPlugin.php
FormRenderer.php
HttpRequestHandler.php
Internationalization.php
MapInfoCache.php
ServerMapInfoCache.php
Smarty_Cartoclient.php
Views.php

Classes:
Ajaxable
AjaxException
AjaxPluginResponse
Cartoclient
CartoclientException
CartoForm
CartoserverService
ClientAccountingImpl
ClientConfig
ClientExportRtf
ClientMapInfoCache
ClientPlugin
ClientPluginConfig
ClientPluginHelper
ClientProjectHandler
ClientSession
DhtmlSelectionParser
EncoderInterface
EncoderISO
EncoderUTF
Exportable
ExportConfiguration
ExportOutput
ExportPlugin
FilterProvider
FilterRequestModifier
FormRenderer
GuiProvider
HttpRequestHandler
I18n
I18nDummy
I18nGettext
I18nInterface
InitUser
InitUserHelper
Json
PixelCoordsConverter
PluginEnabler
ServerCaller
ServerCallerHelper
Sessionable
SessionableHelper
Smarty_Cartoclient
Smarty_Plugin
SoapFaultWrapper
ToolDescription
ToolProvider
ToolProviderHelper
ViewContainer
ViewDbContainer
ViewFileContainer
ViewFilter
ViewHooks
ViewManager
ViewUpgrader

Class: CartoserverService

Source Location: /client/CartoserverService.php

Class Overview




Wrapper for server calls














Variables







Methods
























Class Details



[line 60]

Wrapper for server calls

Hides the calling method (direct or SOAP) from the client.





[ Top ]







Class Variables



	
	

	
$cartoserver = 

	
[line 75]

  



Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      Cartoserver
    

      

	



	
[ Top ]


	
	

	
$config = 

	
[line 70]

  



Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      ClientConfig
    

      

	



	
[ Top ]


	
	

	
$log = 

	
[line 65]

  



Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      Logger
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor __construct [line 81]

	

    

    

		CartoserverService __construct(
ClientConfig
$config)
    

    


	
		Constructor





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        ClientConfig  
        $config  
        
      

        

    


        
[ Top ]

  

  

	
	
method callDirect [line 92]

	

    

    

		mixed callDirect(
string
$function, mixed
$argument)
    

    


	
		Calls function using direct mode





Tags:





  

    return:  function result
  

  

    access:  private
  










        
Parameters:

    

    

          

        string  
        $function  
        function name
      

          

        mixed  
        $argument  
        argument
      

        

    


        
[ Top ]

  

  

	
	
method callFunction [line 162]

	

    

    

		mixed callFunction(
string
$function, mixed
$argument, [boolean
$replayTrace = false])
    

    


	
		Calls a function using either direct or SOAP mode

In case of SOAP mode: 
  • Calls using WSDL or not depending on configuration
  • Unserializes result
  • Generates a understandable message in case of error





Tags:





  

    return:  function result
  

  

    access:  private
  










        
Parameters:

    

    

          

        string  
        $function  
        function name
      

          

        mixed  
        $argument  
        argument
      

          

        boolean  
        $replayTrace  
        if true, retrieves trace in case of error
      

        

    


        
[ Top ]

  

  

	
	
method getCartoserver [line 118]

	

    

    

		Cartoserver getCartoserver(
)
    

    


	
		Returns Cartoserver object, creates it if needed





Tags:





  

    return:  Cartoserver object
  

  

    access:  private
  










        
[ Top ]

  

  

	
	
method getCartoserverUrl [line 131]

	

    

    

		string getCartoserverUrl(
string
$script)
    

    


	
		Constructs Cartoserver URL depending on configuration base URL





Tags:





  

    return:  url
  

  

    access:  private
  










        
Parameters:

    

    

          

        string  
        $script  
        the script to call (typically server.php or  cartoserver.wsdl.php)
      

        

    


        
[ Top ]

  

  

	
	
method getMap [line 232]

	

    

    

		MapResult getMap(
MapRequest
$mapRequest)
    

    


	
		Retrieves MapResult from server





Tags:





  

    return:  MapResult returned by server
  

  

    access:  public
  










        
Parameters:

    

    

          

        MapRequest  
        $mapRequest  
        map request
      

        

    


        
[ Top ]

  

  

	
	
method getMapInfo [line 223]

	

    

    

		MapInfo getMapInfo(
string
$mapId)
    

    


	
		Retrieves MapInfo from server





Tags:





  

    return:  MapInfo returned by server
  

  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $mapId  
        mapId
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Fri, 21 Sep 2007 13:30:32 +0200 by phpDocumentor 1.3.0RC3