symphonycms / symphony-2

symphony/lib/toolkit/class.emailgatewaymanager.php

Doc Comments +2 added lines, -2 removed lines

@@ -164,7 +164,7 @@ 
          *
          * @param string $name
          *  The gateway to look for
-         * @return string|boolean
+         * @return string
          * @todo fix return if gateway does not exist.
          */
         public static function __getDriverPath($name)
@@ -177,7 +177,7 @@ 
          * Does not check if the gateway exists.
          *
          * @param string $filename
-         * @return string|boolean
+         * @return string
          */
         public static function __getHandleFromFilename($filename)
         {

symphony/lib/toolkit/class.entry.php

Doc Comments +1 added lines, -1 removed lines

@@ -145,7 +145,7 @@
          *
          * @see toolkit.MySQL#getInsertID()
          * @throws DatabaseException
-         * @return integer
+         * @return null|string
          */
         public function assignEntryId()
         {

symphony/lib/toolkit/class.entrymanager.php

Doc Comments +3 added lines, -3 removed lines

@@ -475,7 +475,7 @@ 
          *
          * @param integer $entry_id
          *  The ID of the Entry to return it's section
-         * @return integer
+         * @return string
          *  The Section ID for this Entry's section
          */
         public static function fetchEntrySectionID($entry_id)
@@ -654,7 +654,7 @@ 
          *  by providing an array of field names. Defaults to null, which will load data
          *  from all fields in a section.
          * @throws Exception
-         * @return array
+         * @return integer|null
          *  Either an array of Entry objects, or an associative array containing
          *  the total entries, the start position, the entries per page and the
          *  Entry objects
@@ -725,7 +725,7 @@ 
          *  Any custom JOIN's
          * @param boolean $group
          *  Whether the entries need to be grouped by Entry ID or not
-         * @return integer
+         * @return false|string
          */
         public static function fetchCount($section_id = null, $where = null, $joins = null, $group = false)
         {

symphony/lib/toolkit/class.event.php

Doc Comments +2 added lines, -2 removed lines

@@ -91,7 +91,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()
         {
@@ -106,7 +106,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

@@ -570,7 +570,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.
@@ -744,7 +744,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 +3 added lines, -3 removed lines

@@ -1223,7 +1223,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()
         {
@@ -1449,7 +1449,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
@@ -1564,7 +1564,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.fieldmanager.php

Doc Comments +3 added lines, -3 removed lines

@@ -47,7 +47,7 @@ 
          * @throws DatabaseException
          * @param array $fields
          *  Associative array of field names => values for the Field object
-         * @return integer|boolean
+         * @return false|string
          *  Returns a Field ID of the created Field on success, false otherwise.
          */
         public static function add(array $fields)
@@ -95,7 +95,7 @@ 
          * @param array $settings
          *  An associative array of settings, where the key is the column name
          *  and the value is the value.
-         * @return boolean
+         * @return PDOStatement
          *  True on success, false on failure
          */
         public static function saveSettings($field_id, $settings)
@@ -403,7 +403,7 @@ 
          *
          * @param string $type
          *  The field handle, that is, `field.{$handle}.php`
-         * @return string|boolean
+         * @return string|false
          */
         public static function __getClassPath($type)
         {

symphony/lib/toolkit/class.general.php

Doc Comments +12 added lines, -8 removed lines

@@ -337,7 +337,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)
@@ -398,7 +398,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)
@@ -413,7 +413,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.
          */
@@ -431,7 +431,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.
          */
@@ -629,6 +629,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) {
@@ -848,7 +852,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)
@@ -930,7 +934,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)
@@ -1051,7 +1055,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
@@ -1110,7 +1114,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)

symphony/lib/toolkit/class.htmlpage.php

Doc Comments +1 added lines, -1 removed lines

@@ -298,7 +298,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