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

Class: Auth_OpenID_Mapping

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

Class Auth_OpenID_Mapping

Class Overview

An Auth_OpenID_Mapping maintains a mapping from arbitrary keys to arbitrary values. (This is unlike an ordinary PHP array, whose keys may be only simple scalars.)

Located in /zp-extensions/federated_logon/Auth/OpenID/Message.php [line 125]



		
		
		
		

Methods

[ Top ]
Method Summary
static void   isA()   Returns true if $thing is an Auth_OpenID_Mapping object; false if not.
Auth_OpenID_Mapping   Auth_OpenID_Mapping()   Initialize a mapping. If $classic_array is specified, its keys and values are used to populate the mapping.
void   contains()   Returns true if the specified value has a key in the mapping; false if not.
void   del()   Deletes a key-value pair from the mapping with the specified key.
void   get()   Gets a specified value from the mapping, associated with the specified key. If the key does not exist in the mapping, $default is returned instead.
void   items()   Returns an array of (key, value) pairs in the mapping.
void   keys()   Returns an array of the keys in the mapping.
void   len()   Returns the "length" of the mapping, or the number of keys.
void   set()   Sets a key-value pair in the mapping. If the key already exists, its value is replaced with the new value.
void   values()   Returns an array of values in the mapping.

[ Top ]
Methods
static method isA  [line 146]

  static void isA( $thing  )

Returns true if $thing is an Auth_OpenID_Mapping object; false if not.

Parameters:
   $thing: 


[ Top ]
Constructor Auth_OpenID_Mapping  [line 130]

  Auth_OpenID_Mapping Auth_OpenID_Mapping( [ $classic_array = null]  )

Initialize a mapping. If $classic_array is specified, its keys and values are used to populate the mapping.

Parameters:
   $classic_array: 


[ Top ]
contains  [line 265]

  void contains( $value  )

Returns true if the specified value has a key in the mapping; false if not.

Parameters:
   $value: 


[ Top ]
del  [line 248]

  void del( $key  )

Deletes a key-value pair from the mapping with the specified key.

Parameters:
   $key: 


[ Top ]
get  [line 211]

  void get( $key, [ $default = null]  )

Gets a specified value from the mapping, associated with the specified key. If the key does not exist in the mapping, $default is returned instead.

Parameters:
   $key: 
   $default: 


[ Top ]
items  [line 171]

  void items( )

Returns an array of (key, value) pairs in the mapping.



[ Top ]
keys  [line 155]

  void keys( )

Returns an array of the keys in the mapping.



[ Top ]
len  [line 185]

  void len( )

Returns the "length" of the mapping, or the number of keys.



[ Top ]
set  [line 194]

  void set( $key, $value  )

Sets a key-value pair in the mapping. If the key already exists, its value is replaced with the new value.

Parameters:
   $key: 
   $value: 


[ Top ]
values  [line 163]

  void values( )

Returns an array of values in the mapping.



[ Top ]

Documentation generated on Tue, 20 Dec 2011 16:07:44 +0100 by phpDocumentor 1.4.3