BurningFlipside / CommonCode

Auth/LDAPCachableObject.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
      *
      * @param string $fieldName The name of the field to retrieve
      *
-     * @return mixed string the value of the field
+     * @return string string the value of the field
      */
     protected function getFieldSingleValue($fieldName)
     {

Auth/User.php

Doc Comments +1 added lines, -1 removed lines

@@ -311,7 +311,7 @@
      *
      * @param stdClass $data The user's new data
      *
-     * @return boolean true if the user's data was changed, false otherwise
+     * @return boolean|null true if the user's data was changed, false otherwise
      */
     public function editUser($data)
     {

AuthProvider.php

Doc Comments +4 added lines, -4 removed lines

@@ -253,10 +253,10 @@
      * Get an array of Auth\PendingUser from a filtered set
      *
      * @param Data\Filter|boolean $filter The filter conditions or false to retreive all
-     * @param array|boolean $select The user fields to obtain or false to obtain all
-     * @param integer|boolean $top The number of users to obtain or false to obtain all
-     * @param integer|boolean $skip The number of users to skip or false to skip none
-     * @param array|boolean $orderby The field to sort by and the method to sort or false to not sort
+     * @param boolean $select The user fields to obtain or false to obtain all
+     * @param boolean $top The number of users to obtain or false to obtain all
+     * @param boolean $skip The number of users to skip or false to skip none
+     * @param boolean $orderby The field to sort by and the method to sort or false to not sort
      * @param string|boolean $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator
      *
      * @return array|boolean An array of Auth\PendingUser objects or false if no pending users were found

Data/FilterClause.php

Doc Comments +1 added lines, -1 removed lines

@@ -176,7 +176,7 @@
      * Convert the right hand side of the filter clause into an Mongo array
      *
      * @param string $op The standard operator
-     * @param string $var The second variable in the operator
+     * @param string $var2 The second variable in the operator
      *
      * @return array An array of mongo operations
      */

Data/SQLDataSet.php

Doc Comments +1 added lines, -1 removed lines

@@ -150,7 +150,7 @@
      * @param string $select The colums to read
      * @param boolean|string $count The number of rows to read
      * @param boolean|string $skip The number of rows to skip over
-     * @param boolean|array $sort The array to sort by or false to not sort
+     * @param boolean $sort The array to sort by or false to not sort
      *
      * @return false|array An array of all the returned records
      */

Email/DBEmail.php

Doc Comments +8 added lines

@@ -44,8 +44,16 @@
         return parent::getSubject();
     }
 
+    /**
+     * @return string
+     */
     public abstract function getSubstituteVars();
 
+    /**
+     * @param boolean $html
+     *
+     * @return string
+     */
     protected function getRawBodyText($html)
     {
         if(isset($this->dbData['body']))

FlipsideCAPTCHA.php

Doc Comments +6 added lines

@@ -108,6 +108,9 @@ 
         $this->wwwUrl = $settings->getGlobalSetting('www_url', 'https://www.burningflipside.com');
     }
 
+    /**
+     * @param string $fieldName
+     */
     protected function getCaptchField($fieldName)
     {
         $dataset = DataSetFactory::getDataSetByName('profiles');
@@ -130,6 +133,9 @@ 
         return $this->getCaptchField('hint');
     }
 
+    /**
+     * @return string
+     */
     private function get_answer()
     {
         return $this->getCaptchField('answer');

Http/FlipAdminPage.php

Doc Comments +3 added lines

@@ -11,6 +11,9 @@
         $this->setTemplateName('admin.html');
     }
 
+    /**
+     * @param string $adminGroup
+     */
     protected function userIsAdmin($adminGroup)
     {
         if($this->user === false || $this->user === null)

Http/Rest/DataTableAPI.php

Doc Comments +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
     /**
      * Create the DataTableAPI for the given DataTable info
      *
-     * @param string $datSetName The name of the DataSet used in the Settings
+     * @param string $dataSetName The name of the DataSet used in the Settings
      * @param string $dataTableName The name of the table in the DataSet
      * @param string|false $primaryKeyName The table primary key. Must be specified for update/delete capable tables
      */