[ class tree: OpenID ] [ index: OpenID ] [ all elements ]

Class: Auth_OpenID_Association

Source Location: /zp-extensions/federated_logon/Auth/OpenID/Association.php

Class Auth_OpenID_Association

Class Overview

This class represents an association between a server and a consumer. In general, users of this library will never see instances of this object. The only exception is if you implement a custom Auth_OpenID_OpenIDStore.

If you do implement such a store, it will need to store the values of the handle, secret, issued, lifetime, and assoc_type instance variables.

Located in /zp-extensions/federated_logon/Auth/OpenID/Association.php [line 44]



		
		
		
		

Properties

Methods

[ Top ]
Property Summary
mixed   $_macs  

[ Top ]
Method Summary
static Auth_OpenID_Association   deserialize()   Parse an association as stored by serialize(). This is the inverse of serialize.
bool   equal()   This checks to see if two Auth_OpenID_Association instances represent the same association.
integer   getExpiresIn()   This returns the number of seconds this association is still valid for, or 0 if the association is no longer valid.
string   serialize()   Convert an association to KV form.

[ Top ]
Properties
mixed   $_macs = array(
'HMAC-SHA1' => 'Auth_OpenID_HMACSHA1',
'HMAC-SHA256' => 'Auth_OpenID_HMACSHA256'
)
[line 67]

[ Top ]
Methods
static method deserialize  [line 209]

  static Auth_OpenID_Association deserialize( $class_name, string $assoc_s  )

Parse an association as stored by serialize(). This is the inverse of serialize.

Parameters:
string   $assoc_s:  Association as serialized by serialize()
   $class_name: 

API Tags:
Return:  instance of this class


[ Top ]
equal  [line 170]

  bool equal( $other  )

This checks to see if two Auth_OpenID_Association instances represent the same association.

Parameters:
   $other: 

API Tags:
Return:  true if the two instances represent the same association, false otherwise.


[ Top ]
getExpiresIn  [line 154]

  integer getExpiresIn( [ $now = null]  )

This returns the number of seconds this association is still valid for, or 0 if the association is no longer valid.

Parameters:
   $now: 

API Tags:
Return:  The number of seconds this association is still valid for, or 0 if the association is no longer valid.


[ Top ]
serialize  [line 186]

  string serialize( )

Convert an association to KV form.


API Tags:
Return:  String in KV form suitable for deserialization by deserialize.


[ Top ]

Documentation generated on Sat, 05 Jan 2013 15:50:59 +0100 by phpDocumentor 1.4.3