symphonycms / symphony-2

symphony/lib/toolkit/events/class.event.section.php

Doc Comments +3 added lines, -3 removed lines

@@ -55,7 +55,7 @@ 
          * the XML.
          *
          * @throws Exception
-         * @return XMLElement|void
+         * @return XMLElement
          *  If `$_REQUEST{'redirect']` is set, and the Event executed successfully,
          *  the user will be redirected to the given location. If `$_REQUEST['redirect']`
          *  is not set, or the Event encountered errors, an XMLElement of the Event
@@ -178,7 +178,7 @@ 
          *  If this Event is editing an existing entry, that Entry ID will
          *  be passed to this function.
          * @throws Exception
-         * @return XMLElement
+         * @return boolean
          *  The result of the Event
          */
         public function __doit(array $fields = array(), XMLElement &$result, $position = null, $entry_id = null)
@@ -392,7 +392,7 @@ 
          * @param XMLElement $result
          * @param array $fields
          * @param array $errors
-         * @param object $post_values
+         * @param XMLElement $post_values
          * @throws Exception
          * @return XMLElement
          */

symphony/lib/toolkit/fields/field.author.php

Doc Comments +3 added lines

@@ -27,6 +27,9 @@
             Definition:
         -------------------------------------------------------------------------*/
 
+        /**
+         * @param string $field
+         */
         public function set($field, $value)
         {
             if ($field === 'author_types' && !is_array($value)) {

symphony/lib/toolkit/fields/field.date.php

Doc Comments +7 added lines

@@ -480,6 +480,9 @@ 
             );
         }
 
+        /**
+         * @param integer $entry_id
+         */
         public function processRawFieldData($data, &$status, &$message = null, $simulate = false, $entry_id = null)
         {
             $status = self::__OK__;
@@ -569,6 +572,10 @@ 
             );
         }
 
+        /**
+         * @param string $joins
+         * @param string $where
+         */
         public function buildDSRetrievalSQL($data, &$joins, &$where, $andOperation = false)
         {
             if (self::isFilterRegex($data[0])) {

symphony/lib/toolkit/fields/field.input.php

Doc Comments +9 added lines

@@ -169,6 +169,9 @@ 
             Publish:
         -------------------------------------------------------------------------*/
 
+        /**
+         * @param string $data
+         */
         private function __applyValidationRules($data)
         {
             $rule = $this->get('validator');
@@ -205,6 +208,9 @@ 
             );
         }
 
+        /**
+         * @param string $value
+         */
         private function __replaceAmpersands($value)
         {
             return preg_replace('/&(?!(#[0-9]+|#x[0-9a-f]+|amp|lt|gt);)/i', '&', trim($value));
@@ -240,6 +246,9 @@ 
             );
         }
 
+        /**
+         * @param integer $entry_id
+         */
         public function processRawFieldData($data, &$status, &$message = null, $simulate = false, $entry_id = null)
         {
             $status = self::__OK__;

symphony/lib/toolkit/fields/field.taglist.php

Doc Comments +7 added lines

@@ -25,6 +25,10 @@ 
             Definition:
         -------------------------------------------------------------------------*/
 
+        /**
+         * @param string $field
+         * @param string $value
+         */
         public function set($field, $value)
         {
             if ($field === 'pre_populate_source' && !is_array($value)) {
@@ -584,6 +588,9 @@ 
             );
         }
 
+        /**
+         * @param integer $entry_id
+         */
         public function processRawFieldData($data, &$status, &$message = null, $simulate = false, $entry_id = null)
         {
             $status = self::__OK__;

symphony/lib/toolkit/fields/field.textarea.php

Doc Comments +3 added lines

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

symphony/lib/toolkit/fields/field.upload.php

Doc Comments +9 added lines

@@ -374,6 +374,9 @@ 
             return $this->validateFilename($data['name'], $message);
         }
 
+        /**
+         * @param string $file
+         */
         public function validateFilename($file, &$message)
         {
             if ($this->get('validator') !== null) {
@@ -506,6 +509,9 @@ 
             Import:
         -------------------------------------------------------------------------*/
 
+        /**
+         * @param integer $entry_id
+         */
         public function processRawFieldData($data, &$status, &$message = null, $simulate = false, $entry_id = null)
         {
             $status = self::__OK__;
@@ -666,6 +672,9 @@ 
             );
         }
 
+        /**
+         * @param string $file
+         */
         public static function getMetaInfo($file, $type)
         {
             $meta = array();

symphony/lib/core/class.genericexceptionhandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -452,7 +452,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
          */

symphony/lib/core/class.symphony.php

Doc Comments +3 added lines, -3 removed lines

@@ -304,7 +304,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
@@ -690,7 +690,7 @@ 
          * Accessor for the current `$Flash` instance.
          *
          * @since 3.0.0
-         * @return SessionFlash
+         * @return Session
          */
         public static function Flash()
         {
@@ -801,7 +801,7 @@ 
          * Accessor for `self::$exception`.
          *
          * @since Symphony 2.3.2
-         * @return Exception|null
+         * @return Exception
          */
         public static function getException()
         {