Auth_OpenID_AX_AttrInfo Class Reference

Collaboration diagram for Auth_OpenID_AX_AttrInfo:

Public Member Functions
	Auth_OpenID_AX_AttrInfo ($type_uri, $count, $required, $alias)
	Construct an attribute information object.
	wantsUnlimitedValues ()
	When processing a request for this attribute, the OP should call this method to determine whether all available attribute values were requested.

Static Public Member Functions
static	make ($type_uri, $count=1, $required=false, $alias=null)
	Construct an attribute information object.

Detailed Description

Definition at line 138 of file AX.php.

Member Function Documentation

Auth_OpenID_AX_AttrInfo::Auth_OpenID_AX_AttrInfo	(		$type_uri,
			$count,
			$required,
			$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.

required: Whether the attribute will be marked as required when presented to the subject of the attribute exchange request.

count: How many values of this type to request from the subject. Defaults to one.

type_uri: The identifier that determines what the attribute represents and how it is serialized. For example, one type URI representing dates could represent a Unix timestamp in base 10 and another could represent a human-readable string.

alias: The name that should be given to this attribute in the request. If it is not supplied, a generic name will be assigned. For example, if you want to call a Unix timestamp value 'tstamp', set its alias to that value. If two attributes in the same message request to use the same alias, the request will fail to be generated.

Definition at line 153 of file AX.php.

    {
        $this->required = $required;

        $this->count = $count;

        $this->type_uri = $type_uri;

        $this->alias = $alias;

static Auth_OpenID_AX_AttrInfo::make (   $type_uri,   $count = 1,   $required = false,   $alias = null  )

static

Construct an attribute information object.

For parameter details, see the constructor.

Definition at line 193 of file AX.php.

    {
        if ($alias !== null) {
            $result = Auth_OpenID_AX_checkAlias($alias);

            if (Auth_OpenID_AX::isError($result)) {
                return $result;
            }
        }

        return new Auth_OpenID_AX_AttrInfo($type_uri, $count, $required,
                                           $alias);

Auth_OpenID_AX_AttrInfo::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.

Definition at line 215 of file AX.php.

    {
        return $this->count === Auth_OpenID_AX_UNLIMITED_VALUES;

---

The documentation for this class was generated from the following file:

• Services/OpenId/lib/Auth/OpenID/AX.php