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_ERRORS

Source Location: /HA.php

Class Overview




Abstract class for errors.









        




Variables






Constants






Methods















Child classes:






HA_CALL

	
Object for a single call to the Hyves API.






HA_COL

	
A collection of HA_CALL objects.






HA_HELPER

	
Reponse object main helper.






HA_AUTH

	
Helper for authorization.

















Class Details



[line 36]

Abstract class for errors.





[ Top ]







Class Variables



	
	

	
$_runtime_errors = array()

	
[line 42]

  Array for error arrays.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Class Methods



  

	
	
static method errorCodeToErrorMessage [line 85]

	

    

    

		static void errorCodeToErrorMessage(
integer
$error_code)
    

    


	
		Helper for converting error codes within the ERROR_SCOPE_LIBRARY scope to an error message.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        integer  
        $error_code  
        Error code.
      

        

    


        
[ Top ]

  


  

	
	
method addError [line 111]

	

    

    

		void addError(

$error_message, 
$error_code, 
$error_scope, [
$error_debug = NULL])
    

    


	
		Add an error array





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $error_message  
        
      

          

          
        $error_code  
        
      

          

          
        $error_scope  
        
      

          

          
        $error_debug  
        
      

        

    


        
[ Top ]

  

  

	
	
method getErrors [line 189]

	

    

    

		array getErrors(
)
    

    


	
		Returns an array of error arrays





Tags:





  

    return:  Array of error arrays
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getLastError [line 98]

	

    

    

		array|bool getLastError(
)
    

    


	
		Returns the last error array or FALSE





Tags:





  

    return:  Last error array of FALSE if none is present.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method hasErrors [line 167]

	

    

    

		bool hasErrors(
)
    

    


	
		Return TRUE if the object has errors, else FALSE





Tags:





  

    return:  TRUE on errors
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method log [line 132]

	

    

    

		void log(
[array
$errors = NULL])
    

    


	
		Log the errors if a log file isset.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $errors  
        Array of error arrays to log. Optional.
      

        

    


        
[ Top ]

  

  

	
	
method nrOfErrors [line 180]

	

    

    

		int nrOfErrors(
)
    

    


	
		Returns the numer of errors





Tags:





  

    return:  Number of errors
  

  

    access:  public
  









	
        
[ Top ]

  









Class Constants



	
	

	
ERROR_SCOPE_CURL =  "curl"

	
[line 53]

  Error constant for in the scope of cURL

http://curl.haxx.se/libcurl/c/libcurl-errors.html


  

	
[ Top ]


	
	

	
ERROR_SCOPE_HYVES_API =  "hyves_api"

	
[line 48]

  Error constant for in the scope of the Hyves API

http://trac.hyves-api.nl/hyves-api/wiki/APIErrors


  

	
[ Top ]


	
	

	
ERROR_SCOPE_LIBRARY =  "library"

	
[line 57]

  Error constant for in the scope of the library


  

	
[ Top ]






        

		    

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