symphonycms / symphony-2

symphony/lib/toolkit/class.general.php

Doc Comments +13 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)
@@ -436,7 +436,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)
@@ -453,7 +453,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)
@@ -468,7 +468,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.
      */
@@ -485,7 +485,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.
      */
@@ -682,6 +682,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) {
@@ -900,7 +904,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)
@@ -1100,7 +1104,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
@@ -1152,7 +1156,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)
@@ -1345,6 +1349,7 @@ 
      *  the full path name of the source file to move.
      * @param integer $perm (optional)
      *  the permissions to apply to the moved file. this defaults to 0777.
+     * @param string $dest_name
      * @return boolean
      *  true if the file was moved and its permissions set as required. false otherwise.
      */

symphony/lib/toolkit/class.htmlpage.php

Doc Comments +1 added lines, -1 removed lines

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

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

@@ -22,6 +22,7 @@ 
     /**
      * Constructor takes a message and an associative array to set to
      * `$_error`. The message is passed to the default Exception constructor
+     * @param string $message
      */
     public function __construct($message, array $error = null)
     {
@@ -310,7 +311,7 @@ 
      * Called when the script has finished executing, this closes the MySQL
      * connection
      *
-     * @return boolean
+     * @return boolean|null
      */
     public function close()
     {

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.smtp.php

Doc Comments +2 added lines, -4 removed lines

@@ -125,12 +125,10 @@ 
      *  The from string. Should have the following format: email@domain.tld
      * @param string $to
      *  The email address to send the email to.
-     * @param string $subject
-     *  The subject to send the email to.
      * @param string $message
      * @throws SMTPException
      * @throws Exception
-     * @return boolean
+     * @return boolean|null
      */
     public function sendMail($from, $to, $message)
     {
@@ -392,7 +390,7 @@ 
      *
      * @param string $request
      * @throws SMTPException
-     * @return boolean|integer number of characters written.
+     * @return integer number of characters written.
      */
     protected function _send($request)
     {