symphonycms / symphony-2

symphony/lib/toolkit/class.general.php

Doc Comments +12 added lines, -8 removed lines

@@ -337,7 +337,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)
@@ -398,7 +398,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)
@@ -413,7 +413,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.
          */
@@ -431,7 +431,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.
          */
@@ -629,6 +629,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) {
@@ -848,7 +852,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)
@@ -930,7 +934,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)
@@ -1051,7 +1055,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
@@ -1110,7 +1114,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)

symphony/lib/toolkit/class.htmlpage.php

Doc Comments +1 added lines, -1 removed lines

@@ -298,7 +298,7 @@
          * it is also possible to override the default filters on the resulting string.
          *
          * @link http://php.net/manual/en/filter.filters.php
-         * @param array $exclude
+         * @param string[] $exclude
          *  A simple array with the keys that should be omitted in the resulting
          *  query string.
          * @param integer $filters

symphony/lib/toolkit/class.lang.php

Doc Comments +1 added lines, -1 removed lines

@@ -542,7 +542,7 @@
          * @since Symphony 2.3
          * @param string $string
          *  The string that should be cleaned-up
-         * @return mixed
+         * @return string
          *  Returns the transliterated string
          */
         private static function applyTransliterations($string)

symphony/lib/toolkit/class.mysql.php

Doc Comments +5 added lines, -5 removed lines

@@ -355,7 +355,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()
@@ -382,7 +382,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)
         {
@@ -445,7 +445,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())
         {
@@ -472,7 +472,7 @@ 
          *  which will delete all rows in the $table
          * @param array $params
          * @throws DatabaseException
-         * @return boolean
+         * @return PDOStatement
          */
         public function delete($table, $where = null, array $params = array())
         {
@@ -685,7 +685,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.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)
         {