123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403 |
- <?xml version="1.0" encoding="iso-8859-1"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <!-- template designed by Marco Von Ballmoos -->
- <title>Docs for page Message.php</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
- </head>
- <body>
- <div class="page-body">
- <h2 class="file-name">/Auth/OpenID/Message.php</h2>
- <a name="sec-description"></a>
- <div class="info-box">
- <div class="info-box-title">Description</div>
- <div class="nav-bar">
- <span class="disabled">Description</span> |
- <a href="#sec-classes">Classes</a>
- | <a href="#sec-includes">Includes</a>
- | <a href="#sec-constants">Constants</a>
- | <a href="#sec-functions">Functions</a>
- </div>
- <div class="info-box-body">
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Extension argument processing code</p>
-
- </div>
- </div>
-
- <a name="sec-classes"></a>
- <div class="info-box">
- <div class="info-box-title">Classes</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <span class="disabled">Classes</span>
- | <a href="#sec-includes">Includes</a>
- | <a href="#sec-constants">Constants</a>
- | <a href="#sec-functions">Functions</a>
- </div>
- <div class="info-box-body">
- <table cellpadding="2" cellspacing="0" class="class-table">
- <tr>
- <th class="class-table-header">Class</th>
- <th class="class-table-header">Description</th>
- </tr>
- <tr>
- <td style="padding-right: 2em; vertical-align: top">
- <a href="../OpenID/Auth_OpenID_Mapping.html">Auth_OpenID_Mapping</a>
- </td>
- <td>
- An Auth_OpenID_Mapping maintains a mapping from arbitrary keys to arbitrary values. (This is unlike an ordinary PHP array, whose keys may be only simple scalars.)
- </td>
- </tr>
- <tr>
- <td style="padding-right: 2em; vertical-align: top">
- <a href="../OpenID/Auth_OpenID_NamespaceMap.html">Auth_OpenID_NamespaceMap</a>
- </td>
- <td>
- Maintains a bijective map between namespace uris and aliases.
- </td>
- </tr>
- <tr>
- <td style="padding-right: 2em; vertical-align: top">
- <a href="../OpenID/Auth_OpenID_Message.html">Auth_OpenID_Message</a>
- </td>
- <td>
- In the implementation of this object, null represents the global namespace as well as a namespace with no key.
- </td>
- </tr>
- </table>
- </div>
- </div>
- <a name="sec-includes"></a>
- <div class="info-box">
- <div class="info-box-title">Includes</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-classes">Classes</a>
- | <span class="disabled">Includes</span>
- | <a href="#sec-constants">Constants</a>
- | <a href="#sec-functions">Functions</a>
- </div>
- <div class="info-box-body">
- <a name="_Auth/OpenID_php"><!-- --></a>
- <div class="oddrow">
-
- <div>
- <span class="include-title">
- <span class="include-type">require_once</span>
- (<span class="include-name"><a href="../OpenID/_Auth---OpenID.php.html">'Auth/OpenID.php'</a></span>)
- (line <span class="line-number">12</span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Import tools needed to deal with messages.</p>
-
- </div>
- <a name="_Auth/OpenID/Consumer_php"><!-- --></a>
- <div class="evenrow">
-
- <div>
- <span class="include-title">
- <span class="include-type">require_once</span>
- (<span class="include-name"><a href="../OpenID/_Auth---OpenID---Consumer.php.html">'Auth/OpenID/Consumer.php'</a></span>)
- (line <span class="line-number">15</span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
-
- </div>
- <a name="_Auth/OpenID/KVForm_php"><!-- --></a>
- <div class="oddrow">
-
- <div>
- <span class="include-title">
- <span class="include-type">require_once</span>
- (<span class="include-name">'Auth/OpenID/KVForm.php'</span>)
- (line <span class="line-number">13</span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
-
- </div>
- <a name="_Auth/Yadis/XML_php"><!-- --></a>
- <div class="evenrow">
-
- <div>
- <span class="include-title">
- <span class="include-type">require_once</span>
- (<span class="include-name"><a href="../OpenID/_Auth---Yadis---XML.php.html">'Auth/Yadis/XML.php'</a></span>)
- (line <span class="line-number">14</span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
-
- </div>
- </div>
- </div>
-
- <a name="sec-constants"></a>
- <div class="info-box">
- <div class="info-box-title">Constants</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-classes">Classes</a>
- | <a href="#sec-includes">Includes</a>
- | <span class="disabled">Constants</span>
- | <a href="#sec-functions">Functions</a>
- </div>
- <div class="info-box-body">
- <a name="defineAuth_OpenID_BARE_NS"><!-- --></a>
- <div class="oddrow">
-
- <div>
- <span class="const-title">
- <span class="const-name">Auth_OpenID_BARE_NS</span> = 'Bare namespace'
- (line <span class="line-number">47</span>)
- </span>
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- <a name="defineAuth_OpenID_IDENTIFIER_SELECT"><!-- --></a>
- <div class="evenrow">
-
- <div>
- <span class="const-title">
- <span class="const-name">Auth_OpenID_IDENTIFIER_SELECT</span> = "http://specs.openid.net/auth/2.0/identifier_select"
- (line <span class="line-number">18</span>)
- </span>
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- <a name="defineAuth_OpenID_NO_DEFAULT"><!-- --></a>
- <div class="oddrow">
-
- <div>
- <span class="const-title">
- <span class="const-name">Auth_OpenID_NO_DEFAULT</span> = 'NO DEFAULT ALLOWED'
- (line <span class="line-number">51</span>)
- </span>
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- <a name="defineAuth_OpenID_NULL_NAMESPACE"><!-- --></a>
- <div class="evenrow">
-
- <div>
- <span class="const-title">
- <span class="const-name">Auth_OpenID_NULL_NAMESPACE</span> = 'Null namespace'
- (line <span class="line-number">40</span>)
- </span>
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- <a name="defineAuth_OpenID_OPENID1_NS"><!-- --></a>
- <div class="oddrow">
-
- <div>
- <span class="const-title">
- <span class="const-name">Auth_OpenID_OPENID1_NS</span> = 'http://openid.net/signon/1.0'
- (line <span class="line-number">26</span>)
- </span>
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- <a name="defineAuth_OpenID_OPENID1_URL_LIMIT"><!-- --></a>
- <div class="evenrow">
-
- <div>
- <span class="const-title">
- <span class="const-name">Auth_OpenID_OPENID1_URL_LIMIT</span> = 2047
- (line <span class="line-number">55</span>)
- </span>
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- <a name="defineAuth_OpenID_OPENID2_NS"><!-- --></a>
- <div class="oddrow">
-
- <div>
- <span class="const-title">
- <span class="const-name">Auth_OpenID_OPENID2_NS</span> = 'http://specs.openid.net/auth/2.0'
- (line <span class="line-number">36</span>)
- </span>
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- <a name="defineAuth_OpenID_OPENID_NS"><!-- --></a>
- <div class="evenrow">
-
- <div>
- <span class="const-title">
- <span class="const-name">Auth_OpenID_OPENID_NS</span> = 'OpenID namespace'
- (line <span class="line-number">43</span>)
- </span>
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- <a name="defineAuth_OpenID_SREG_URI"><!-- --></a>
- <div class="oddrow">
-
- <div>
- <span class="const-title">
- <span class="const-name">Auth_OpenID_SREG_URI</span> = 'http://openid.net/sreg/1.0'
- (line <span class="line-number">23</span>)
- </span>
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- <a name="defineAuth_OpenID_THE_OTHER_OPENID1_NS"><!-- --></a>
- <div class="evenrow">
-
- <div>
- <span class="const-title">
- <span class="const-name">Auth_OpenID_THE_OTHER_OPENID1_NS</span> = 'http://openid.net/signon/1.1'
- (line <span class="line-number">27</span>)
- </span>
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- </div>
- </div>
-
-
- <a name="sec-functions"></a>
- <div class="info-box">
- <div class="info-box-title">Functions</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-classes">Classes</a>
- | <a href="#sec-includes">Includes</a>
- | <a href="#sec-constants">Constants</a>
- | <span class="disabled">Functions</span>
- </div>
- <div class="info-box-body">
- <a name="functionAuth_OpenID_isOpenID1" id="functionAuth_OpenID_isOpenID1"><!-- --></a>
- <div class="oddrow">
-
- <div>
- <span class="method-title">Auth_OpenID_isOpenID1</span> (line <span class="line-number">29</span>)
- </div>
- <!-- ========== Info from phpDoc block ========= -->
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- Auth_OpenID_isOpenID1
- </span>
- (<span class="var-type"></span> <span class="var-name">$ns</span>)
- </div>
- <ul class="parameters">
- <li>
- <span class="var-type"></span>
- <span class="var-name">$ns</span> </li>
- </ul>
-
-
- </div>
- <a name="functionAuth_OpenID_registerNamespaceAlias" id="functionAuth_OpenID_registerNamespaceAlias"><!-- --></a>
- <div class="evenrow">
-
- <div>
- <span class="method-title">Auth_OpenID_registerNamespaceAlias</span> (line <span class="line-number">78</span>)
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Registers a (namespace URI, alias) mapping in a global namespace</p>
- <p class="description"><p>alias map. Raises NamespaceAliasRegistrationError if either the namespace URI or alias has already been registered with a different value. This function is required if you want to use a namespace with an OpenID 1 message.</p></p>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- Auth_OpenID_registerNamespaceAlias
- </span>
- (<span class="var-type"></span> <span class="var-name">$namespace_uri</span>, <span class="var-type"></span> <span class="var-name">$alias</span>)
- </div>
- <ul class="parameters">
- <li>
- <span class="var-type"></span>
- <span class="var-name">$namespace_uri</span> </li>
- <li>
- <span class="var-type"></span>
- <span class="var-name">$alias</span> </li>
- </ul>
-
-
- </div>
- <a name="functionAuth_OpenID_removeNamespaceAlias" id="functionAuth_OpenID_removeNamespaceAlias"><!-- --></a>
- <div class="oddrow">
-
- <div>
- <span class="method-title">Auth_OpenID_removeNamespaceAlias</span> (line <span class="line-number">105</span>)
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Removes a (namespace_uri, alias) registration from the global namespace alias map. Returns true if the removal succeeded; false if not (if the mapping did not exist).</p>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- Auth_OpenID_removeNamespaceAlias
- </span>
- (<span class="var-type"></span> <span class="var-name">$namespace_uri</span>, <span class="var-type"></span> <span class="var-name">$alias</span>)
- </div>
- <ul class="parameters">
- <li>
- <span class="var-type"></span>
- <span class="var-name">$namespace_uri</span> </li>
- <li>
- <span class="var-type"></span>
- <span class="var-name">$alias</span> </li>
- </ul>
-
-
- </div>
- </div>
- </div>
-
- <p class="notes" id="credit">
- Documentation generated on Tue, 21 Apr 2009 11:31:31 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
- </p>
- </div></body>
- </html>
|