Docs For Class OpenID_ServiceEndpoints

Description

Implements interfaces:

IteratorAggregate (internal interface)
ArrayAccess (internal interface)
Countable (internal interface)

OpenID_ServiceEndpoints

This class represents a colleciton of OpenID_ServiceEndpoint objects. It implements several SPL interfaces to make it easy to consume.

author: Rich Schumacher <rich.schu@gmail.com>
copyright: 2009 Rich Schumacher
link: http://pearopenid.googlecode.com
license: FreeBSD

Located in /OpenID/ServiceEndpoints.php (line 33)

Method Summary

void __construct (string $identifier, [null|OpenID_Service_Endpoint $spec = null])

void addService (OpenID_ServiceEndpoint $endpoint)

int count ()

string getExpiresHeader ()

null|string getIdentifier ()

ArrayIterator getIterator ()

bool offsetExists (int $offset)

null|OpenID_ServiceEndpoint offsetGet (int $offset)

void offsetSet (int $offset, OpenID_ServiceEndpoint $endpoint)

void offsetUnset (int $offset)

OpenID_ServiceEndpoints setExpiresHeader (string $value)

void setIdentifier (string $identifier)

Methods

Constructor __construct (line 65)

Sets the user-supplied identifier and adds a service if one is passed

access: public

void __construct (string $identifier, [null|OpenID_Service_Endpoint $spec = null])

string $identifier: User-supplied identifier
null|OpenID_Service_Endpoint $spec: Service endpoint object

addService (line 103)

Adds a service to the services array

access: public

void addService (OpenID_ServiceEndpoint $endpoint)

OpenID_ServiceEndpoint $endpoint: The service endpoint object

count (line 182)

Returns the number of service endpoints

access: public

int count ()

Implementation of:

Countable::count

getExpiresHeader (line 194)

Gets the Expires header value

see: $_expiresHeader
see: OpenID_ServiceEndpoints::setExpiresHeader()
access: public

string getExpiresHeader ()

getIdentifier (line 91)

Returns the user-supplied identifier

access: public

null|string getIdentifier ()

getIterator (line 117)

Returns an ArrayIterator object to traverse the services array

access: public

ArrayIterator getIterator ()

Implementation of:

IteratorAggregate::getIterator

offsetExists (line 129)

Checks to see if the offset exists in the services array

access: public

bool offsetExists (int $offset)

int $offset: The offset to check

Implementation of:

ArrayAccess::offsetExists

offsetGet (line 141)

Returns the value of the services array at the specified offset

access: public

null|OpenID_ServiceEndpoint offsetGet (int $offset)

int $offset: The offset to retrieve

Implementation of:

ArrayAccess::offsetGet

offsetSet (line 158)

Sets a value in the services array

access: public

void offsetSet (int $offset, OpenID_ServiceEndpoint $endpoint)

int $offset: The offset to set
OpenID_ServiceEndpoint $endpoint: The service object to set

Implementation of:

ArrayAccess::offsetSet

offsetUnset (line 172)

Removes a particular offset in the services array

access: public

void offsetUnset (int $offset)

int $offset: The offset to remove

Implementation of:

ArrayAccess::offsetUnset

setExpiresHeader (line 207)

Sets the Expires header value

see: OpenID_ServiceEndpoints::getExpiresHeader()
access: public

OpenID_ServiceEndpoints setExpiresHeader (string $value)

string $value: The Expires header value

setIdentifier (line 81)

Sets the user-supplied indentifier

access: public

void setIdentifier (string $identifier)

string $identifier: The user-supplied identifier