Merge "setSquidMaxage() globally if we can purge it, instead of in actions."

[lhc/web/wiklou.git] / includes / ZhClient.php

diff --git a/includes/ZhClient.php b/includes/ZhClient.php
index 5404b69..4299841 100644 (file)
--- a/includes/ZhClient.php
+++ b/includes/ZhClient.php
@@ -1,4 +1,24 @@
 <?php
+/**
+ * Client for querying zhdaemon.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
 
 /**
  * Client for querying zhdaemon
@@ -9,7 +29,10 @@ class ZhClient {
        /**
         * Constructor
         *
-        * @access private
+        * @param $host
+        * @param $port
+        *
+        * @return ZhClient
         */
        function __construct( $host, $port ) {
                $this->mHost = $host;
@@ -19,6 +42,8 @@ class ZhClient {
 
        /**
         * Check if connection to zhdaemon is successful
+        *
+        * @return bool
         */
        function isconnected() {
                return $this->mConnected;
@@ -28,22 +53,23 @@ class ZhClient {
         * Establish conncetion
         *
         * @access private
+        *
+        * @return bool
         */
        function connect() {
                wfSuppressWarnings();
                $errno = $errstr = '';
                $this->mFP = fsockopen( $this->mHost, $this->mPort, $errno, $errstr, 30 );
                wfRestoreWarnings();
-               if ( !$this->mFP ) {
-                       return false;
-               }
-               return true;
+               return !$this->mFP;
        }
 
        /**
         * Query the daemon and return the result
         *
         * @access private
+        *
+        * @return string
         */
        function query( $request ) {
                if ( !$this->mConnected ) {
@@ -68,10 +94,7 @@ class ZhClient {
                        $data .= $str;
                }
                // data should be of length $len. otherwise something is wrong
-               if ( strlen( $data ) != $len ) {
-                       return false;
-               }
-               return $data;
+               return strlen( $data ) == $len;
        }
 
        /**
@@ -115,6 +138,7 @@ class ZhClient {
                }
                return $ret;
        }
+
        /**
         * Perform word segmentation
         *