Auth_OpenID_AX_AttrInfo Klassenreferenz


Öffentliche Methoden

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

Ausführliche Beschreibung

Definiert in Zeile 138 der Datei AX.php.


Dokumentation der Elementfunktionen

Auth_OpenID_AX_AttrInfo ( type_uri,
count,
required,
alias 
)

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

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

Definiert in Zeile 153 der Datei AX.php.

00156     {
00162         $this->required = $required;
00163 
00168         $this->count = $count;
00169 
00177         $this->type_uri = $type_uri;
00178 
00187         $this->alias = $alias;

make ( type_uri,
count = 1,
required = false,
alias = null 
)

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

Definiert in Zeile 193 der Datei AX.php.

00196     {
00197         if ($alias !== null) {
00198             $result = Auth_OpenID_AX_checkAlias($alias);
00199 
00200             if (Auth_OpenID_AX::isError($result)) {
00201                 return $result;
00202             }
00203         }
00204 
00205         return new Auth_OpenID_AX_AttrInfo($type_uri, $count, $required,
00206                                            $alias);

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.

Definiert in Zeile 215 der Datei AX.php.

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


Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:
Copyright © 2003 - 2009 MyOOS [Shopsystem]. All rights reserved.
MyOOS [Shopsystem] is Free Software released under the GNU/GPL License.

Webmaster: info@r23.de (Impressum)
doxygen