Merge branch 'testing' of gitorious.org:statusnet/mainline into testing

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

diff --git a/extlib/libomb/remoteserviceexception.php b/extlib/libomb/remoteserviceexception.php
index 374d15973b52162875305b5ad8c43e015a577cf9..f8341e82b606e8448452943c8d25d6c864baaa70 100755 (executable)
--- a/extlib/libomb/remoteserviceexception.php
+++ b/extlib/libomb/remoteserviceexception.php
@@ -1,9 +1,6 @@
 <?php
 /**
- * Exception stating that the remote service had a failure
- *
- * This exception is raised when a remote service failed to return a valid
- * response to a request or send a valid request.
+ * This file is part of libomb
  *
  * PHP version 5
  *
@@ -20,23 +17,57 @@
  * 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
- **/
-class OMB_RemoteServiceException extends Exception {
-  public static function fromYadis($request_uri, $result) {
-    if ($result->status == 200) {
-        $err = 'Got wrong response ' . $result->body;
-    } else {
-        $err = 'Got error code ' . $result->status . ' with response ' . $result->body;
+ * @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
+ */
+
+/**
+ * Exception stating that the remote service had a failure
+ *
+ * This exception is raised when a remote service failed to return a valid
+ * response to a request or send a valid request.
+ */
+class OMB_RemoteServiceException extends Exception
+{
+    /**
+     * Create exception from Yadis response
+     *
+     * Creates an exception from a passed yadis result.
+     *
+     * @param string                  $request_uri The target URI for the failed
+     *                                             request
+     * @param Auth_Yadis_HTTPResponse $result      The result of the failed
+     *                                             request
+     *
+     * @return OMB_RemoteServiceException A new exception
+     */
+    public static function fromYadis($request_uri, $result)
+    {
+        if ($result->status == 200) {
+            $err = 'Got wrong response ' . $result->body;
+        } else {
+            $err = 'Got error code ' . $result->status . ' with response ' .
+                   $result->body;
+        }
+        return OMB_RemoteServiceException::forRequest($request_uri, $err);
     }
-    return new OMB_RemoteServiceException($request_uri . ': ' .  $err);
-  }
 
-  public static function forRequest($action_uri, $failure) {
-    return new OMB_RemoteServiceException("Handler for $action_uri: " .  $failure);
-  }
+    /**
+     * Create exception for a call to a resource
+     *
+     * Creates an exception for a given error message and target URI.
+     *
+     * @param string $action_uri The target URI for the failed request
+     * @param string $failure    An error message
+     *
+     * @return OMB_RemoteServiceException A new exception
+     */
+    public static function forRequest($action_uri, $failure)
+    {
+        return new OMB_RemoteServiceException("Handler for $action_uri: $failure");
+    }
 }
 ?>