Merge remote-tracking branch 'upstream/develop' into item-view

[friendica.git] / src / Network / CurlResult.php

diff --git a/src/Network/CurlResult.php b/src/Network/CurlResult.php
index 1187e45eb6f903fc7b73cbb423d446dbe5e64214..9f52edfad698137ae06936b80f0e7f7354af2ddd 100644 (file)
--- a/src/Network/CurlResult.php
+++ b/src/Network/CurlResult.php
@@ -29,7 +29,7 @@ use Friendica\Util\Network;
 /**
  * A content class for Curl call results
  */
-class CurlResult implements IHTTPResult
+class CurlResult
 {
        /**
         * @var int HTTP return code or 0 if timeout or failure
@@ -101,7 +101,7 @@ class CurlResult implements IHTTPResult
         *
         * @param string $url optional URL
         *
-        * @return IHTTPResult a CURL with error response
+        * @return CurlResult a CURL with error response
         * @throws InternalServerErrorException
         */
        public static function createErrorCurl($url = '')
@@ -229,19 +229,33 @@ class CurlResult implements IHTTPResult
                }
        }
 
-       /** {@inheritDoc} */
+       /**
+        * Gets the Curl Code
+        *
+        * @return string The Curl Code
+        */
        public function getReturnCode()
        {
                return $this->returnCode;
        }
 
-       /** {@inheritDoc} */
+       /**
+        * Returns the Curl Content Type
+        *
+        * @return string the Curl Content Type
+        */
        public function getContentType()
        {
                return $this->contentType;
        }
 
-       /** {@inheritDoc} */
+       /**
+        * Returns the Curl headers
+        *
+        * @param string $field optional header field. Return all fields if empty
+        *
+        * @return string the Curl headers or the specified content of the header variable
+        */
        public function getHeader(string $field = '')
        {
                if (empty($field)) {
@@ -259,7 +273,13 @@ class CurlResult implements IHTTPResult
                return '';
        }
 
-       /** {@inheritDoc} */
+       /**
+        * Check if a specified header exists
+        *
+        * @param string $field header field
+        *
+        * @return boolean "true" if header exists
+        */
        public function inHeader(string $field)
        {
                $field = strtolower(trim($field));
@@ -269,7 +289,11 @@ class CurlResult implements IHTTPResult
                return array_key_exists($field, $headers);
        }
 
-       /** {@inheritDoc} */
+       /**
+        * Returns the Curl headers as an associated array
+        *
+        * @return array associated header array
+        */
        public function getHeaderArray()
        {
                if (!empty($this->header_fields)) {
@@ -289,55 +313,73 @@ class CurlResult implements IHTTPResult
                return $this->header_fields;
        }
 
-       /** {@inheritDoc} */
+       /**
+        * @return bool
+        */
        public function isSuccess()
        {
                return $this->isSuccess;
        }
 
-       /** {@inheritDoc} */
+       /**
+        * @return string
+        */
        public function getUrl()
        {
                return $this->url;
        }
 
-       /** {@inheritDoc} */
+       /**
+        * @return string
+        */
        public function getRedirectUrl()
        {
                return $this->redirectUrl;
        }
 
-       /** {@inheritDoc} */
+       /**
+        * @return string
+        */
        public function getBody()
        {
                return $this->body;
        }
 
-       /** {@inheritDoc} */
+       /**
+        * @return array
+        */
        public function getInfo()
        {
                return $this->info;
        }
 
-       /** {@inheritDoc} */
+       /**
+        * @return bool
+        */
        public function isRedirectUrl()
        {
                return $this->isRedirectUrl;
        }
 
-       /** {@inheritDoc} */
+       /**
+        * @return int
+        */
        public function getErrorNumber()
        {
                return $this->errorNumber;
        }
 
-       /** {@inheritDoc} */
+       /**
+        * @return string
+        */
        public function getError()
        {
                return $this->error;
        }
 
-       /** {@inheritDoc} */
+       /**
+        * @return bool
+        */
        public function isTimeout()
        {
                return $this->isTimeout;