symphonycms / symphony-2

symphony/lib/core/class.datetimeobj.php

Doc Comments +3 added lines, -3 removed lines

@@ -107,7 +107,7 @@ 
      *
      * @since Symphony 2.2.4
      * @param string $name
-     * @return array|string|null
+     * @return string
      *  If `$name` is omitted this function returns array.
      *  If `$name` is not set, this fucntion returns `null`
      *  If `$name` is set, this function returns string
@@ -191,7 +191,7 @@ 
      *  result in the current time being used
      * @param string $timezone (optional)
      *  The timezone associated with the timestamp
-     * @return string|boolean
+     * @return false|string
      *  The formatted date, of if the date could not be parsed, false.
      */
     public static function get($format, $timestamp = 'now', $timezone = null)
@@ -213,7 +213,7 @@ 
      *  Localizes the output, if true, defaults to true
      * @param string $timezone (optional)
      *  The timezone associated with the timestamp
-     * @return string|boolean
+     * @return false|string
      *  The formatted date, or if the date could not be parsed, false.
      */
     public static function format($string = 'now', $format = DateTime::ISO8601, $localize = true, $timezone = null)

symphony/lib/core/class.log.php

Doc Comments +2 added lines, -2 removed lines

@@ -193,7 +193,7 @@ 
      * @param boolean $append
      *  If set to true, the given `$message` will be append to the previous log
      *  message found in the `$_log` array
-     * @return mixed
+     * @return boolean|null
      *  If `$writeToLog` is passed, this function will return boolean, otherwise
      *  void
      */
@@ -251,7 +251,7 @@ 
      * @param boolean $append
      *  If set to true, the given `$message` will be append to the previous log
      *  message found in the `$_log` array
-     * @return mixed
+     * @return boolean|null
      *  If `$writeToLog` is passed, this function will return boolean, otherwise
      *  void
      */

symphony/lib/toolkit/class.event.php

Doc Comments +2 added lines, -2 removed lines

@@ -87,7 +87,7 @@ 
      * edit an event but it's `allowEditorToParse()` returns `false`. If this is not implemented by
      * the event, a default Symphony message will appear.
      *
-     * @return string|XMLElement
+     * @return string
      */
     public static function documentation()
     {
@@ -102,7 +102,7 @@ 
      *
      * @param string $language
      *  Language used in system
-     * @return mixed
+     * @return string|false
      *  String, which is the path to the template if the template is found,
      *  false otherwise
      */

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.field.php

Doc Comments +4 added lines, -4 removed lines

@@ -1220,7 +1220,7 @@ 
      * If the date type is set, only the calendar will be shown in the suggestion dropdown.
      *
      * @since Symphony 2.6.0
-     * @return array
+     * @return string[]
      */
     public function fetchSuggestionTypes()
     {
@@ -1313,7 +1313,7 @@ 
      *
      * @param string $string
      *  The string to test.
-     * @return boolean
+     * @return boolean|null
      *  True if the string is prefixed with `regexp:` or `not-regexp:`, false otherwise.
      */
     protected static function isFilterRegex($string)
@@ -1333,7 +1333,7 @@ 
      * @link http://dev.mysql.com/doc/refman/5.5/en/regexp.html
      * @param string $filter
      *  The full filter, eg. `regexp: ^[a-d]`
-     * @param array $columns
+     * @param string[] $columns
      *  The array of columns that need the given `$filter` applied to. The conditions
      *  will be added using `OR`.
      * @param string $joins
@@ -1504,7 +1504,7 @@ 
      *  The data for this field from it's `tbl_entry_data_{id}` table
      * @param integer $entry_id
      *  The optional id of this field entry instance
-     * @return string|array
+     * @return string
      *  The formatted value to be used as the parameter. Note that this can be
      *  an array or a string. When returning multiple values use array, otherwise
      *  use string.

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
      */