Auth_OpenID_AX_AttrInfo
in package
Represents a single attribute in an attribute exchange request. This should be added to an AXRequest object in order to request the attribute.
Table of Contents
- __construct() : mixed
- Construct an attribute information object. Do not call this directly; call make(...) instead.
- make() : Auth_OpenID_AX_AttrInfo|Auth_OpenID_AX_Error|bool
- Construct an attribute information object. For parameter details, see the constructor.
- wantsUnlimitedValues() : mixed
- 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.
Methods
__construct()
Construct an attribute information object. Do not call this directly; call make(...) instead.
public
__construct(string $type_uri, int $count, bool $required, string $alias) : mixed
Parameters
- $type_uri : string
-
The type URI for this attribute.
- $count : int
-
The number of values of this type to request.
- $required : bool
-
Whether the attribute will be marked as required in the request.
- $alias : string
-
The name that should be given to this attribute in the request.
Return values
mixed —make()
Construct an attribute information object. For parameter details, see the constructor.
public
static make(string $type_uri[, int $count = 1 ][, bool $required = false ][, string|null $alias = null ]) : Auth_OpenID_AX_AttrInfo|Auth_OpenID_AX_Error|bool
Parameters
- $type_uri : string
- $count : int = 1
- $required : bool = false
- $alias : string|null = null
Return values
Auth_OpenID_AX_AttrInfo|Auth_OpenID_AX_Error|bool —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.
public
wantsUnlimitedValues() : mixed