symphonycms / symphony-2

symphony/lib/core/class.cookie.php

Doc Comments +1 added lines, -1 removed lines

@@ -120,7 +120,7 @@
      * Initialises a new Session instance using this cookie's params
      *
      * @throws Exception
-     * @return Session
+     * @return false|string
      */
     private function __init()
     {

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/core/class.session.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
      *  Whether this cookie should only be sent on secure servers. By default this is
      *  false, which means the cookie can be sent over HTTP and HTTPS
      * @throws Exception
-     * @return string|boolean
+     * @return false|string
      *  Returns the Session ID on success, or false on error.
      */
     public static function start($lifetime = 0, $path = '/', $domain = null, $httpOnly = true, $secure = false)

symphony/lib/core/class.symphony.php

Doc Comments +3 added lines, -3 removed lines

@@ -633,7 +633,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
@@ -672,7 +672,7 @@ 
      * Accessor for `self::$exception`.
      *
      * @since Symphony 2.3.2
-     * @return Exception|null
+     * @return Exception
      */
     public static function getException()
     {
@@ -891,7 +891,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.entrymanager.php

Doc Comments +2 added lines, -2 removed lines

@@ -580,7 +580,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)
@@ -661,7 +661,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

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.