Auth_OpenID_ServerError Class Reference

Inheritance diagram for Auth_OpenID_ServerError:

Collaboration diagram for Auth_OpenID_ServerError:

Public Member Functions
	Auth_OpenID_ServerError ($message=null, $text=null, $reference=null, $contact=null)
	@access private More...
	getReturnTo ()
	hasReturnTo ()
	Returns the return_to URL for the request which caused this error. More...
	encodeToURL ()
	Encodes this error's response as a URL suitable for redirection. More...
	encodeToKVForm ()
	Encodes the response to key-value form. More...
	toFormMarkup ($form_tag_attrs=null)
	toHTML ($form_tag_attrs=null)
	toMessage ()
	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. More...
	toString ()
	Returns this error message. More...

Detailed Description

Definition at line 147 of file Server.php.

Member Function Documentation

Auth_OpenID_ServerError()

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

@access private

Definition at line 151 of file Server.php.

    {
        $this->message = $message;
        $this->text = $text;
        $this->contact = $contact;
        $this->reference = $reference;
    }

References $text.

encodeToKVForm()

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

Definition at line 201 of file Server.php.

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

References Auth_OpenID_KVForm\fromArray(), and toString().

Here is the call graph for this function:

encodeToURL()

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

Definition at line 185 of file Server.php.

    {
        if (!$this->message) {
            return null;
        }
 
        $msg = $this->toMessage();
        return $msg->toURL($this->getReturnTo());
    }

References getReturnTo(), and toMessage().

Referenced by whichEncoding().

Here is the call graph for this function:

Here is the caller graph for this function:

getReturnTo()

Auth_OpenID_ServerError::getReturnTo

(

)

Definition at line 160 of file Server.php.

    {
        if ($this->message &&
            $this->message->hasKey(Auth_OpenID_OPENID_NS, 'return_to')) {
            return $this->message->getArg(Auth_OpenID_OPENID_NS,
                                          'return_to');
        } else {
            return null;
        }
    }

References Auth_OpenID_OPENID_NS.

Referenced by encodeToURL(), hasReturnTo(), and toFormMarkup().

Here is the caller graph for this function:

hasReturnTo()

Auth_OpenID_ServerError::hasReturnTo

(

)

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

Definition at line 175 of file Server.php.

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

References getReturnTo().

Referenced by whichEncoding().

Here is the call graph for this function:

Here is the caller graph for this function:

toFormMarkup()

Auth_OpenID_ServerError::toFormMarkup

(

$form_tag_attrs = null

)

Definition at line 208 of file Server.php.

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

References getReturnTo(), and toMessage().

Referenced by toHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

toHTML()

Auth_OpenID_ServerError::toHTML

(

$form_tag_attrs = null

)

Definition at line 214 of file Server.php.

    {
        return Auth_OpenID::autoSubmitHTML(
                      $this->toFormMarkup($form_tag_attrs));
    }

References Auth_OpenID\autoSubmitHTML(), and toFormMarkup().

Here is the call graph for this function:

toMessage()

Auth_OpenID_ServerError::toMessage

(

)

Definition at line 220 of file Server.php.

    {
        // Generate a Message object for sending to the relying party,
        // after encoding.
        $namespace = $this->message->getOpenIDNamespace();
        $reply = new Auth_OpenID_Message($namespace);
        $reply->setArg(Auth_OpenID_OPENID_NS, 'mode', 'error');
        $reply->setArg(Auth_OpenID_OPENID_NS, 'error', $this->toString());
 
        if ($this->contact !== null) {
            $reply->setArg(Auth_OpenID_OPENID_NS, 'contact', $this->contact);
        }
 
        if ($this->reference !== null) {
            $reply->setArg(Auth_OpenID_OPENID_NS, 'reference',
                           $this->reference);
        }
 
        return $reply;
    }

References $namespace, Auth_OpenID_OPENID_NS, and toString().

Referenced by encodeToURL(), and toFormMarkup().

Here is the call graph for this function:

Here is the caller graph for this function:

toString()

Auth_OpenID_ServerError::toString

(

)

Returns this error message.

Reimplemented in Auth_OpenID_NoReturnToError, Auth_OpenID_MalformedTrustRoot, and Auth_OpenID_UntrustedReturnURL.

Definition at line 278 of file Server.php.

    {
        if ($this->text) {
            return $this->text;
        } else {
            return get_class($this) . " error";
        }
    }

References $text.

Referenced by encodeToKVForm(), and toMessage().

Here is the caller graph for this function:

whichEncoding()

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

Definition at line 246 of file Server.php.

    {
        global $_Auth_OpenID_Request_Modes;
 
        if ($this->hasReturnTo()) {
            if ($this->message->isOpenID2() &&
                (strlen($this->encodeToURL()) >
                   Auth_OpenID_OPENID1_URL_LIMIT)) {
                return Auth_OpenID_ENCODE_HTML_FORM;
            } else {
                return Auth_OpenID_ENCODE_URL;
            }
        }
 
        if (!$this->message) {
            return null;
        }
 
        $mode = $this->message->getArg(Auth_OpenID_OPENID_NS,
                                       'mode');
 
        if ($mode) {
            if (!in_array($mode, $_Auth_OpenID_Request_Modes)) {
                return Auth_OpenID_ENCODE_KVFORM;
            }
        }
        return null;
    }

References $_Auth_OpenID_Request_Modes, Auth_OpenID_ENCODE_HTML_FORM, Auth_OpenID_ENCODE_KVFORM, Auth_OpenID_ENCODE_URL, Auth_OpenID_OPENID1_URL_LIMIT, Auth_OpenID_OPENID_NS, encodeToURL(), and hasReturnTo().

Here is the call graph for this function:

---

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

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