symphonycms / symphony-2

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

symphony/content/content.publish.php

Doc Comments +9 added lines

@@ -127,6 +127,9 @@ 
         return $this->filteringForm;
     }
 
+    /**
+     * @param Section $section
+     */
     public function createFilteringDuplicator($section)
     {
         $div = new XMLElement('div');
@@ -145,6 +148,9 @@ 
         $this->filteringForm->appendChild($div);
     }
 
+    /**
+     * @param XMLElement $wrapper
+     */
     private function createFieldFilters(&$wrapper, $section)
     {
         $filters = $_GET['filter'];
@@ -284,6 +290,9 @@ 
         return $comparisons;
     }
 
+    /**
+     * @param XMLElement $wrapper
+     */
     private function createFilterSuggestions(&$wrapper, $data)
     {
         $ul = new XMLElement('ul');

symphony/lib/toolkit/class.database.php

Doc Comments +1 added lines, -1 removed lines

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

symphony/lib/toolkit/class.field.php

Doc Comments +3 added lines, -3 removed lines

@@ -1222,7 +1222,7 @@ 
      * If the date type is set, only the calendar will be shown in the suggestion dropdown.
      *
      * @since Symphony 2.6.0
-     * @return array
+     * @return string[]
      */
     public function fetchSuggestionTypes()
     {
@@ -1337,7 +1337,7 @@ 
      * @link http://dev.mysql.com/doc/refman/5.5/en/regexp.html
      * @param string $filter
      *  The full filter, eg. `regexp: ^[a-d]`
-     * @param array $columns
+     * @param string[] $columns
      *  The array of columns that need the given `$filter` applied to. The conditions
      *  will be added using `OR`.
      * @param string $joins
@@ -1508,7 +1508,7 @@ 
      *  The data for this field from it's `tbl_entry_data_{id}` table
      * @param integer $entry_id
      *  The optional id of this field entry instance
-     * @return string|array
+     * @return string
      *  The formatted value to be used as the parameter. Note that this can be
      *  an array or a string. When returning multiple values use array, otherwise
      *  use string.

symphony/lib/toolkit/class.mysql.php

Doc Comments +5 added lines, -5 removed lines

@@ -353,7 +353,7 @@ 
      * Returns the last insert ID from the previous query. This is
      * the value from an auto_increment field.
      *
-     * @return integer
+     * @return string
      *  The last interested row's ID
      */
     public function getInsertID()
@@ -380,7 +380,7 @@ 
      *  conflicts. By default this is set to false, which will not update the data and
      *  would return an SQL error
      * @throws DatabaseException
-     * @return boolean
+     * @return PDOStatement
      */
     public function insert(array $fields, $table, $updateOnDuplicate=false)
     {
@@ -443,7 +443,7 @@ 
      *  A WHERE statement for this UPDATE statement, defaults to null
      *  which will update all rows in the $table
      * @param array $params
-     * @return bool
+     * @return PDOStatement
      */
     public function update($fields, $table, $where = null, $params = array())
     {
@@ -469,7 +469,7 @@ 
      *  A WHERE statement for this DELETE statement, defaults to null,
      *  which will delete all rows in the $table
      * @throws DatabaseException
-     * @return boolean
+     * @return PDOStatement
      */
     public function delete($table, $where = null, array $params = array())
     {
@@ -695,7 +695,7 @@ 
      * @throws Exception
      * @param string $sql
      *  A string containing SQL queries delimited by `;`
-     * @return boolean
+     * @return boolean|null
      *  If one of the queries fails, false will be returned and no further queries
      *  will be executed, otherwise true will be returned.
      */

symphony/lib/toolkit/class.general.php

Doc Comments +12 added lines, -8 removed lines

@@ -104,7 +104,7 @@ 
      * @param boolean $isFile (optional)
      *  if this is true, the method will attempt to read from a file, `$data`
      *  instead.
-     * @param mixed $xsltProcessor (optional)
+     * @param XsltProcess $xsltProcessor (optional)
      *  if set, the validation will be done using this XSLT processor rather
      *  than the built in XML parser. the default is null.
      * @param string $encoding (optional)
@@ -491,7 +491,7 @@ 
      *  the string to operate on
      * @param integer $val
      *  the number to compare lengths with
-     * @return string|boolean
+     * @return string
      *  the resulting string or false on failure.
      */
     public static function substrmin($str, $val)
@@ -508,7 +508,7 @@ 
      *  the string to operate on
      * @param integer $val
      *  the number to compare lengths with
-     * @return string|boolean
+     * @return string
      *  the resulting string or false on failure.
      */
     public static function substrmax($str, $val)
@@ -523,7 +523,7 @@ 
      *  the string to extract the characters from.
      * @param integer $num
      *  the number of characters to extract.
-     * @return string|boolean
+     * @return string
      *  a string containing the last `$num` characters of the
      *  input string, or false on failure.
      */
@@ -540,7 +540,7 @@ 
      *  the string to extract the characters from.
      * @param integer $num
      *  the number of characters to extract.
-     * @return string|boolean
+     * @return string
      *  a string containing the last `$num` characters of the
      *  input string, or false on failure.
      */
@@ -737,6 +737,10 @@ 
     public static function getPostData()
     {
         if (!function_exists('merge_file_post_data')) {
+
+            /**
+             * @param string $type
+             */
             function merge_file_post_data($type, array $file, &$post)
             {
                 foreach ($file as $key => $value) {
@@ -955,7 +959,7 @@ 
      *  the path of the file to write.
      * @param mixed $data
      *  the data to write to the file.
-     * @param integer|null $perm (optional)
+     * @param integer $perm (optional)
      *  the permissions as an octal number to set set on the resulting file.
      *  this defaults to 0644 (if omitted or set to null)
      * @param string $mode (optional)
@@ -1156,7 +1160,7 @@ 
      * @param mixed $strip_root (optional)
      *  If null, the full path to the file will be returned, otherwise the value
      *  of `strip_root` will be removed from the file path.
-     * @param array $exclude (optional)
+     * @param string[] $exclude (optional)
      *  ignore directories listed in this array. this defaults to an empty array.
      * @param boolean $ignore_hidden (optional)
      *  ignore hidden directory (i.e.directories that begin with a period). this defaults
@@ -1208,7 +1212,7 @@ 
      * @param string $dir (optional)
      *  the path of the directory to construct the multi-dimensional array
      *  for. this defaults to '.'.
-     * @param array|string $filters (optional)
+     * @param string $filters (optional)
      *  either a regular expression to filter the files by or an array of
      *  files to include.
      * @param boolean $recurse (optional)

install/lib/Installer.php

Doc Comments +1 added lines, -1 removed lines

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

install/lib/InstallerPage.php

Doc Comments +3 added lines

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