Show aside primary on settings pages for all themes.

[quix0rs-gnu-social.git] / extlib / libomb / base_url_xrds_mapper.php

diff --git a/extlib/libomb/base_url_xrds_mapper.php b/extlib/libomb/base_url_xrds_mapper.php
index 645459583518527cfa6cec8fb69794c316c2945c..d45d6d69f9c212e25223f8d6d4fc803e469dff5e 100755 (executable)
--- a/extlib/libomb/base_url_xrds_mapper.php
+++ b/extlib/libomb/base_url_xrds_mapper.php
@@ -1,14 +1,6 @@
 <?php
-
-require_once 'xrds_mapper.php';
-require_once 'constants.php';
-
 /**
- * Map XRDS actions to URLs using base URLs.
- *
- * This interface specifies classes which write the XRDS file announcing
- * the OMB server. An instance of an implementing class should be passed to
- * OMB_Service_Provider->writeXRDS.
+ * This file is part of libomb
  *
  * PHP version 5
  *
@@ -25,27 +17,56 @@ require_once 'constants.php';
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
- * @package   OMB
- * @author    Adrian Lang <mail@adrianlang.de>
- * @copyright 2009 Adrian Lang
- * @license   http://www.gnu.org/licenses/agpl.html GNU AGPL 3.0
- **/
+ * @package OMB
+ * @author  Adrian Lang <mail@adrianlang.de>
+ * @license http://www.gnu.org/licenses/agpl.html GNU AGPL 3.0
+ * @version 0.1a-20090828
+ * @link    http://adrianlang.de/libomb
+ */
 
-class OMB_Base_URL_XRDS_Mapper implements OMB_XRDS_Mapper {
+require_once 'xrds_mapper.php';
+require_once 'constants.php';
 
-  protected $urls;
+/**
+ * Map XRDS actions to URLs using base URLs
+ *
+ * This class realizes a simple mapping of action URIs to handler URLs. The
+ * target URLs are constructed using a base URL.
+ */
+class OMB_Base_URL_XRDS_Mapper implements OMB_XRDS_Mapper
+{
+    protected $urls;
 
-  public function __construct($oauth_base, $omb_base) {
-    $this->urls = array(
-        OAUTH_ENDPOINT_REQUEST => $oauth_base . 'requesttoken',
-        OAUTH_ENDPOINT_AUTHORIZE => $oauth_base . 'userauthorization',
-        OAUTH_ENDPOINT_ACCESS => $oauth_base . 'accesstoken',
-        OMB_ENDPOINT_POSTNOTICE => $omb_base . 'postnotice',
-        OMB_ENDPOINT_UPDATEPROFILE => $omb_base . 'updateprofile');
-  }
+    /**
+     * Constructor
+     *
+     * Initialize the XRDS mapper with base URLs for OAuth and OMB endpoints.
+     *
+     * @param string $oauth_base The base URL for OAuth endpoints
+     * @param string $omb_base   The base URL for OMB endpoints
+     */
+    public function __construct($oauth_base, $omb_base)
+    {
+        $this->urls = array(
+                OAUTH_ENDPOINT_REQUEST => $oauth_base . 'requesttoken',
+                OAUTH_ENDPOINT_AUTHORIZE => $oauth_base . 'userauthorization',
+                OAUTH_ENDPOINT_ACCESS => $oauth_base . 'accesstoken',
+                OMB_ENDPOINT_POSTNOTICE => $omb_base . 'postnotice',
+                OMB_ENDPOINT_UPDATEPROFILE => $omb_base . 'updateprofile');
+    }
 
-  public function getURL($action) {
-    return $this->urls[$action];
-  }
+    /**
+     * Fetch an URL for a specified action
+     *
+     * Returns the action URL for an action specified by the endpoint URI.
+     *
+     * @param string $action The endpoint URI
+     *
+     * @return string The action URL
+     */
+    public function getURL($action)
+    {
+        return $this->urls[$action];
+    }
 }
 ?>