BurningFlipside / CommonCode

class.FlipSession.php

Doc Comments +5 added lines

@@ -26,6 +26,7 @@ 
      * Get a variable from the session
      *
      * @SuppressWarnings(PHPMD.Superglobals)
+     * @param string $name
      */
     static function getVar($name, $default = false)
     {
@@ -43,6 +44,7 @@ 
      * Set a variable in the session
      *
      * @SuppressWarnings(PHPMD.Superglobals)
+     * @param string $name
      */
     static function setVar($name, $value)
     {
@@ -146,6 +148,9 @@ 
         }
     }
 
+    /**
+     * @param string $sessionData
+     */
     static function unserializePhpSession($sessionData)
     {
         $res = array();

class.FlipsideCAPTCHA.php

Doc Comments +3 added lines

@@ -69,6 +69,9 @@
         return $data[0]['hint'];
     }
 
+    /**
+     * @return string
+     */
     private function get_answer()
     {
         $dataset = DataSetFactory::get_data_set('profiles');

class.SerializableObject.php

Doc Comments +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
     /**
      * Serialize the object into a format consumable by json_encode
      *
-     * @return mixed The object in a more serialized format
+     * @return SerializableObject The object in a more serialized format
      */
     public function jsonSerialize()
     {

Data/class.FilterClause.php

Doc Comments +6 added lines

@@ -12,11 +12,17 @@
         if($string !== false) $this->process_filter_string($string);
     }
 
+    /**
+     * @param string $needle
+     */
     static function str_startswith($haystack, $needle)
     {
         return substr($haystack, 0, strlen($needle)) === $needle;
     }
 
+    /**
+     * @param boolean $string
+     */
     protected function process_filter_string($string)
     {
         if(self::str_startswith($string, 'substringof') || self::str_startswith($string, 'contains') || 

Data/class.SQLDataSet.php

Doc Comments +3 added lines

@@ -17,6 +17,9 @@
         }
     }
 
+    /**
+     * @param string $sql
+     */
     function _get_row_count_for_query($sql)
     {
         $stmt = $this->pdo->query($sql);

Data/class.SQLDataTable.php

Doc Comments +3 added lines

@@ -6,6 +6,9 @@
     protected $dataset;
     protected $tablename;
 
+    /**
+     * @param SQLDataSet $dataset
+     */
     function __construct($dataset, $tablename)
     {
         $this->dataset   = $dataset;

Email/class.Email.php

Doc Comments +3 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
     /**
      * Who is this email going to
      *
-     * @return array The recipients of the email
+     * @return string The recipients of the email
      */
     public function getToAddresses()
     {
@@ -82,7 +82,7 @@ 
     /**
      * Who is this email going to (CC)
      *
-     * @return array The recipients of the email
+     * @return string The recipients of the email
      */
     public function getCCAddresses()
     {
@@ -92,7 +92,7 @@ 
     /**
      * Who is this email going to (BCC)
      *
-     * @return array The recipients of the email
+     * @return string The recipients of the email
      */
     public function getBCCAddresses()
     {

Email/class.EmailService.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
         return false;
     }
 
+    /**
+     * @param Email $email
+     */
     public function sendEmail($email)
     {
         return false;

LDAP/class.LDAPServer.php

Doc Comments +6 added lines

@@ -117,6 +117,9 @@ 
         $this->connect = false;
     }
 
+    /**
+     * @param string $password
+     */
     function bind($cn=null, $password=null)
     {
         $res = false;
@@ -199,6 +202,9 @@ 
         return $ret;
     }
 
+    /**
+     * @param boolean $filter
+     */
     private function filterToString($filter)
     {
         if($filter === false)