symphonycms / symphony-2

symphony/lib/toolkit/class.event.php

Doc Comments +1 added lines, -1 removed lines

@@ -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/fields/field.textarea.php

Doc Comments +3 added lines

@@ -201,6 +201,9 @@
         return self::__OK__;
     }
 
+    /**
+     * @param integer $entry_id
+     */
     public function processRawFieldData($data, &$status, &$message = null, $simulate = false, $entry_id = null)
     {
         $status = self::__OK__;

install/lib/class.installerpage.php

Doc Comments +3 added lines

@@ -435,6 +435,9 @@
             }
         }
 
+        /**
+         * @param string $message
+         */
         private function __appendError(array $codes, XMLElement &$element, $message = null)
         {
             if (is_null($message)) {

symphony/content/content.blueprintsdatasources.php

Doc Comments +8 added lines, -1 removed lines

@@ -1526,6 +1526,9 @@ 
         $shell = str_replace($placeholder, trim($string), $shell);
     }
 
+    /**
+     * @param string $shell
+     */
     public static function injectAboutInformation(&$shell, array $details)
     {
         if (!is_array($details) || empty($details)) {
@@ -1576,6 +1579,10 @@ 
         $shell = str_replace($placeholder, trim($var_list) . PHP_EOL . "    " . $placeholder, $shell);
     }
 
+    /**
+     * @param string $h4_label
+     * @param string $name
+     */
     public function __appendAuthorFilter(&$wrapper, $h4_label, $name, $value = null, $templateOnly = true)
     {
         if (!$templateOnly) {
@@ -1655,7 +1662,7 @@ 
      *
      * @since Symphony 2.3.3
      * @param XMLElement $element
-     * @param array $context
+     * @param string[] $context
      */
     public function setContext(&$element, $context)
     {

symphony/content/content.blueprintsevents.php

Doc Comments +3 added lines

@@ -673,6 +673,9 @@
         $shell = str_replace('<!-- FILTERS -->', "'" . implode("'," . PHP_EOL . "        '", $elements) . "'", $shell);
     }
 
+    /**
+     * @param string $shell
+     */
     public function __injectAboutInformation(&$shell, $details)
     {
         if (!is_array($details) || empty($details)) {

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 Throwable
-     * @return string|boolean
+     * @return false|string
      */
     private function __init()
     {

symphony/lib/core/class.datetimeobj.php

Doc Comments +2 added lines, -2 removed lines

@@ -203,7 +203,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)
@@ -225,7 +225,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 -20 removed lines

@@ -288,26 +288,6 @@
      * @param string $alternative
      *  The name of the new method to use
      * @param array $opts (optional)
-     * @param string $opts.message-format
-     *  The sprintf format to apply to $method
-     * @param string $opts.alternative-format
-     *  The sprintf format to apply to $alternative
-     * @param string $opts.removal-format
-     *  The sprintf format to apply to $opts.removal-version
-     * @param string $opts.removal-version
-     *  The Symphony version at which the removal is planned
-     * @param boolean $opts.write-to-log
-     *  If set to true, this message will be immediately written to the log. By default
-     *  this is set to false, which means that it will only be added to the array ready
-     *  for writing
-     * @param boolean $opts.addbreak
-     *  To be used in conjunction with `$opts.write-to-log`, this will add a line break
-     *  before writing this message in the log file. Defaults to true.
-     * @param boolean $opts.append
-     *  If set to true, the given `$message` will be append to the previous log
-     *  message found in the `$_log` array
-     * @param boolean $opts.addtrace
-     *  If set to true, the caller of the function will be added. Defaults to true.
      * @return boolean|null
      *  If `$writeToLog` is passed, this function will return boolean, otherwise
      *  void

symphony/lib/core/class.symphony.php

Doc Comments +2 added lines, -2 removed lines

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