symphonycms / symphony-2

symphony/lib/toolkit/class.general.php

Doc Comments +12 added lines, -8 removed lines

@@ -104,7 +104,7 @@ 
      * @param boolean $isFile (optional)
      *  if this is true, the method will attempt to read from a file, `$data`
      *  instead.
-     * @param mixed $xsltProcessor (optional)
+     * @param XsltProcess $xsltProcessor (optional)
      *  if set, the validation will be done using this XSLT processor rather
      *  than the built in XML parser. the default is null.
      * @param string $encoding (optional)
@@ -491,7 +491,7 @@ 
      *  the string to operate on
      * @param integer $val
      *  the number to compare lengths with
-     * @return string|boolean
+     * @return string
      *  the resulting string or false on failure.
      */
     public static function substrmin($str, $val)
@@ -508,7 +508,7 @@ 
      *  the string to operate on
      * @param integer $val
      *  the number to compare lengths with
-     * @return string|boolean
+     * @return string
      *  the resulting string or false on failure.
      */
     public static function substrmax($str, $val)
@@ -523,7 +523,7 @@ 
      *  the string to extract the characters from.
      * @param integer $num
      *  the number of characters to extract.
-     * @return string|boolean
+     * @return string
      *  a string containing the last `$num` characters of the
      *  input string, or false on failure.
      */
@@ -540,7 +540,7 @@ 
      *  the string to extract the characters from.
      * @param integer $num
      *  the number of characters to extract.
-     * @return string|boolean
+     * @return string
      *  a string containing the last `$num` characters of the
      *  input string, or false on failure.
      */
@@ -737,6 +737,10 @@ 
     public static function getPostData()
     {
         if (!function_exists('merge_file_post_data')) {
+
+            /**
+             * @param string $type
+             */
             function merge_file_post_data($type, array $file, &$post)
             {
                 foreach ($file as $key => $value) {
@@ -955,7 +959,7 @@ 
      *  the path of the file to write.
      * @param mixed $data
      *  the data to write to the file.
-     * @param integer|null $perm (optional)
+     * @param integer $perm (optional)
      *  the permissions as an octal number to set set on the resulting file.
      *  this defaults to 0644 (if omitted or set to null)
      * @param string $mode (optional)
@@ -1156,7 +1160,7 @@ 
      * @param mixed $strip_root (optional)
      *  If null, the full path to the file will be returned, otherwise the value
      *  of `strip_root` will be removed from the file path.
-     * @param array $exclude (optional)
+     * @param string[] $exclude (optional)
      *  ignore directories listed in this array. this defaults to an empty array.
      * @param boolean $ignore_hidden (optional)
      *  ignore hidden directory (i.e.directories that begin with a period). this defaults
@@ -1208,7 +1212,7 @@ 
      * @param string $dir (optional)
      *  the path of the directory to construct the multi-dimensional array
      *  for. this defaults to '.'.
-     * @param array|string $filters (optional)
+     * @param string $filters (optional)
      *  either a regular expression to filter the files by or an array of
      *  files to include.
      * @param boolean $recurse (optional)