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_KEY_SECRET

Source Location: /HA.php

Class Overview




Abstract class for Token objects.









        






Methods















Child classes:






HA_T

	
Hyves Token Object






HA_CONSUMER

	
Hyves Consumer Object

















Class Details



[line 343]

Abstract class for Token objects.





[ Top ]








Class Methods




  

	
	
constructor __construct [line 363]

	

    

    

		HA_KEY_SECRET __construct(
[string
$key = NULL], [string
$secret = NULL])
    

    


	
		Create a new instance





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $key  
        Key
      

          

        string  
        $secret  
        Secret
      

        

    


        
[ Top ]

  

  

	
	
method getData [line 450]

	

    

    

		array getData(
)
    

    


	
		Get the key and secret for debugging





Tags:





  

    return:  Key and secret
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getKey [line 397]

	

    

    

		string getKey(
)
    

    


	
		Get the key





Tags:





  

    return:  Key
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSecret [line 415]

	

    

    

		string getSecret(
)
    

    


	
		Get the secret





Tags:





  

    return:  Secret
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method hasKey [line 424]

	

    

    

		bool hasKey(
)
    

    


	
		Check if the key is set





Tags:





  

    return:  Returns TRUE if the key is set, else FALSE.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method hasSecret [line 437]

	

    

    

		bool hasSecret(
)
    

    


	
		Check if the secret is set





Tags:





  

    return:  Returns TRUE if the secret is set, else FALSE.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setKey [line 388]

	

    

    

		void setKey(
string
$key)
    

    


	
		Set the key





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $key  
        Key
      

        

    


        
[ Top ]

  

  

	
	
method setSecret [line 406]

	

    

    

		void setSecret(
string
$secret)
    

    


	
		Set the secret





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $secret  
        Secret
      

        

    


        
[ Top ]

  

  

	
	
method __get [line 378]

	

    

    

		string __get(
string
$key)
    

    


	
		Magic method for OAuth





Tags:





  

    return:  Value
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $key  
        Key
      

        

    


        
[ Top ]

  






        

		    

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