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

Class: Auth_OpenID_AX_AttrInfo

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

Class Auth_OpenID_AX_AttrInfo

Class Overview

Represents a single attribute in an attribute exchange request. This should be added to an AXRequest object in order to request the attribute.

Located in /zp-extensions/federated_logon/Auth/OpenID/AX.php [line 139]



		
		
		
		

Methods

[ Top ]
Method Summary
static void   make()   Construct an attribute information object. For parameter details, see the constructor.
Auth_OpenID_AX_AttrInfo   Auth_OpenID_AX_AttrInfo()   Construct an attribute information object. Do not call this directly; call make(...) instead.
void   wantsUnlimitedValues()   When processing a request for this attribute, the OP should

[ Top ]
Methods
static method make  [line 194]

  static void make( $type_uri, [ $count = 1], [ $required = false], [ $alias = null]  )

Construct an attribute information object. For parameter details, see the constructor.

Parameters:
   $type_uri: 
   $count: 
   $required: 
   $alias: 


[ Top ]
Constructor Auth_OpenID_AX_AttrInfo  [line 154]

  Auth_OpenID_AX_AttrInfo Auth_OpenID_AX_AttrInfo( string $type_uri, int $count, bool $required, string $alias  )

Construct an attribute information object. Do not call this directly; call make(...) instead.

Parameters:
string   $type_uri:  The type URI for this attribute.
int   $count:  The number of values of this type to request.
bool   $required:  Whether the attribute will be marked as required in the request.
string   $alias:  The name that should be given to this attribute in the request.


[ Top ]
wantsUnlimitedValues  [line 216]

  void wantsUnlimitedValues( )

When processing a request for this attribute, the OP should

call this method to determine whether all available attribute values were requested. If self.count == UNLIMITED_VALUES, this returns True. Otherwise this returns False, in which case self.count is an integer.



[ Top ]

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