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


Files:
HA.php

Classes:
authhelper
   HA_AUTH
configurehelper
   HA_C
   HA_CONSUMER
   HA_GLOBAL
   HA_P
   HA_R
   HA_T
   HA_TAGS
callhelper
   HA_CALL
   HA_COL
abstracthelper
   HA_ERRORS
   HA_KEY_SECRET
   HA_KEY_VALUE
   HA_LIST
responsehelper
   HA_HELPER
   HA_HELPER_USER

Class: HA_GLOBAL

Source Location: /HA.php

Class Overview




Hyves Global object









        





Constants






Methods
























Class Details



[line 594]

Hyves Global object





[ Top ]








Class Methods



  

	
	
static method getApiUrl [line 799]

	

    

    

		static string getApiUrl(
)
    

    


	
		Get api url





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method getAutoLog [line 781]

	

    

    

		static bool getAutoLog(
)
    

    


	
		Get auto log





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method getDateTime [line 727]

	

    

    

		static string getDateTime(
)
    

    


	
		Return the date and time.





Tags:





  

    return:  Date and time.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method getDefaultConfiguration [line 842]

	

    

    

		static HA_C|NULL getDefaultConfiguration(
)
    

    


	
		Get default configuration





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method getDefaultConsumer [line 882]

	

    

    

		static HA_CONSUMER|NULL getDefaultConsumer(
)
    

    


	
		Get default consumer





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method getLogFile [line 763]

	

    

    

		static string|NULL getLogFile(
)
    

    


	
		Get log file





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method getNrOfCallsExecuted [line 662]

	

    

    

		static integer getNrOfCallsExecuted(
)
    

    


	
		Return the number of calls executed





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method getRequestMethod [line 808]

	

    

    

		static const getRequestMethod(
)
    

    


	
		Get request method





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method getUnixtime [line 717]

	

    

    

		static integer getUnixtime(
)
    

    


	
		Return the unix timestamp.





Tags:





  

    return:  Unix timestamp
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method hasDefaultConfiguration [line 851]

	

    

    

		static bool hasDefaultConfiguration(
)
    

    


	
		Check if there is a default configuration





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method hasDefaultConsumer [line 891]

	

    

    

		static bool hasDefaultConsumer(
)
    

    


	
		Check if there is a default consumer





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method hasLogFile [line 750]

	

    

    

		static bool hasLogFile(
)
    

    


	
		Is a log file set?





Tags:





  

    return:  TRUE when a log file isset, else FALSE.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method has_string_value [line 737]

	

    

    

		static bool has_string_value(
mixed
$mixed)
    

    


	
		Helper





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        mixed  
        $mixed  
        
      

        

    


        
[ Top ]

  

  

	
	
static method incrementNrOfCallsExecuted [line 671]

	

    

    

		static void incrementNrOfCallsExecuted(
[int
$add = 1])
    

    


	
		Increment the number of calls executed.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $add  
        Amount to add, default is 1.
      

        

    


        
[ Top ]

  

  

	
	
static method normalizeToString [line 905]

	

    

    

		static string normalizeToString(
mixed
$mixed)
    

    


	
		Normalize to string





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        mixed  
        $mixed  
        
      

        

    


        
[ Top ]

  

  

	
	
static method setApiUrl [line 790]

	

    

    

		static void setApiUrl(
string
$api_url)
    

    


	
		Set api url





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $api_url  
        
      

        

    


        
[ Top ]

  

  

	
	
static method setAutoLog [line 772]

	

    

    

		static void setAutoLog(
bool
$auto_log)
    

    


	
		Set auto log





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        bool  
        $auto_log  
        
      

        

    


        
[ Top ]

  

  

	
	
static method setDefaultConfiguration [line 827]

	

    

    

		static bool setDefaultConfiguration(
HA_C|NULL
$configuration)
    

    


	
		Set default configuration





Tags:





  

    return:  Returns TRUE if the parameter was a HA_C object, containing one or more key-value pairs, else FALSE.
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        HA_C|NULL  
        $configuration  
        
      

        

    


        
[ Top ]

  

  

	
	
static method setDefaultConsumer [line 864]

	

    

    

		static void setDefaultConsumer(
HA_CONSUMER|NULL
$consumer)
    

    


	
		Set default consumer





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        HA_CONSUMER|NULL  
        $consumer  
        Consumer object
      

        

    


        
[ Top ]

  

  

	
	
static method setLogFile [line 683]

	

    

    

		static bool setLogFile(
string|NULL
$log_file)
    

    


	
		Set log file





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string|NULL  
        $log_file  
        Path to your log file.
      

        

    


        
[ Top ]

  

  

	
	
static method setRequestMethod [line 817]

	

    

    

		static void setRequestMethod(
constant
$request_method)
    

    


	
		Set request method





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        constant  
        $request_method  
        Constant of HA_GLOBAL::REQUEST_METHOD_*.
      

        

    


        
[ Top ]

  










Class Constants



	
	

	
REQUEST_METHOD_GET =  "get"

	
[line 611]

  Request method where the data is passed through the URL


  

	
[ Top ]


	
	

	
REQUEST_METHOD_GET_HEADER =  "get_header"

	
[line 619]

  Request method where the data is passed through the URL except for the OAuth data, which is in the Authorization header


  

	
[ Top ]


	
	

	
REQUEST_METHOD_POST =  "post"

	
[line 615]

  Request method where the data is passed through as POST data


  

	
[ Top ]


	
	

	
REQUEST_METHOD_POST_HEADER =  "post_header"

	
[line 623]

  Request method where the data is passed through as POST data except for the OAuth data, which is in the Authorization header (default)


  

	
[ Top ]






        

		    

		    Documentation generated on Sat, 10 Jan 2009 01:27:20 +0100 by phpDocumentor 1.4.1