Auth_OpenID_ServerError Klassenreferenz

Basisklasse für Auth_OpenID_MalformedReturnURL, Auth_OpenID_MalformedTrustRoot, Auth_OpenID_NoReturnToError und Auth_OpenID_UntrustedReturnURL.


Öffentliche Methoden

 Auth_OpenID_ServerError ($message=null, $text=null, $reference=null, $contact=null)
 getReturnTo ()
 hasReturnTo ()
 encodeToURL ()
 encodeToKVForm ()
 toFormMarkup ($form_tag_attrs=null)
 toHTML ($form_tag_attrs=null)
 toMessage ()
 whichEncoding ()
 toString ()


Ausführliche Beschreibung

Definiert in Zeile 147 der Datei Server.php.


Dokumentation der Elementfunktionen

Auth_OpenID_ServerError ( message = null,
text = null,
reference = null,
contact = null 
)

private

Definiert in Zeile 151 der Datei Server.php.

00153     {
00154         $this->message = $message;
00155         $this->text = $text;
00156         $this->contact = $contact;
00157         $this->reference = $reference;
00158     }

encodeToKVForm (  ) 

Encodes the response to key-value form. This is a machine-readable format used to respond to messages which came directly from the consumer and not through the user-agent. See the OpenID specification.

Definiert in Zeile 201 der Datei Server.php.

00202     {
00203         return Auth_OpenID_KVForm::fromArray(
00204                                       array('mode' => 'error',
00205                                             'error' => $this->toString()));
00206     }

encodeToURL (  ) 

Encodes this error's response as a URL suitable for redirection. If the response has no return_to, another Auth_OpenID_ServerError is returned.

Definiert in Zeile 185 der Datei Server.php.

00186     {
00187         if (!$this->message) {
00188             return null;
00189         }
00190 
00191         $msg = $this->toMessage();
00192         return $msg->toURL($this->getReturnTo());
00193     }

getReturnTo (  ) 

Definiert in Zeile 160 der Datei Server.php.

00161     {
00162         if ($this->message &&
00163             $this->message->hasKey(Auth_OpenID_OPENID_NS, 'return_to')) {
00164             return $this->message->getArg(Auth_OpenID_OPENID_NS,
00165                                           'return_to');
00166         } else {
00167             return null;
00168         }
00169     }

hasReturnTo (  ) 

Returns the return_to URL for the request which caused this error.

Definiert in Zeile 175 der Datei Server.php.

00176     {
00177         return $this->getReturnTo() !== null;
00178     }

toFormMarkup ( form_tag_attrs = null  ) 

Definiert in Zeile 208 der Datei Server.php.

00209     {
00210         $msg = $this->toMessage();
00211         return $msg->toFormMarkup($this->getReturnTo(), $form_tag_attrs);
00212     }

toHTML ( form_tag_attrs = null  ) 

Definiert in Zeile 214 der Datei Server.php.

00215     {
00216         return Auth_OpenID::autoSubmitHTML(
00217                       $this->toFormMarkup($form_tag_attrs));
00218     }

toMessage (  ) 

Definiert in Zeile 220 der Datei Server.php.

00221     {
00222         // Generate a Message object for sending to the relying party,
00223         // after encoding.
00224         $namespace = $this->message->getOpenIDNamespace();
00225         $reply = new Auth_OpenID_Message($namespace);
00226         $reply->setArg(Auth_OpenID_OPENID_NS, 'mode', 'error');
00227         $reply->setArg(Auth_OpenID_OPENID_NS, 'error', $this->toString());
00228 
00229         if ($this->contact !== null) {
00230             $reply->setArg(Auth_OpenID_OPENID_NS, 'contact', $this->contact);
00231         }
00232 
00233         if ($this->reference !== null) {
00234             $reply->setArg(Auth_OpenID_OPENID_NS, 'reference',
00235                            $this->reference);
00236         }
00237 
00238         return $reply;
00239     }

toString (  ) 

Returns this error message.

Erneute Implementation in Auth_OpenID_NoReturnToError, Auth_OpenID_MalformedTrustRoot und Auth_OpenID_UntrustedReturnURL.

Definiert in Zeile 278 der Datei Server.php.

00279     {
00280         if ($this->text) {
00281             return $this->text;
00282         } else {
00283             return get_class($this) . " error";
00284         }
00285     }

whichEncoding (  ) 

Returns one of Auth_OpenID_ENCODE_URL, Auth_OpenID_ENCODE_KVFORM, or null, depending on the type of encoding expected for this error's payload.

Definiert in Zeile 246 der Datei Server.php.

00247     {
00248         global $_Auth_OpenID_Request_Modes;
00249 
00250         if ($this->hasReturnTo()) {
00251             if ($this->message->isOpenID2() &&
00252                 (strlen($this->encodeToURL()) >
00253                    Auth_OpenID_OPENID1_URL_LIMIT)) {
00254                 return Auth_OpenID_ENCODE_HTML_FORM;
00255             } else {
00256                 return Auth_OpenID_ENCODE_URL;
00257             }
00258         }
00259 
00260         if (!$this->message) {
00261             return null;
00262         }
00263 
00264         $mode = $this->message->getArg(Auth_OpenID_OPENID_NS,
00265                                        'mode');
00266 
00267         if ($mode) {
00268             if (!in_array($mode, $_Auth_OpenID_Request_Modes)) {
00269                 return Auth_OpenID_ENCODE_KVFORM;
00270             }
00271         }
00272         return null;
00273     }


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