symphonycms / symphony-2

symphony/lib/boot/func.utilities.php

Doc Comments +1 added lines, -3 removed lines

@@ -88,7 +88,7 @@ 
  *
  *  @param string $action (optional)
  *  @param integer $start_time (optional)
- *  @return integer
+ *  @return double
  */
 function precision_timer($action = 'start', $start_time = null)
 {
@@ -212,8 +212,6 @@ 
  * Responsible for launching a standard symphony instance and
  * sending output to the browser.
  *
- *  @param string $val (optional)
- *  @return integer
  */
 function symphony_launcher($mode)
 {

symphony/lib/core/class.datetimeobj.php

Doc Comments +5 added lines, -5 removed lines

@@ -75,7 +75,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
@@ -159,7 +159,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)
@@ -181,7 +181,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)
@@ -371,7 +371,7 @@ 
      *
      * @link http://au2.php.net/manual/en/function.date.php
      * @since Symphony 2.3
-     * @return array
+     * @return string[]
      */
     public static function getDateFormats()
     {
@@ -431,7 +431,7 @@ 
      *
      * @link http://au2.php.net/manual/en/function.date.php
      * @since Symphony 2.3
-     * @return array
+     * @return string[]
      */
     public static function getTimeFormats()
     {

symphony/lib/core/class.symphony.php

Doc Comments +4 added lines, -4 removed lines

@@ -624,7 +624,7 @@ 
      * has been found. Returns `FALSE` otherwise.
      *
      * @since Symphony 2.3.1
-     * @return mixed
+     * @return string
      */
     public static function getMigrationVersion()
     {
@@ -677,7 +677,7 @@ 
      * This methods sets the `GenericExceptionHandler::$enabled` value to `true`.
      *
      * @see core.SymphonyErrorPage
-     * @param string|XMLElement $message
+     * @param string $message
      *  A description for this error, which can be provided as a string
      *  or as an XMLElement.
      * @param string $heading
@@ -716,7 +716,7 @@ 
      * Accessor for `self::$exception`.
      *
      * @since Symphony 2.3.2
-     * @return Exception|null
+     * @return Exception
      */
     public static function getException()
     {
@@ -937,7 +937,7 @@ 
      * is not found, `false` is returned
      *
      * @since Symphony 2.3
-     * @return mixed
+     * @return string|false
      *  String, which is the path to the template if the template is found,
      *  false otherwise
      */

symphony/lib/toolkit/class.emailgateway.php

Doc Comments +2 added lines, -1 removed lines

@@ -497,7 +497,7 @@ 
      *
      * @throws EmailGatewayException
      * @throws Exception
-     * @return boolean
+     * @return boolean|null
      */
     protected function prepareMessageBody()
     {
@@ -728,6 +728,7 @@ 
      *
      * @see EmailGateway::contentInfoArray()
      *
+     * @param string $type
      * @return string|null
      */
     protected function contentInfoString($type = null, $file = null, $filename = null, $charset = null)

symphony/lib/toolkit/class.entrymanager.php

Doc Comments +2 added lines, -2 removed lines

@@ -575,7 +575,7 @@ 
      *
      * @param integer $entry_id
      *  The ID of the Entry to return it's section
-     * @return integer
+     * @return string|null
      *  The Section ID for this Entry's section
      */
     public static function fetchEntrySectionID($entry_id)
@@ -656,7 +656,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
      *  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

symphony/lib/toolkit/class.field.php

Doc Comments +3 added lines, -3 removed lines

@@ -1210,7 +1210,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)
@@ -1230,7 +1230,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
@@ -1401,7 +1401,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 +2 added lines, -2 removed lines

@@ -59,7 +59,7 @@ 
      *
      * @param string $type
      *  The field handle, that is, `field.{$handle}.php`
-     * @return string|boolean
+     * @return string|false
      */
     public static function __getClassPath($type)
     {
@@ -602,7 +602,7 @@ 
      * Check if a specific text formatter is used by a Field
      *
      * @since Symphony 2.3
-     * @param $text_formatter_handle
+     * @param string $text_formatter_handle
      *  The handle of the `TextFormatter`
      * @return boolean
      *  true if used, false if not

symphony/lib/toolkit/class.general.php

Doc Comments +14 added lines, -9 removed lines

@@ -107,7 +107,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)
@@ -443,7 +443,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)
@@ -460,7 +460,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)
@@ -475,7 +475,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.
      */
@@ -492,7 +492,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.
      */
@@ -586,7 +586,7 @@ 
     /**
      * Search a multi-dimensional array for a value.
      *
-     * @param mixed $needle
+     * @param string $needle
      *  the value to search for.
      * @param array $haystack
      *  the multi-dimensional array to search.
@@ -690,6 +690,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) {
                     if (!isset($post[$key])) {
@@ -905,7 +909,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)
@@ -1085,7 +1089,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
@@ -1137,7 +1141,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)
@@ -1330,6 +1334,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.smtp.php

Doc Comments +2 added lines, -2 removed lines

@@ -132,7 +132,7 @@ 
      * @param string $message
      * @throws SMTPException
      * @throws Exception
-     * @return boolean
+     * @return boolean|null
      */
     public function sendMail($from, $to, $subject, $message)
     {
@@ -395,7 +395,7 @@ 
      *
      * @param string $request
      * @throws SMTPException
-     * @return boolean|integer number of characters written.
+     * @return integer number of characters written.
      */
     protected function _send($request)
     {