mkungla / libhowi-filesystem

Commons/FilesystemInterface.inc

Spacing +1 added lines, -1 removed lines

@@ -302,5 +302,5 @@
      * @param array $data_array 
      * @return bool true on success fase on failure
      */
-    public function createStructure($rootpath,$data_array);
+    public function createStructure($rootpath, $data_array);
 }

Doc Comments +5 added lines, -2 removed lines

@@ -30,6 +30,7 @@ 
      * Construct with or without current working directory
      *
      * @param string $setCwd            
+     * @return void
      */
     public function __construct($setCwd = false);
 
@@ -51,7 +52,7 @@ 
      *
      * @param string $filename            
      * @param string $dirname            
-     * @param mixed $data            
+     * @param string $data            
      * @param int $flags            
      * @param resource $context            
      */
@@ -102,6 +103,7 @@ 
      *
      * @param unknown $pathname            
      * @param string $shred            
+     * @return boolean
      */
     public function rm($pathname, $shred = false);
 
@@ -167,6 +169,7 @@ 
      *
      * @param string $filename            
      * @param string $user            
+     * @return boolean
      */
     public function chown($filename = false, $user = false);
 
@@ -228,7 +231,7 @@ 
      * which is similar to the rules used by common shells.
      *
      * @param string $pattern            
-     * @param number $flags            
+     * @param integer $flags            
      * @return array matching paths
      */
     public function getGlob($pattern = false, $flags = 0);

Commons/ObjectInterfaces/FileInterface.inc

Doc Comments +5 added lines, -9 removed lines

@@ -49,6 +49,7 @@ 
     /**
      * Assert that if some wierd reason this is called in file
      * that we return false
+     * @return boolean
      */
     public function getLinkTarget();
 
@@ -82,6 +83,7 @@ 
      * No purpose
      * inherited from iterator but useless
      * An FileObject does not have children so this method returns allways NULL.
+     * @return boolean
      */
     public function getChildren();
 
@@ -90,7 +92,7 @@ 
      *
      * Forces a write of all buffered output to the file.
      *
-     * @return Returns TRUE on success or FALSE on failure
+     * @return boolean TRUE on success or FALSE on failure
      */
     public function fflush();
 
@@ -146,14 +148,8 @@ 
      *
      * @param array $fields
      *            An array of values.
-     * @param string $delimiter
-     *            The optional delimiter parameter sets the field delimiter (one character only).
-     * @param string $enclosure
-     *            The optional enclosure parameter sets the field enclosure (one character only).
-     * @param string $escape
-     *            The optional escape parameter sets the escape character (one character only).
      *            
-     * @return int|bool Returns the length of the written string or FALSE on failure.
+     * @return integer Returns the length of the written string or FALSE on failure.
      *         returns FALSE, and does not write the CSV line to the file, if the delimiter
      *         or enclosure parameter is not a single character.
      *        
@@ -313,7 +309,7 @@ 
      * FileObject::setMaxLineLen() is used to read fixed lengths of the file.
      *
      *
-     * @return Returns the current line number.
+     * @return integer the current line number.
      */
     public function key();
 

Commons/ObjectInterfaces/InfoInterface.inc

Doc Comments +1 added lines

@@ -37,6 +37,7 @@
      * Gets an InfoObject object for the file
      *
      * @param string $class_name            
+     * @return \SplFileInfo
      */
     public function getFileInfo($class_name = '\HOWI3\libhowi\Filesystem\php5\Objects\InfoObject');
 }

Commons/ObjectInterfaces/LinkInterface.inc

Doc Comments +3 added lines

@@ -28,6 +28,7 @@ 
 
     /**
      * symlink — Creates a symbolic link
+     * @return boolean
      */
     public function symlink($target = false, $link = false);
 
@@ -43,6 +44,7 @@ 
 
     /**
      * link — Create a hard link
+     * @return boolean
      */
     public function hardlink($target = false, $link = false);
 
@@ -68,6 +70,7 @@ 
 
     /**
      * readlink — Returns the target of a symbolic link
+     * @return false|string
      */
     public function readlink($link = false);
 }

Commons/ObjectInterfaces/TmpInterface.inc

Doc Comments +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
     /**
      * tmpfile — Creates a temporary file
      * 
-     * @return filehandler
+     * @return resource
      */
     public function tmpfile();
 }

Commons/ResponseObject.inc

Doc Comments +15 added lines

@@ -72,21 +72,33 @@ 
     private $level;
 
 
+    /**
+     * @param boolean $arg
+     */
     public function setStatus($arg)
     {
         $this->status = is_bool($arg) ? $arg : false;
     }
 
+    /**
+     * @param integer $code
+     */
     public function setCode($code)
     {
         $this->code = is_int($code) ? $code : 0;
     }
 
+    /**
+     * @param string $msg
+     */
     public function setMsg($msg)
     {
         $this->message = is_string($msg) ? $msg : 'BUG';
     }
 
+    /**
+     * @param integer $UID
+     */
     public function setUID($UID)
     {
         $this->UID = is_int($UID) ? $UID : 'BUG';
@@ -102,6 +114,9 @@ 
         $this->microtime = microtime(true);
     }
 
+    /**
+     * @param string $context
+     */
     public function setContext($context)
     {
         $this->context = $context;

Commons/SharedMethodsInterface.inc

Doc Comments +3 added lines, -3 removed lines

@@ -46,7 +46,6 @@ 
      * Gets last access time of file
      *
      * @param string $timeformat            
-     * @param string $filename            
      * @return int or formated output
      */
     public function getATime($timeformat = false, $pathname = false);
@@ -55,7 +54,6 @@ 
      * Gets inode change time of file
      *
      * @param string $timeformat            
-     * @param string $filename            
      * @return int or formated output
      */
     public function getCTime($timeformat = false, $pathname = false);
@@ -64,7 +62,6 @@ 
      * Gets file modification time
      *
      * @param string $timeformat            
-     * @param string $filename            
      * @return int or formated output
      */
     public function getMTime($timeformat = false, $pathname = false);
@@ -81,6 +78,7 @@ 
      *            ommit emty values?
      * @param string $ago_single            
      * @param array $clocale            
+     * @return string
      */
     public function ct_ago($timestamp, $date_format = 'y,m,d,h,i,s', $sfx = true, $ommit_zero = true, $ago_single = true, $clocale = []);
 
@@ -101,6 +99,7 @@ 
      * Sets the class used with InfoObject::openFile()
      *
      * @param string $class_name            
+     * @return boolean
      */
     public function setFileClass($class_name = "\HOWI3\libhowi\Filesystem\php5\Objects\FileObject");
 
@@ -108,6 +107,7 @@ 
      * Sets the class used with InfoObject::getFileInfo() and SplFileInfo::getPathInfo()
      *
      * @param string $class_name            
+     * @return boolean
      */
     public function setInfoClass($class_name = "\HOWI3\libhowi\Filesystem\php5\Objects\InfoObject");
 

Commons/TraitForResponse.inc

Doc Comments +5 added lines, -5 removed lines

@@ -173,9 +173,9 @@ 
     /**
      * Add message to log
      *
-     * @param array $LEVEL
+     * @param string $LEVEL
      *            from private static $LEVEL;
-     * @param number $code            
+     * @param integer $code            
      * @param string $context            
      * @param string $append_msg            
      * @return void
@@ -219,7 +219,7 @@ 
     /**
      * Set loglevel
      *
-     * @param number $level            
+     * @param integer $level            
      */
     public function setLogLevel($level = 0)
     {
@@ -274,6 +274,7 @@ 
 
     /**
      * Return event microtime
+     * @return string
      */
     public function getTime()
     {
@@ -291,7 +292,6 @@ 
     /**
      * Get response with or without log 
      *
-     * @param string $key            
      * @return object
      */
     public function response()
@@ -338,7 +338,7 @@ 
     /**
      * Set user id
      *
-     * @param number $ID            
+     * @param number $UID            
      * @return void
      */
     public function setUID($UID)

Spacing +15 added lines, -15 removed lines

@@ -186,14 +186,14 @@ 
         
         $this->response->setCode($code);
         $this->response->setTime();
-        $this->response->setMsg($this->{$LEVEL}[$code] . (! empty($append_msg) ? ' - ' . $append_msg : ''));
+        $this->response->setMsg($this->{$LEVEL}[$code] . (!empty($append_msg) ? ' - ' . $append_msg : ''));
         $this->response->setUID($this->getUID());
         $this->response->setUsername($this->getUsername());
         $this->response->setContext($context);
         $this->response->setLevel($LEVEL);
         
         $logging = $this->getLogFile();
-        if (! empty($logging) && ! empty($to_file))
+        if(!empty($logging) && !empty($to_file))
             $this->logToFile($LEVEL);
     }
 
@@ -211,7 +211,7 @@ 
         $message .= '[msg] ' . $this->getMsg() . ' [/msg]' . "\n";
         
         $logging = $this->getLogFile();
-        if (empty($logging) || ! is_dir(dirname($logging)))
+        if(empty($logging) || !is_dir(dirname($logging)))
             return false;
         return file_put_contents($logging, $message, FILE_APPEND);
     }
@@ -235,7 +235,7 @@ 
     public function setLogFile($filepath = false)
     {
         $logfilepath = $this->makeAbsolute($filepath);
-        if (empty($filepath) || ! $this->isWritable(dirname($logfilepath))) {
+        if(empty($filepath) || !$this->isWritable(dirname($logfilepath))) {
             $this->error(400, 'setLogFile');
             return false;
         }
@@ -326,7 +326,7 @@ 
      */
     public function getCode()
     {
-        return ! is_object($this->response) ? 0 : $this->response->getCode();
+        return !is_object($this->response) ? 0 : $this->response->getCode();
     }
 
     /**
@@ -364,7 +364,7 @@ 
      */
     public function setStatus($status)
     {
-        if (is_object($this->response))
+        if(is_object($this->response))
             $this->response->setStatus($status);
     }
 
@@ -375,7 +375,7 @@ 
      */
     public function setCode($code)
     {
-        if (is_object($this->response))
+        if(is_object($this->response))
             $this->response->setCode($code);
     }
 
@@ -389,7 +389,7 @@ 
     public function emergency($code = 1, $append_msg = false, $context = false)
     {
         $to_file = true;
-        if ($this->getLogLevel() < 1)
+        if($this->getLogLevel() < 1)
             $to_file = false;
         
         $this->addTrace('EMERGENCY', $code, $context, $append_msg, $to_file);
@@ -409,7 +409,7 @@ 
     public function alert($code = 2, $append_msg = false, $context = false)
     {
         $to_file = true;
-        if ($this->getLogLevel() < 2)
+        if($this->getLogLevel() < 2)
             $to_file = false;
         $this->addTrace('ALERT', $code, $context, $append_msg, $to_file);
     }
@@ -427,7 +427,7 @@ 
     public function critical($code = 3, $append_msg = false, $context = false)
     {
         $to_file = true;
-        if ($this->getLogLevel() < 3)
+        if($this->getLogLevel() < 3)
             $to_file = false;
         $this->addTrace('CRITICAL', $code, $context, $append_msg, $to_file);
     }
@@ -445,7 +445,7 @@ 
     public function error($code = 4, $append_msg = false, $context = false)
     {
         $to_file = true;
-        if ($this->getLogLevel() < 4)
+        if($this->getLogLevel() < 4)
             $to_file = false;
         $this->addTrace('ERROR', $code, $context, $append_msg, $to_file);
     }
@@ -464,7 +464,7 @@ 
     public function warning($code = 5, $append_msg = false, $context = false)
     {
         $to_file = true;
-        if ($this->getLogLevel() < 5)
+        if($this->getLogLevel() < 5)
             $to_file = false;
         $this->addTrace('WARNING', $code, $context, $append_msg, $to_file);
     }
@@ -481,7 +481,7 @@ 
     public function notice($code = 6, $append_msg = false, $context = false)
     {
         $to_file = true;
-        if ($this->getLogLevel() < 6)
+        if($this->getLogLevel() < 6)
             $to_file = false;
         $this->addTrace('NOTICE', $code, $context, $append_msg, $to_file);
     }
@@ -500,7 +500,7 @@ 
     public function info($code = 7, $append_msg = false, $context = false)
     {
         $to_file = true;
-        if ($this->getLogLevel() < 7)
+        if($this->getLogLevel() < 7)
             $to_file = false;
         $this->addTrace('INFO', $code, $context, $append_msg, $to_file);
     }
@@ -517,7 +517,7 @@ 
     public function debug($code = 8, $append_msg = false, $context = false)
     {
         $to_file = true;
-        if ($this->getLogLevel() < 8)
+        if($this->getLogLevel() < 8)
             $to_file = false;
         $this->addTrace('DEBUG', $code, $context, $append_msg, $to_file);
     }

FS.inc

Doc Comments +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
      *
      * @name $FS = FS::load( string $pathname | $ser_cwd_by_caller boolean true = false, PHP_VERSION_ID );
      *      
-     * @param string|boolean $pathname|$ser_cwd_by_caller
+     * @param string|boolean $ser_cwd_by_caller
      *            Optional: defaults to false.
      *            If path is supplied then that will be current working directory.
      *            If boolean true is supplied it will try to set current working directory as one

Spacing +3 added lines, -3 removed lines

@@ -41,7 +41,7 @@ 
      */
     public static function load($ser_cwd_by_caller = false, $PHP_VERSION_ID = PHP_VERSION_ID)
     {
-        if (! empty($ser_cwd_by_caller) && is_bool($ser_cwd_by_caller)) {
+        if(!empty($ser_cwd_by_caller) && is_bool($ser_cwd_by_caller)) {
             $backtrace = debug_backtrace(
                 defined("DEBUG_BACKTRACE_IGNORE_ARGS") ? DEBUG_BACKTRACE_IGNORE_ARGS : FALSE);
             $cwd_caller = array_pop($backtrace);
@@ -50,9 +50,9 @@ 
         /**
          * Minimum version of PHP must be atleast 5.5.11
          */
-        if ($PHP_VERSION_ID <= 50511)
+        if($PHP_VERSION_ID <= 50511)
             return call_user_func(
-                function () {
+                function() {
                     $self = new self();
                     $self->emergency(100);
                     return $self;