symphonycms / symphony-2

symphony/lib/core/class.symphony.php

Doc Comments +4 added lines, -4 removed lines

@@ -350,7 +350,7 @@ 
      * Accessor for the current `$Flash` instance.
      *
      * @since 3.0.0
-     * @return SessionFlash
+     * @return Session
      */
     public static function Flash()
     {
@@ -732,7 +732,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
@@ -771,7 +771,7 @@ 
      * Accessor for `self::$exception`.
      *
      * @since Symphony 2.3.2
-     * @return Exception|null
+     * @return Exception
      */
     public static function getException()
     {
@@ -990,7 +990,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 +3 added lines, -3 removed lines

@@ -590,7 +590,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)
@@ -611,7 +611,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)
     {
@@ -670,7 +670,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/fields/field.input.php

Doc Comments +9 added lines

@@ -71,6 +71,9 @@ 
         Utilities:
     -------------------------------------------------------------------------*/
 
+    /**
+     * @param string $data
+     */
     private function __applyValidationRules($data)
     {
         $rule = $this->get('validator');
@@ -78,6 +81,9 @@ 
         return ($rule ? General::validateString($data, $rule) : true);
     }
 
+    /**
+     * @param string $value
+     */
     private function __replaceAmpersands($value)
     {
         return preg_replace('/&(?!(#[0-9]+|#x[0-9a-f]+|amp|lt|gt);)/i', '&', trim($value));
@@ -171,6 +177,9 @@ 
         return self::__OK__;
     }
 
+    /**
+     * @param integer $entry_id
+     */
     public function processRawFieldData($data, &$status, &$message = null, $simulate = false, $entry_id = null)
     {
         $status = self::__OK__;

symphony/lib/toolkit/class.authormanager.php

Doc Comments +3 added lines, -3 removed lines

@@ -27,7 +27,7 @@ 
      * @param array $fields
      *  Associative array of field names => values for the Author object
      * @throws DatabaseException
-     * @return integer|boolean
+     * @return false|string
      *  Returns an Author ID of the created Author on success, false otherwise.
      */
     public static function add(array $fields)
@@ -52,7 +52,7 @@ 
      *  This array does need to contain every value for the author object, it
      *  can just be the changed values.
      * @throws DatabaseException
-     * @return boolean
+     * @return PDOStatement
      */
     public static function edit($id, array $fields)
     {
@@ -65,7 +65,7 @@ 
      * @param integer $id
      *  The ID of the Author that should be deleted
      * @throws DatabaseException
-     * @return boolean
+     * @return PDOStatement
      */
     public static function delete($id)
     {

symphony/lib/toolkit/class.entry.php

Doc Comments +1 added lines, -1 removed lines

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

symphony/lib/toolkit/class.fieldmanager.php

Doc Comments +3 added lines, -3 removed lines

@@ -57,7 +57,7 @@ 
      *
      * @param string $type
      *  The field handle, that is, `field.{$handle}.php`
-     * @return string|boolean
+     * @return string|false
      */
     public static function __getClassPath($type)
     {
@@ -111,7 +111,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)
@@ -138,7 +138,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)

symphony/lib/toolkit/class.pagemanager.php

Doc Comments +6 added lines, -6 removed lines

@@ -22,7 +22,7 @@ 
      * @param array $fields
      *  Associative array of field names => values for the Page
      * @throws DatabaseException
-     * @return integer|boolean
+     * @return false|string
      *  Returns the Page ID of the created Page on success, false otherwise.
      */
     public static function add(array $fields)
@@ -43,7 +43,7 @@ 
      *
      * @param string $handle
      *  The handle of the page
-     * @return integer
+     * @return string
      *  The Page title
      */
     public static function fetchTitleFromHandle($handle)
@@ -62,7 +62,7 @@ 
      *
      * @param string $handle
      *  The handle of the page
-     * @return integer
+     * @return string
      *  The Page ID
      */
     public static function fetchIDFromHandle($handle)
@@ -116,7 +116,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
      */
@@ -512,10 +512,10 @@ 
      *
      * @param integer|array $page_id
      *  The ID of the Page, or an array of ID's
-     * @param array $select (optional)
+     * @param string[] $select (optional)
      *  Accepts an array of columns to return from `tbl_pages`. If omitted,
      *  all columns from the table will be returned.
-     * @return array|null
+     * @return integer|null
      *  An associative array of Page information with the key being the column
      *  name from `tbl_pages` and the value being the data. If multiple Pages
      *  are found, an array of Pages will be returned. If no Pages are found

symphony/lib/toolkit/class.sectionmanager.php

Doc Comments +3 added lines, -3 removed lines

@@ -30,7 +30,7 @@ 
      *    An associative of settings for a section with the key being
      *    a column name from `tbl_sections`
      * @throws DatabaseException
-     * @return integer
+     * @return false|string
      *    The newly created Section's ID
      */
     public static function add(array $settings)
@@ -184,7 +184,7 @@ 
      *
      * @param string $handle
      *  The handle of the section
-     * @return integer
+     * @return string
      *  The Section ID
      */
     public static function fetchIDFromHandle($handle)
@@ -277,7 +277,7 @@ 
      * @param integer $field_id
      *    the field ID of the linked section's linked field.
      * @throws DatabaseException
-     * @return boolean
+     * @return PDOStatement
      */
     public static function removeSectionAssociation($field_id)
     {

install/lib/class.installer.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
          * Overrides the default `initialiseLog()` method and writes
          * logs to manifest/logs/install
          *
-         * @param null $filename
+         * @param string $filename
          * @return boolean|void
          * @throws Exception
          */