XML_RPC2
[ class tree: XML_RPC2 ] [ index: XML_RPC2 ] [ all elements ]
Packages:
XML_RPC2


Classes:
XML_RPC2_Backend
XML_RPC2_Backend_Php_Client
XML_RPC2_Backend_Php_Request
XML_RPC2_Backend_Php_Response
XML_RPC2_Backend_Php_Server
XML_RPC2_Backend_Php_Value
XML_RPC2_Backend_Php_Value_Array
XML_RPC2_Backend_Php_Value_Base64
XML_RPC2_Backend_Php_Value_Boolean
XML_RPC2_Backend_Php_Value_Datetime
XML_RPC2_Backend_Php_Value_Double
XML_RPC2_Backend_Php_Value_Integer
XML_RPC2_Backend_Php_Value_Scalar
XML_RPC2_Backend_Php_Value_String
XML_RPC2_Backend_Php_Value_Struct
XML_RPC2_Backend_Xmlrpcext_Client
XML_RPC2_Backend_Xmlrpcext_Server
XML_RPC2_Backend_Xmlrpcext_Value
XML_RPC2_CachedClient
XML_RPC2_CachedServer
XML_RPC2_Client
XML_RPC2_CurlException
XML_RPC2_DecodeException
XML_RPC2_EncodeException
XML_RPC2_Exception
XML_RPC2_FaultException
XML_RPC2_InvalidDateFormatException
XML_RPC2_InvalidDebugException
XML_RPC2_InvalidPrefixException
XML_RPC2_InvalidSslverifyException
XML_RPC2_InvalidTypeEncodeException
XML_RPC2_InvalidUriException
XML_RPC2_ReceivedInvalidStatusCodeException
XML_RPC2_Server
XML_RPC2_Server_CallHandler
XML_RPC2_Server_Callhandler_Class
XML_RPC2_Server_Callhandler_Instance
XML_RPC2_Server_Method
XML_RPC2_TransportException
XML_RPC2_UnknownMethodException
XML_RPC2_Util_HTTPRequest
XML_RPC2_Value
XML_RPC2
   XML_RPC2_InvalidTypeException
Files:
Array.php
Backend.php
Base64.php
Boolean.php
CachedClient.php
CachedServer.php
CallHandler.php
Class.php
Client.php
Client.php
Client.php
Datetime.php
Double.php
Exception.php
HTTPRequest.php
Instance.php
Integer.php
Method.php
Request.php
Response.php
Scalar.php
Server.php
Server.php
Server.php
String.php
Struct.php
Value.php
Value.php
Value.php

Class: XML_RPC2_CachedClient

Source Location: /XML_RPC2-1.0.5/XML/RPC2/CachedClient.php

Class Overview




XML_RPC "cached client" class.




Author(s):






          
          


Copyright:


    
  
  • 2005-2006 Fabien MARTY
    • 








Methods
















Inherited Variables





Inherited Methods














Class Details



[line 57]

XML_RPC "cached client" class.









[ Top ]








Method Detail



	
	
__construct (Constructor)   [line 156]

	

    

    

		XML_RPC2_CachedClient __construct(
string
$uri, [array
$options = array()])
    

    


	
		Constructor
TODO : documentations about cache options


    

  • Access: protected
    • 








        
Parameters:

    

    

          

        string  
        $uri  
        —
          URI for the XML-RPC server
      

          

        array  
        $options  
        —
          (optional) Associative array of options
      

        

    


        
[ Top ]

  

  
  
	
	
clean___   [line 354]

	

    

    

		void clean___(
)
    

    


	
		Clean all the cache
NB : The '___' at the end of the method name is to avoid collisions with  XMLRPC __call()


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
create   [line 210]

	

    

    

		void create(
string
$uri, [string
$options = array()], string
2)
    

    


	
		"Emulated Factory" method to get the same API than XML_RPC2_Client class
Here, simply returns a new instance of XML_RPC2_CachedClient class


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        2  
        —
          (optional)  Proxy server URI (defaults to no proxy)
      

          

        string  
        $uri  
        —
          URI for the XML-RPC server
      

          

        string  
        $options  
        —
          (optional)  Prefix to prepend on all called functions (defaults to '')
      

        

    


        
[ Top ]

  

  
  
	
	
dropCacheFile___   [line 339]

	

    

    

		void dropCacheFile___(
string
$methodName, array
$parameters)
    

    


	
		Drop the cache file corresponding to the given method call
NB : The '___' at the end of the method name is to avoid collisions with  XMLRPC __call()


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $methodName  
        —
          called method
      

          

        array  
        $parameters  
        —
          parameters of the called method
      

        

    


        
[ Top ]

  

  
  
	
	
__call   [line 230]

	

    

    

		mixed __call(
string
$methodName, array
$parameters)
    

    


	
		__call Catchall
Encapsulate all the class logic : 
  • determine if the cache has to be used (or not) for the called method
  • see if a cache is available for this call
  • if no cache available, really do the call and store the result for next time


    

  • Return: The call result, already decoded into native types
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $methodName  
        —
          Method name
      

          

        array  
        $parameters  
        —
          Parameters
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Wed, 10 Sep 2008 15:30:07 -0400 by phpDocumentor 1.4.0. PEAR Logo Copyright ©  PHP Group 2004.