symphonycms / symphony-2

symphony/lib/toolkit/class.extensionmanager.php

Doc Comments +2 added lines, -2 removed lines

@@ -324,7 +324,7 @@ 
      *  The name of the Extension Class minus the extension prefix.
      * @param string $file_version
      *  The version of the extension from the **file**, not the Database.
-     * @return string|boolean
+     * @return false|string
      *  If the given extension (by $name) requires updating, the installed
      *  version is returned, otherwise, if the extension doesn't require
      *  updating, false.
@@ -572,7 +572,7 @@ 
      *  An extension object
      * @throws SymphonyErrorPage
      * @throws Exception
-     * @return boolean
+     * @return boolean|null
      */
     private static function __canUninstallOrDisable(Extension $obj)
     {

symphony/lib/toolkit/class.general.php

Doc Comments +13 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)
@@ -436,7 +436,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)
@@ -453,7 +453,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)
@@ -468,7 +468,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.
      */
@@ -485,7 +485,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.
      */
@@ -682,6 +682,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) {
@@ -900,7 +904,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)
@@ -1100,7 +1104,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
@@ -1152,7 +1156,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)
@@ -1345,6 +1349,7 @@ 
      *  the full path name of the source file to move.
      * @param integer $perm (optional)
      *  the permissions to apply to the moved file. this defaults to 0777.
+     * @param string $dest_name
      * @return boolean
      *  true if the file was moved and its permissions set as required. false otherwise.
      */

symphony/lib/toolkit/class.htmlpage.php

Doc Comments +1 added lines, -1 removed lines

@@ -287,7 +287,7 @@
      * it is also possible to override the default filters on the resulting string.
      *
      * @link http://php.net/manual/en/filter.filters.php
-     * @param array $exclude
+     * @param string[] $exclude
      *  A simple array with the keys that should be omitted in the resulting
      *  query string.
      * @param integer $filters

symphony/lib/toolkit/class.lang.php

Doc Comments +1 added lines, -1 removed lines

@@ -537,7 +537,7 @@
      * @since Symphony 2.3
      * @param string $string
      *  The string that should be cleaned-up
-     * @return mixed
+     * @return string
      *  Returns the transliterated string
      */
     private static function applyTransliterations($string)

symphony/lib/toolkit/class.resourcespage.php

Doc Comments +1 added lines, -1 removed lines

@@ -418,7 +418,7 @@
      *
      * @param string $name
      *  Name of the template
-     * @return mixed
+     * @return string|false
      *  String, which is the path to the template if the template is found,
      *  false otherwise
      */

symphony/lib/toolkit/class.section.php

Doc Comments +1 added lines, -1 removed lines

@@ -289,7 +289,7 @@
      * function.
      *
      * @see toolkit.Field#commit()
-     * @return boolean
+     * @return boolean|null
      *  true if the commit was successful, false otherwise.
      */
     public function commit()

symphony/lib/toolkit/class.xmlelement.php

Doc Comments +1 added lines, -1 removed lines

@@ -140,7 +140,7 @@
     /**
      * Accessor for `$_value`
      *
-     * @return string|XMLElement
+     * @return string
      */
     public function getValue()
     {

symphony/lib/toolkit/data-sources/class.datasource.navigation.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
         return (is_array($parent_paths) && !empty($parent_paths) ? " AND p.`path` IN ('".implode("', '", $parent_paths)."')" : null);
     }
 
+    /**
+     * @param integer $filter_type
+     */
     public function __processNavigationTypeFilter($filter, $filter_type = Datasource::FILTER_OR)
     {
         $types = preg_split('/'.($filter_type == Datasource::FILTER_AND ? '\+' : '(?<!\\\\),').'\s*/', $filter, -1, PREG_SPLIT_NO_EMPTY);

symphony/lib/toolkit/events/class.event.section.php

Doc Comments +3 added lines, -4 removed lines

@@ -65,7 +65,7 @@ 
      * @param XMLElement $result
      * @param array $fields
      * @param array $errors
-     * @param object $post_values
+     * @param XMLElement $post_values
      * @throws Exception
      * @return XMLElement
      */
@@ -192,7 +192,6 @@ 
      * Helper method to determine if a field is missing, or if the data
      * provided was invalid. Used in conjunction with `array_reduce`.
      *
-     * @param array $a,
      * @param array $b
      * @return string
      *  'missing' or 'invalid'
@@ -214,7 +213,7 @@ 
      * the XML.
      *
      * @throws Exception
-     * @return XMLElement|void
+     * @return XMLElement
      *  If `$_REQUEST{'redirect']` is set, and the Event executed successfully,
      *  the user will be redirected to the given location. If `$_REQUEST['redirect']`
      *  is not set, or the Event encountered errors, an XMLElement of the Event
@@ -303,7 +302,7 @@ 
      *  If this Event is editing an existing entry, that Entry ID will
      *  be passed to this function.
      * @throws Exception
-     * @return XMLElement
+     * @return boolean
      *  The result of the Event
      */
     public function __doit(array $fields = array(), XMLElement &$result, $position = null, $entry_id = null)