Document that Http::get() and Http::post() can return false
authorKunal Mehta <legoktm@member.fsf.org>
Sun, 14 Feb 2016 08:12:31 +0000 (00:12 -0800)
committerKunal Mehta <legoktm@member.fsf.org>
Sun, 14 Feb 2016 08:12:31 +0000 (00:12 -0800)
Change-Id: I6d48ac011ee221050c7b8a05103d028fe2bed66a

includes/HttpFunctions.php

index 032710c..973a28f 100644 (file)
@@ -95,7 +95,7 @@ class Http {
         * @param string $url
         * @param array $options
         * @param string $caller The method making this request, for profiling
-        * @return string
+        * @return string|bool false on error
         */
        public static function get( $url, $options = array(), $caller = __METHOD__ ) {
                $args = func_get_args();
@@ -118,7 +118,7 @@ class Http {
         * @param string $url
         * @param array $options
         * @param string $caller The method making this request, for profiling
-        * @return string
+        * @return string|bool false on error
         */
        public static function post( $url, $options = array(), $caller = __METHOD__ ) {
                return Http::request( 'POST', $url, $options, $caller );