symphonycms / symphony-2

symphony/lib/toolkit/class.pagemanager.php

Doc Comments +5 added lines, -5 removed lines

@@ -43,7 +43,7 @@ 
      *
      * @param string $handle
      *  The handle of the page
-     * @return integer
+     * @return string|null
      *  The Page title
      */
     public static function fetchTitleFromHandle($handle)
@@ -62,7 +62,7 @@ 
      *
      * @param string $handle
      *  The handle of the page
-     * @return integer
+     * @return string|null
      *  The Page ID
      */
     public static function fetchIDFromHandle($handle)
@@ -117,7 +117,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
      */
@@ -513,10 +513,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

@@ -418,7 +418,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

@@ -289,7 +289,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 +1 added lines, -1 removed lines

@@ -192,7 +192,7 @@
      *
      * @param string $handle
      *  The handle of the section
-     * @return integer
+     * @return string|null
      *  The Section ID
      */
     public static function fetchIDFromHandle($handle)

symphony/lib/toolkit/class.xmlelement.php

Doc Comments +1 added lines, -1 removed lines

@@ -140,7 +140,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

@@ -20,6 +20,9 @@
         return (is_array($parent_paths) && !empty($parent_paths) ? " AND p.`path` IN ('".implode("', '", $parent_paths)."')" : null);
     }
 
+    /**
+     * @param integer $filter_type
+     */
     public function __processNavigationTypeFilter($filter, $filter_type = Datasource::FILTER_OR)
     {
         $types = preg_split('/'.($filter_type == Datasource::FILTER_AND ? '\+' : '(?<!\\\\),').'\s*/', $filter, -1, PREG_SPLIT_NO_EMPTY);

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

Doc Comments +3 added lines, -4 removed lines

@@ -65,7 +65,7 @@ 
      * @param XMLElement $result
      * @param array $fields
      * @param array $errors
-     * @param object $post_values
+     * @param XMLElement $post_values
      * @throws Exception
      * @return XMLElement
      */
@@ -192,7 +192,6 @@ 
      * Helper method to determine if a field is missing, or if the data
      * provided was invalid. Used in conjunction with `array_reduce`.
      *
-     * @param array $a,
      * @param array $b
      * @return string
      *  'missing' or 'invalid'
@@ -214,7 +213,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
@@ -303,7 +302,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)

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

Doc Comments +3 added lines

@@ -98,6 +98,9 @@
         Utilities:
     -------------------------------------------------------------------------*/
 
+    /**
+     * @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

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