BurningFlipside / CommonCode

Auth/class.LDAPCachableObject.php

Doc Comments +24 added lines

@@ -88,6 +88,9 @@ 
         return $this->appendFieldServer($fieldName, $fieldValue);
     }
 
+    /**
+     * @param string $fieldName
+     */
     private function getFieldLocal($fieldName)
     {
         if($this->ldapObj === false)
@@ -101,6 +104,9 @@ 
         return $this->ldapObj[$fieldName];
     }
 
+    /**
+     * @param string $fieldName
+     */
     private function getFieldServer($fieldName)
     {
         $lowerName = strtolower($fieldName);
@@ -111,6 +117,9 @@ 
         return $this->ldapObj->{$lowerName};
     }
 
+    /**
+     * @param string $fieldName
+     */
     private function getFieldLocalSingleValue($fieldName)
     {
         if($this->ldapObj === false)
@@ -128,6 +137,9 @@ 
         return $this->ldapObj[$fieldName];
     }
 
+    /**
+     * @param string $fieldName
+     */
     private function getFieldServerSingleValue($fieldName)
     {
         $lowerName = strtolower($fieldName);
@@ -143,6 +155,9 @@ 
         return $field[0];
     }
 
+    /**
+     * @param string $fieldName
+     */
     private function setFieldServer($fieldName, $fieldValue)
     {
         $obj = array('dn'=>$this->ldapObj->dn);
@@ -159,6 +174,9 @@ 
         return $this->update($obj);
     }
 
+    /**
+     * @param string $fieldName
+     */
     private function appendFieldServer($fieldName, $fieldValue)
     {
         $obj = array('dn'=>$this->ldapObj->dn);
@@ -175,6 +193,9 @@ 
         return $this->update($obj);
     }
 
+    /**
+     * @param string $fieldName
+     */
     private function setFieldLocal($fieldName, $fieldValue)
     {
         if($this->ldapObj === false)
@@ -193,6 +214,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $fieldName
+     */
     private function appendFieldLocal($fieldName, $fieldValue)
     {
         if($this->ldapObj === false)

Auth/class.PendingUser.php

Doc Comments +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
      * We need the ability to obtain the user's unhashed plain text password to allow for it to be sent 
      * to the correct backend which will hash it
      *
-     * @return boolean|string The current password
+     * @return boolean The current password
      */
     public function getPassword()
     {

Auth/class.SQLAuthenticator.php

Doc Comments +7 added lines, -1 removed lines

@@ -140,7 +140,7 @@ 
     /**
      * Get the data table for Pending Users
      *
-     * @return boolean|\Data\DataTable The Pending User Data Table
+     * @return boolean The Pending User Data Table
      */
     private function getPendingUserDataTable()
     {
@@ -213,6 +213,9 @@ 
         return new SQLUser($users[0], $this);
     }
 
+    /**
+     * @param string $dataTableName
+     */
     private function getDataByFilter($dataTableName, $filter, $select, $top, $skip, $orderby)
     {
         $dataTable = $this->getDataTable($dataTableName);
@@ -278,6 +281,9 @@ 
         return $dataTable->count();
     }
 
+    /**
+     * @param \Data\Filter $filter
+     */
     private function searchPendingUsers($filter, $select, $top, $skip, $orderby)
     {
         $userDataTable = $this->getPendingUserDataTable();

class.FlipPage.php

Doc Comments +1 added lines, -1 removed lines

@@ -839,7 +839,7 @@
      *
      * @param string $name The name of the link
      * @param false|string $url The URL to link to
-     * @param false|array $subment Any submenu items for the dropdown
+     * @param false|array $submenu Any submenu items for the dropdown
      */
     public function addLink($name, $url = false, $submenu = false)
     {

Data/class.SQLDataSet.php

Doc Comments +12 added lines

@@ -113,6 +113,9 @@ 
         throw new \Exception('No such table '.$name);
     }
 
+    /**
+     * @param string $tablename
+     */
     function read($tablename, $where = false, $select = '*', $count = false, $skip = false, $sort = false)
     {
         if($select === false)
@@ -158,6 +161,9 @@ 
         return $ret;
     }
 
+    /**
+     * @param string $tablename
+     */
     function update($tablename, $where, $data)
     {
         $set = array();
@@ -180,6 +186,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $tablename
+     */
     function create($tablename, $data)
     {
         $set = array();
@@ -203,6 +212,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $tablename
+     */
     function delete($tablename, $where)
     {
         $sql = "DELETE FROM $tablename WHERE $where";