symphonycms / symphony-2

symphony/lib/toolkit/class.pagemanager.php

Doc Comments +6 added lines, -6 removed lines

@@ -23,7 +23,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)
@@ -65,7 +65,7 @@ 
          *
          * @param string $handle
          *  The handle of the page
-         * @return integer
+         * @return string
          *  The Page title
          */
         public static function fetchTitleFromHandle($handle)
@@ -84,7 +84,7 @@ 
          *
          * @param string $handle
          *  The handle of the page
-         * @return integer
+         * @return string
          *  The Page ID
          */
         public static function fetchIDFromHandle($handle)
@@ -478,7 +478,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
          */
@@ -610,10 +610,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.resourcespage.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/toolkit/class.section.php

Doc Comments +1 added lines, -1 removed lines

@@ -293,7 +293,7 @@
          * function.
          *
          * @see toolkit.Field#commit()
-         * @return boolean
+         * @return boolean|null
          *  true if the commit was successful, false otherwise.
          */
         public function commit()

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)
@@ -194,7 +194,7 @@ 
          *
          * @param string $handle
          *  The handle of the section
-         * @return integer
+         * @return string
          *  The Section ID
          */
         public static function fetchIDFromHandle($handle)
@@ -282,7 +282,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)
         {

symphony/lib/toolkit/class.smtp.php

Doc Comments +2 added lines, -2 removed lines

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

symphony/lib/toolkit/class.xmlelement.php

Doc Comments +1 added lines, -1 removed lines

@@ -315,7 +315,7 @@
         /**
          * Accessor for `$_value`
          *
-         * @return string|XMLElement
+         * @return string
          */
         public function getValue()
         {

symphony/lib/toolkit/data-sources/class.datasource.navigation.php

Doc Comments +3 added lines

@@ -60,6 +60,9 @@
             return $result;
         }
 
+        /**
+         * @param integer $filter_type
+         */
         public function __processNavigationTypeFilter($filter, $filter_type = Datasource::FILTER_OR)
         {
             $types = preg_split('/' . ($filter_type === Datasource::FILTER_AND ? '\+' : '(?<!\\\\),') . '\s*/', $filter,

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)) {