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
      */

Braces +2 added lines, -2 removed lines

@@ -140,9 +140,9 @@
             $case = true;
         }
         if($case)
-	{
+        {
             if(class_exists('MongoRegex'))
-	    {
+            {
                 return array($field=>array('$regex'=>new \MongoRegex('/'.$this->var2.'/i')));
             }
             else

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
      */

Braces +4 added lines, -2 removed lines

@@ -247,7 +247,8 @@ 
         $stmt = $this->pdo->query($sql);
         if($stmt === false)
         {
-            if (php_sapi_name() !== "cli") {
+            if (php_sapi_name() !== "cli")
+            {
               error_log('DB query failed. '.print_r($this->pdo->errorInfo(), true));
             }
             return false;
@@ -296,7 +297,8 @@ 
         $sql = "INSERT INTO $tablename ($cols) VALUES ($set);";
         if($this->pdo->exec($sql) === false)
         {
-            if (php_sapi_name() !== "cli") {
+            if (php_sapi_name() !== "cli")
+            {
                 error_log('DB query failed. '.print_r($this->pdo->errorInfo(), true));
             }
             return false;

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
      */

Http/Rest/SerializationMiddleware.php

Doc Comments +3 added lines

@@ -24,6 +24,9 @@
         }
     }
 
+    /**
+     * @param string $param
+     */
     private function getParamFromArrayIfSet($array, $param, $default = null)
     {
         if(isset($array[$param]))

Http/WebPage.php

Doc Comments +3 added lines, -1 removed lines

@@ -78,6 +78,9 @@ 
         $this->loader->addPath($dir, $namespace);
     }
 
+    /**
+     * @param string $name
+     */
     public function setTemplateName($name)
     {
         $this->templateName = $name;
@@ -112,7 +115,6 @@ 
      * Add a JavaScript file from a set of files known to the framework
      *
      * @param string $jsFileID the ID of the JS file
-     * @param boolean $async Can the JS file be loaded asynchronously?
      */
     public function addWellKnownJS($jsFileID)
     {

Braces +2 added lines, -2 removed lines

@@ -22,7 +22,7 @@ 
 
         $twigSettings = array();
         if(\file_exists('/var/php_cache/twig'))
-    	{	
+        {
         	$twigCache = $this->settings->getGlobalSetting('twig_cache', '/var/php_cache/twig');
         	$twigSettings['cache'] = $twigCache;
 		    //$twigSettings = array('cache' => $twigCache, 'debug' => true);
@@ -70,7 +70,7 @@ 
         $this->content['urls']['logoutUrl'] = $this->logoutUrl;
 
 	if($this->user === false || $this->user === null)
-        {
+	{
             if(isset($_SERVER['REQUEST_URI']) && strstr($_SERVER['REQUEST_URI'], 'logout.php') === false)
             {
                 $this->addLink('Login', $this->loginUrl);