nilsteampassnet / TeamPass

includes/libraries/LDAP/adLDAP/classes/adLDAPComputers.php

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
     * @param string $computerName The name of the computer
     * @param string $group The group to check
     * @param bool $recursive Whether to check recursively
-    * @return array
+    * @return boolean
     */
     public function inGroup($computerName, $group, $recursive = NULL) {
         if ($computerName === NULL) { return false; }

Indentation +31 added lines, -31 removed lines

@@ -44,10 +44,10 @@ 
 class adLDAPComputers {
     
     /**
-    * The current adLDAP connection via dependency injection
-    * 
-    * @var adLDAP
-    */
+     * The current adLDAP connection via dependency injection
+     * 
+     * @var adLDAP
+     */
     protected $adldap;
     
     public function __construct(adLDAP $adldap) {
@@ -55,12 +55,12 @@ 
     }
     
     /**
-    * Get information about a specific computer. Returned in a raw array format from AD
-    * 
-    * @param string $computerName The name of the computer
-    * @param array $fields Attributes to return
-    * @return array
-    */
+     * Get information about a specific computer. Returned in a raw array format from AD
+     * 
+     * @param string $computerName The name of the computer
+     * @param array $fields Attributes to return
+     * @return array
+     */
     public function info($computerName, $fields = NULL) {
         if ($computerName === NULL) { return false; }
         if (!$this->adldap->getLdapBind()) { return false; }
@@ -76,12 +76,12 @@ 
     }
     
     /**
-    * Find information about the computers. Returned in a raw array format from AD
-    * 
-    * @param string $computerName The name of the computer
-    * @param array $fields Array of parameters to query
-    * @return mixed
-    */
+     * Find information about the computers. Returned in a raw array format from AD
+     * 
+     * @param string $computerName The name of the computer
+     * @param array $fields Array of parameters to query
+     * @return mixed
+     */
     public function infoCollection($computerName, $fields = NULL) {
         if ($computerName === NULL) { return false; }
         if (!$this->adldap->getLdapBind()) { return false; }
@@ -96,13 +96,13 @@ 
     }
     
     /**
-    * Check if a computer is in a group
-    * 
-    * @param string $computerName The name of the computer
-    * @param string $group The group to check
-    * @param bool $recursive Whether to check recursively
-    * @return array
-    */
+     * Check if a computer is in a group
+     * 
+     * @param string $computerName The name of the computer
+     * @param string $group The group to check
+     * @param bool $recursive Whether to check recursively
+     * @return array
+     */
     public function inGroup($computerName, $group, $recursive = NULL) {
         if ($computerName === NULL) { return false; }
         if ($group === NULL) { return false; }
@@ -120,12 +120,12 @@ 
     }
     
     /**
-    * Get the groups a computer is in
-    * 
-    * @param string $computerName The name of the computer
-    * @param bool $recursive Whether to check recursively
-    * @return array
-    */
+     * Get the groups a computer is in
+     * 
+     * @param string $computerName The name of the computer
+     * @param bool $recursive Whether to check recursively
+     * @return array
+     */
     public function groups($computerName, $recursive = NULL) {
         if ($computerName === NULL) { return false; }
         if ($recursive === NULL) { $recursive = $this->adldap->getRecursiveGroups(); } //use the default option if they haven't set it
@@ -137,8 +137,8 @@ 
 
         if ($recursive === true) {
             foreach ($groups as $id => $groupName){
-              $extraGroups = $this->adldap->group()->recursiveGroups($groupName);
-              $groups = array_merge($groups, $extraGroups);
+                $extraGroups = $this->adldap->group()->recursiveGroups($groupName);
+                $groups = array_merge($groups, $extraGroups);
             }
         }
         return $groups;

Spacing +6 added lines, -6 removed lines

@@ -35,8 +35,8 @@ 
  * @version 5.0.0
  * @link http://github.com/adldap/adLDAP
  */
-require_once(dirname(__FILE__) . '/../adLDAP.php');
-require_once(dirname(__FILE__) . '/../collections/adLDAPComputerCollection.php');  
+require_once(dirname(__FILE__).'/../adLDAP.php');
+require_once(dirname(__FILE__).'/../collections/adLDAPComputerCollection.php');  
 
 /**
 * COMPUTER MANAGEMENT FUNCTIONS
@@ -65,9 +65,9 @@ 
         if ($computerName === NULL) { return false; }
         if (!$this->adldap->getLdapBind()) { return false; }
 
-        $filter = "(&(objectClass=computer)(cn=" . $computerName . "))";
+        $filter = "(&(objectClass=computer)(cn=".$computerName."))";
         if ($fields === NULL) { 
-            $fields = array("memberof","cn","displayname","dnshostname","distinguishedname","objectcategory","operatingsystem","operatingsystemservicepack","operatingsystemversion"); 
+            $fields = array("memberof", "cn", "displayname", "dnshostname", "distinguishedname", "objectcategory", "operatingsystem", "operatingsystemservicepack", "operatingsystemversion"); 
         }
         $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);
         $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
@@ -129,14 +129,14 @@ 
     public function groups($computerName, $recursive = NULL) {
         if ($computerName === NULL) { return false; }
         if ($recursive === NULL) { $recursive = $this->adldap->getRecursiveGroups(); } //use the default option if they haven't set it
-        if (!$this->adldap->getLdapBind()){ return false; }
+        if (!$this->adldap->getLdapBind()) { return false; }
 
         //search the directory for their information
         $info = @$this->info($computerName, array("memberof", "primarygroupid"));
         $groups = $this->adldap->utilities()->niceNames($info[0]["memberof"]); //presuming the entry returned is our guy (unique usernames)
 
         if ($recursive === true) {
-            foreach ($groups as $id => $groupName){
+            foreach ($groups as $id => $groupName) {
               $extraGroups = $this->adldap->group()->recursiveGroups($groupName);
               $groups = array_merge($groups, $extraGroups);
             }

includes/libraries/LDAP/adLDAP/classes/adLDAPContacts.php

Doc Comments +9 added lines, -9 removed lines

@@ -58,7 +58,7 @@ 
     * Create a contact
     * 
     * @param array $attributes The attributes to set to the contact
-    * @return bool
+    * @return string|boolean
     */
     public function create($attributes) {
         // Check for compulsory fields
@@ -95,7 +95,7 @@ 
     /**
     * Determine the list of groups a contact is a member of
     * 
-    * @param string $distinguisedname The full DN of a contact
+    * @param string $distinguishedName The full DN of a contact
     * @param bool $recursive Recursively check groups
     * @return array
     */
@@ -120,7 +120,7 @@ 
     /**
     * Get contact information. Returned in a raw array format from AD
     * 
-    * @param string $distinguisedname The full DN of a contact
+    * @param string $distinguishedName The full DN of a contact
     * @param array $fields Attributes to be returned
     * @return array
     */
@@ -199,7 +199,7 @@ 
     * 
     * @param string $distinguishedName The contact to query
     * @param array $attributes The attributes to modify.  Note if you set the enabled attribute you must not specify any other attributes
-    * @return bool
+    * @return string|boolean
     */
     public function modify($distinguishedName, $attributes) {
         if ($distinguishedName === NULL) { return "Missing compulsory field [distinguishedname]"; }
@@ -224,7 +224,7 @@ 
     * Delete a contact
     * 
     * @param string $distinguishedName The contact dn to delete (please be careful here!)
-    * @return array
+    * @return boolean
     */
     public function delete($distinguishedName) {
         $result = $this->folder()->delete($distinguishedName);
@@ -271,10 +271,10 @@ 
     * Mail enable a contact
     * Allows email to be sent to them through Exchange
     * 
-    * @param string $distinguishedname The contact to mail enable
-    * @param string $emailaddress The email address to allow emails to be sent through
-    * @param string $mailnickname The mailnickname for the contact in Exchange.  If NULL this will be set to the display name
-    * @return bool
+    * @param string $distinguishedName The contact to mail enable
+    * @param string $emailAddress The email address to allow emails to be sent through
+    * @param string $mailNickname The mailnickname for the contact in Exchange.  If NULL this will be set to the display name
+    * @return string|boolean
     */
     public function contactMailEnable($distinguishedName, $emailAddress, $mailNickname = NULL) {
         return $this->adldap->exchange()->contactMailEnable($distinguishedName, $emailAddress, $mailNickname);

Indentation +60 added lines, -60 removed lines

@@ -40,10 +40,10 @@ 
 
 class adLDAPContacts {
     /**
-    * The current adLDAP connection via dependency injection
-    * 
-    * @var adLDAP
-    */
+     * The current adLDAP connection via dependency injection
+     * 
+     * @var adLDAP
+     */
     protected $adldap;
     
     public function __construct(adLDAP $adldap) {
@@ -55,11 +55,11 @@ 
     // * Still work to do in this area, and new functions to write
     
     /**
-    * Create a contact
-    * 
-    * @param array $attributes The attributes to set to the contact
-    * @return bool
-    */
+     * Create a contact
+     * 
+     * @param array $attributes The attributes to set to the contact
+     * @return bool
+     */
     public function create($attributes) {
         // Check for compulsory fields
         if (!array_key_exists("display_name", $attributes)) { return "Missing compulsory field [display_name]"; }
@@ -93,12 +93,12 @@ 
     }  
     
     /**
-    * Determine the list of groups a contact is a member of
-    * 
-    * @param string $distinguisedname The full DN of a contact
-    * @param bool $recursive Recursively check groups
-    * @return array
-    */
+     * Determine the list of groups a contact is a member of
+     * 
+     * @param string $distinguisedname The full DN of a contact
+     * @param bool $recursive Recursively check groups
+     * @return array
+     */
     public function groups($distinguishedName, $recursive = NULL) {
         if ($distinguishedName === NULL) { return false; }
         if ($recursive === NULL) { $recursive = $this->adldap->getRecursiveGroups(); } //use the default option if they haven't set it
@@ -118,12 +118,12 @@ 
     }
     
     /**
-    * Get contact information. Returned in a raw array format from AD
-    * 
-    * @param string $distinguisedname The full DN of a contact
-    * @param array $fields Attributes to be returned
-    * @return array
-    */
+     * Get contact information. Returned in a raw array format from AD
+     * 
+     * @param string $distinguisedname The full DN of a contact
+     * @param array $fields Attributes to be returned
+     * @return array
+     */
     public function info($distinguishedName, $fields = NULL)
     {
         if ($distinguishedName === NULL) { return false; }
@@ -151,12 +151,12 @@ 
     }
     
     /**
-    * Find information about the contacts. Returned in a raw array format from AD
-    * 
-    * @param string $distinguishedName The full DN of a contact 
-    * @param array $fields Array of parameters to query
-    * @return mixed
-    */
+     * Find information about the contacts. Returned in a raw array format from AD
+     * 
+     * @param string $distinguishedName The full DN of a contact 
+     * @param array $fields Array of parameters to query
+     * @return mixed
+     */
     public function infoCollection($distinguishedName, $fields = NULL) {
         if ($distinguishedName === NULL) { return false; }
         if (!$this->adldap->getLdapBind()) { return false; }
@@ -171,13 +171,13 @@ 
     }
     
     /**
-    * Determine if a contact is a member of a group
-    * 
-    * @param string $distinguisedName The full DN of a contact
-    * @param string $group The group name to query
-    * @param bool $recursive Recursively check groups
-    * @return bool
-    */
+     * Determine if a contact is a member of a group
+     * 
+     * @param string $distinguisedName The full DN of a contact
+     * @param string $group The group name to query
+     * @param bool $recursive Recursively check groups
+     * @return bool
+     */
     public function inGroup($distinguisedName, $group, $recursive = NULL) {
         if ($distinguisedName === NULL) { return false; }
         if ($group === NULL) { return false; }
@@ -195,12 +195,12 @@ 
     }          
 
     /**
-    * Modify a contact
-    * 
-    * @param string $distinguishedName The contact to query
-    * @param array $attributes The attributes to modify.  Note if you set the enabled attribute you must not specify any other attributes
-    * @return bool
-    */
+     * Modify a contact
+     * 
+     * @param string $distinguishedName The contact to query
+     * @param array $attributes The attributes to modify.  Note if you set the enabled attribute you must not specify any other attributes
+     * @return bool
+     */
     public function modify($distinguishedName, $attributes) {
         if ($distinguishedName === NULL) { return "Missing compulsory field [distinguishedname]"; }
         
@@ -221,11 +221,11 @@ 
     }
     
     /**
-    * Delete a contact
-    * 
-    * @param string $distinguishedName The contact dn to delete (please be careful here!)
-    * @return array
-    */
+     * Delete a contact
+     * 
+     * @param string $distinguishedName The contact dn to delete (please be careful here!)
+     * @return array
+     */
     public function delete($distinguishedName) {
         $result = $this->folder()->delete($distinguishedName);
         if ($result != true) { 
@@ -235,13 +235,13 @@ 
     }
     
     /**
-    * Return a list of all contacts
-    * 
-    * @param bool $includeDescription Include a description of a contact
-    * @param string $search The search parameters
-    * @param bool $sorted Whether to sort the results
-    * @return array
-    */
+     * Return a list of all contacts
+     * 
+     * @param bool $includeDescription Include a description of a contact
+     * @param string $search The search parameters
+     * @param bool $sorted Whether to sort the results
+     * @return array
+     */
     public function all($includeDescription = false, $search = "*", $sorted = true) {
         if (!$this->adldap->getLdapBind()) { return false; }
         
@@ -268,14 +268,14 @@ 
     }
     
     /**
-    * Mail enable a contact
-    * Allows email to be sent to them through Exchange
-    * 
-    * @param string $distinguishedname The contact to mail enable
-    * @param string $emailaddress The email address to allow emails to be sent through
-    * @param string $mailnickname The mailnickname for the contact in Exchange.  If NULL this will be set to the display name
-    * @return bool
-    */
+     * Mail enable a contact
+     * Allows email to be sent to them through Exchange
+     * 
+     * @param string $distinguishedname The contact to mail enable
+     * @param string $emailaddress The email address to allow emails to be sent through
+     * @param string $mailnickname The mailnickname for the contact in Exchange.  If NULL this will be set to the display name
+     * @return bool
+     */
     public function contactMailEnable($distinguishedName, $emailAddress, $mailNickname = NULL) {
         return $this->adldap->exchange()->contactMailEnable($distinguishedName, $emailAddress, $mailNickname);
     }

Spacing +12 added lines, -12 removed lines

@@ -35,8 +35,8 @@ 
  * @version 5.0.0
  * @link http://github.com/adldap/adLDAP
  */
-require_once(dirname(__FILE__) . '/../adLDAP.php');
-require_once(dirname(__FILE__) . '/../collections/adLDAPContactCollection.php');
+require_once(dirname(__FILE__).'/../adLDAP.php');
+require_once(dirname(__FILE__).'/../collections/adLDAPContactCollection.php');
 
 class adLDAPContacts {
     /**
@@ -82,10 +82,10 @@ 
 
         // Determine the container
         $attributes["container"] = array_reverse($attributes["container"]);
-        $container= "OU=" . implode(",OU=", $attributes["container"]);
+        $container = "OU=".implode(",OU=", $attributes["container"]);
 
         // Add the entry
-        $result = @ldap_add($this->adldap->getLdapConnection(), "CN=" . $this->adldap->utilities()->escapeCharacters($add["cn"][0]) . ", " . $container . "," . $this->adldap->getBaseDn(), $add);
+        $result = @ldap_add($this->adldap->getLdapConnection(), "CN=".$this->adldap->utilities()->escapeCharacters($add["cn"][0]).", ".$container.",".$this->adldap->getBaseDn(), $add);
         if ($result != true) { 
             return false; 
         }
@@ -102,7 +102,7 @@ 
     public function groups($distinguishedName, $recursive = NULL) {
         if ($distinguishedName === NULL) { return false; }
         if ($recursive === NULL) { $recursive = $this->adldap->getRecursiveGroups(); } //use the default option if they haven't set it
-        if (!$this->adldap->getLdapBind()){ return false; }
+        if (!$this->adldap->getLdapBind()) { return false; }
         
         // Search the directory for their information
         $info = @$this->info($distinguishedName, array("memberof", "primarygroupid"));
@@ -129,7 +129,7 @@ 
         if ($distinguishedName === NULL) { return false; }
         if (!$this->adldap->getLdapBind()) { return false; }
 
-        $filter = "distinguishedName=" . $this->adldap->utilities()->ldapSlashes($distinguishedName);
+        $filter = "distinguishedName=".$this->adldap->utilities()->ldapSlashes($distinguishedName);
         if ($fields === NULL) { 
             $fields = array("distinguishedname", "mail", "memberof", "department", "displayname", "telephonenumber", "primarygroupid", "objectsid"); 
         }
@@ -142,7 +142,7 @@ 
                 //$entries[0]["memberof"][]=$this->group_cn($entries[0]["primarygroupid"][0]);
                 $entries[0]["memberof"][] = $this->adldap->group()->getPrimaryGroup($entries[0]["primarygroupid"][0], $entries[0]["objectsid"][0]);
             } else {
-                $entries[0]["memberof"][] = "CN=Domain Users,CN=Users," . $this->adldap->getBaseDn();
+                $entries[0]["memberof"][] = "CN=Domain Users,CN=Users,".$this->adldap->getBaseDn();
             }
         }
         
@@ -246,16 +246,16 @@ 
         if (!$this->adldap->getLdapBind()) { return false; }
         
         // Perform the search and grab all their details
-        $filter = "(&(objectClass=contact)(cn=" . $search . "))";
-        $fields = array("displayname","distinguishedname");           
+        $filter = "(&(objectClass=contact)(cn=".$search."))";
+        $fields = array("displayname", "distinguishedname");           
         $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);
         $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
 
         $usersArray = array();
-        for ($i=0; $i<$entries["count"]; $i++) {
-            if ($includeDescription && strlen($entries[$i]["displayname"][0])>0){
+        for ($i = 0; $i < $entries["count"]; $i++) {
+            if ($includeDescription && strlen($entries[$i]["displayname"][0]) > 0) {
                 $usersArray[$entries[$i]["distinguishedname"][0]] = $entries[$i]["displayname"][0];
-            } elseif ($includeDescription){
+            } elseif ($includeDescription) {
                 $usersArray[$entries[$i]["distinguishedname"][0]] = $entries[$i]["distinguishedname"][0];
             } else {
                 array_push($usersArray, $entries[$i]["distinguishedname"][0]);

includes/libraries/LDAP/adLDAP/classes/adLDAPExchange.php

Doc Comments +6 added lines, -6 removed lines

@@ -60,10 +60,10 @@ 
     *                            If the storage group has a different base_dn to the adLDAP configuration, set it using $base_dn
     * @param string $emailAddress The primary email address to add to this user
     * @param string $mailNickname The mail nick name.  If mail nickname is blank, the username will be used
-    * @param bool $mdbUseDefaults Indicates whether the store should use the default quota, rather than the per-mailbox quota.
+    * @param bool $useDefaults Indicates whether the store should use the default quota, rather than the per-mailbox quota.
     * @param string $baseDn Specify an alternative base_dn for the Exchange storage group
     * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
+    * @return string|boolean
     */
     public function createMailbox($username, $storageGroup, $emailAddress, $mailNickname=NULL, $useDefaults=TRUE, $baseDn=NULL, $isGUID=false) {
         if ($username === NULL){  return "Missing compulsory field [username]"; }     
@@ -108,7 +108,7 @@ 
     * @param string $surname Surname
     * @param string $givenName Given name
     * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
+    * @return string|boolean
     */
     public function addX400($username, $country, $admd, $pdmd, $org, $surname, $givenName, $isGUID=false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }     
@@ -145,7 +145,7 @@ 
     * @param string $emailAddress The email address to add to this user
     * @param bool $default Make this email address the default address, this is a bit more intensive as we have to demote any existing default addresses
     * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
+    * @return string|boolean
     */
     public function addAddress($username, $emailAddress, $default = FALSE, $isGUID = false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }     
@@ -210,7 +210,7 @@ 
     * @param string $username The username of the user to add the Exchange account to
     * @param string $emailAddress The email address to add to this user
     * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
+    * @return string|boolean
     */
     public function deleteAddress($username, $emailAddress, $isGUID=false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }     
@@ -288,7 +288,7 @@ 
     * @param string $distinguishedName The contact to mail enable
     * @param string $emailAddress The email address to allow emails to be sent through
     * @param string $mailNickname The mailnickname for the contact in Exchange.  If NULL this will be set to the display name
-    * @return bool
+    * @return string|boolean
     */
     public function contactMailEnable($distinguishedName, $emailAddress, $mailNickname = NULL) {
         if ($distinguishedName === NULL) { return "Missing compulsory field [distinguishedName]"; }   

Indentation +80 added lines, -80 removed lines

@@ -42,10 +42,10 @@ 
 */
 class adLDAPExchange {
     /**
-    * The current adLDAP connection via dependency injection
-    * 
-    * @var adLDAP
-    */
+     * The current adLDAP connection via dependency injection
+     * 
+     * @var adLDAP
+     */
     protected $adldap;
     
     public function __construct(adLDAP $adldap) {
@@ -53,18 +53,18 @@ 
     }
     
     /**
-    * Create an Exchange account
-    * 
-    * @param string $username The username of the user to add the Exchange account to
-    * @param array $storageGroup The mailbox, Exchange Storage Group, for the user account, this must be a full CN
-    *                            If the storage group has a different base_dn to the adLDAP configuration, set it using $base_dn
-    * @param string $emailAddress The primary email address to add to this user
-    * @param string $mailNickname The mail nick name.  If mail nickname is blank, the username will be used
-    * @param bool $mdbUseDefaults Indicates whether the store should use the default quota, rather than the per-mailbox quota.
-    * @param string $baseDn Specify an alternative base_dn for the Exchange storage group
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
+     * Create an Exchange account
+     * 
+     * @param string $username The username of the user to add the Exchange account to
+     * @param array $storageGroup The mailbox, Exchange Storage Group, for the user account, this must be a full CN
+     *                            If the storage group has a different base_dn to the adLDAP configuration, set it using $base_dn
+     * @param string $emailAddress The primary email address to add to this user
+     * @param string $mailNickname The mail nick name.  If mail nickname is blank, the username will be used
+     * @param bool $mdbUseDefaults Indicates whether the store should use the default quota, rather than the per-mailbox quota.
+     * @param string $baseDn Specify an alternative base_dn for the Exchange storage group
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return bool
+     */
     public function createMailbox($username, $storageGroup, $emailAddress, $mailNickname=NULL, $useDefaults=TRUE, $baseDn=NULL, $isGUID=false) {
         if ($username === NULL){  return "Missing compulsory field [username]"; }     
         if ($storageGroup === NULL) { return "Missing compulsory array [storagegroup]"; }
@@ -96,20 +96,20 @@ 
     }
     
     /**
-    * Add an X400 address to Exchange
-    * See http://tools.ietf.org/html/rfc1685 for more information.
-    * An X400 Address looks similar to this X400:c=US;a= ;p=Domain;o=Organization;s=Doe;g=John;
-    * 
-    * @param string $username The username of the user to add the X400 to to
-    * @param string $country Country
-    * @param string $admd Administration Management Domain
-    * @param string $pdmd Private Management Domain (often your AD domain)
-    * @param string $org Organization
-    * @param string $surname Surname
-    * @param string $givenName Given name
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
+     * Add an X400 address to Exchange
+     * See http://tools.ietf.org/html/rfc1685 for more information.
+     * An X400 Address looks similar to this X400:c=US;a= ;p=Domain;o=Organization;s=Doe;g=John;
+     * 
+     * @param string $username The username of the user to add the X400 to to
+     * @param string $country Country
+     * @param string $admd Administration Management Domain
+     * @param string $pdmd Private Management Domain (often your AD domain)
+     * @param string $org Organization
+     * @param string $surname Surname
+     * @param string $givenName Given name
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return bool
+     */
     public function addX400($username, $country, $admd, $pdmd, $org, $surname, $givenName, $isGUID=false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }     
         
@@ -139,14 +139,14 @@ 
     }
     
     /**
-    * Add an address to Exchange
-    * 
-    * @param string $username The username of the user to add the Exchange account to
-    * @param string $emailAddress The email address to add to this user
-    * @param bool $default Make this email address the default address, this is a bit more intensive as we have to demote any existing default addresses
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
+     * Add an address to Exchange
+     * 
+     * @param string $username The username of the user to add the Exchange account to
+     * @param string $emailAddress The email address to add to this user
+     * @param bool $default Make this email address the default address, this is a bit more intensive as we have to demote any existing default addresses
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return bool
+     */
     public function addAddress($username, $emailAddress, $default = FALSE, $isGUID = false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }     
         if ($emailAddress === NULL) { return "Missing compulsory fields [emailAddress]"; }
@@ -203,15 +203,15 @@ 
     }
     
     /**
-    * Remove an address to Exchange
-    * If you remove a default address the account will no longer have a default, 
-    * we recommend changing the default address first
-    * 
-    * @param string $username The username of the user to add the Exchange account to
-    * @param string $emailAddress The email address to add to this user
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
+     * Remove an address to Exchange
+     * If you remove a default address the account will no longer have a default, 
+     * we recommend changing the default address first
+     * 
+     * @param string $username The username of the user to add the Exchange account to
+     * @param string $emailAddress The email address to add to this user
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return bool
+     */
     public function deleteAddress($username, $emailAddress, $isGUID=false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }     
         if ($emailAddress === NULL) { return "Missing compulsory fields [emailAddress]"; }
@@ -243,13 +243,13 @@ 
         }
     }
     /**
-    * Change the default address
-    * 
-    * @param string $username The username of the user to add the Exchange account to
-    * @param string $emailAddress The email address to make default
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
+     * Change the default address
+     * 
+     * @param string $username The username of the user to add the Exchange account to
+     * @param string $emailAddress The email address to make default
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return bool
+     */
     public function primaryAddress($username, $emailAddress, $isGUID = false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }     
         if ($emailAddress === NULL) { return "Missing compulsory fields [emailAddress]"; }
@@ -282,14 +282,14 @@ 
     }
     
     /**
-    * Mail enable a contact
-    * Allows email to be sent to them through Exchange
-    * 
-    * @param string $distinguishedName The contact to mail enable
-    * @param string $emailAddress The email address to allow emails to be sent through
-    * @param string $mailNickname The mailnickname for the contact in Exchange.  If NULL this will be set to the display name
-    * @return bool
-    */
+     * Mail enable a contact
+     * Allows email to be sent to them through Exchange
+     * 
+     * @param string $distinguishedName The contact to mail enable
+     * @param string $emailAddress The email address to allow emails to be sent through
+     * @param string $mailNickname The mailnickname for the contact in Exchange.  If NULL this will be set to the display name
+     * @return bool
+     */
     public function contactMailEnable($distinguishedName, $emailAddress, $mailNickname = NULL) {
         if ($distinguishedName === NULL) { return "Missing compulsory field [distinguishedName]"; }   
         if ($emailAddress === NULL) { return "Missing compulsory field [emailAddress]"; }  
@@ -317,11 +317,11 @@ 
     }
     
     /**
-    * Returns a list of Exchange Servers in the ConfigurationNamingContext of the domain
-    * 
-    * @param array $attributes An array of the AD attributes you wish to return
-    * @return array
-    */
+     * Returns a list of Exchange Servers in the ConfigurationNamingContext of the domain
+     * 
+     * @param array $attributes An array of the AD attributes you wish to return
+     * @return array
+     */
     public function servers($attributes = array('cn','distinguishedname','serialnumber')) {
         if (!$this->adldap->getLdapBind()) { return false; }
         
@@ -332,13 +332,13 @@ 
     }
     
     /**
-    * Returns a list of Storage Groups in Exchange for a given mail server
-    * 
-    * @param string $exchangeServer The full DN of an Exchange server.  You can use exchange_servers() to find the DN for your server
-    * @param array $attributes An array of the AD attributes you wish to return
-    * @param bool $recursive If enabled this will automatically query the databases within a storage group
-    * @return array
-    */
+     * Returns a list of Storage Groups in Exchange for a given mail server
+     * 
+     * @param string $exchangeServer The full DN of an Exchange server.  You can use exchange_servers() to find the DN for your server
+     * @param array $attributes An array of the AD attributes you wish to return
+     * @param bool $recursive If enabled this will automatically query the databases within a storage group
+     * @return array
+     */
     public function storageGroups($exchangeServer, $attributes = array('cn','distinguishedname'), $recursive = NULL) {
         if (!$this->adldap->getLdapBind()) { return false; }
         if ($exchangeServer === NULL) { return "Missing compulsory field [exchangeServer]"; }
@@ -357,12 +357,12 @@ 
     }
     
     /**
-    * Returns a list of Databases within any given storage group in Exchange for a given mail server
-    * 
-    * @param string $storageGroup The full DN of an Storage Group.  You can use exchange_storage_groups() to find the DN 
-    * @param array $attributes An array of the AD attributes you wish to return
-    * @return array
-    */
+     * Returns a list of Databases within any given storage group in Exchange for a given mail server
+     * 
+     * @param string $storageGroup The full DN of an Storage Group.  You can use exchange_storage_groups() to find the DN 
+     * @param array $attributes An array of the AD attributes you wish to return
+     * @return array
+     */
     public function storageDatabases($storageGroup, $attributes = array('cn','distinguishedname','displayname')) {
         if (!$this->adldap->getLdapBind()) { return false; }
         if ($storageGroup === NULL) { return "Missing compulsory field [storageGroup]"; }

Spacing +32 added lines, -32 removed lines

@@ -35,7 +35,7 @@ 
  * @version 5.0.0
  * @link http://github.com/adldap/adLDAP
  */
-require_once(dirname(__FILE__) . '/../adLDAP.php');
+require_once(dirname(__FILE__).'/../adLDAP.php');
 
 /**
 * MICROSOFT EXCHANGE FUNCTIONS
@@ -65,8 +65,8 @@ 
     * @param bool $isGUID Is the username passed a GUID or a samAccountName
     * @return bool
     */
-    public function createMailbox($username, $storageGroup, $emailAddress, $mailNickname=NULL, $useDefaults=TRUE, $baseDn=NULL, $isGUID=false) {
-        if ($username === NULL){  return "Missing compulsory field [username]"; }     
+    public function createMailbox($username, $storageGroup, $emailAddress, $mailNickname = NULL, $useDefaults = TRUE, $baseDn = NULL, $isGUID = false) {
+        if ($username === NULL) {  return "Missing compulsory field [username]"; }     
         if ($storageGroup === NULL) { return "Missing compulsory array [storagegroup]"; }
         if (!is_array($storageGroup)) { return "[storagegroup] must be an array"; }
         if ($emailAddress === NULL) { return "Missing compulsory field [emailAddress]"; }
@@ -75,7 +75,7 @@ 
             $baseDn = $this->adldap->getBaseDn();   
         }
         
-        $container = "CN=" . implode(",CN=", $storageGroup);
+        $container = "CN=".implode(",CN=", $storageGroup);
         
         if ($mailNickname === NULL) { 
             $mailNickname = $username; 
@@ -84,7 +84,7 @@ 
         
         $attributes = array(
             'exchange_homemdb'=>$container.",".$baseDn,
-            'exchange_proxyaddress'=>'SMTP:' . $emailAddress,
+            'exchange_proxyaddress'=>'SMTP:'.$emailAddress,
             'exchange_mailnickname'=>$mailNickname,
             'exchange_usedefaults'=>$mdbUseDefaults
         );
@@ -110,18 +110,18 @@ 
     * @param bool $isGUID Is the username passed a GUID or a samAccountName
     * @return bool
     */
-    public function addX400($username, $country, $admd, $pdmd, $org, $surname, $givenName, $isGUID=false) {
+    public function addX400($username, $country, $admd, $pdmd, $org, $surname, $givenName, $isGUID = false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }     
         
         $proxyValue = 'X400:';
             
         // Find the dn of the user
-        $user = $this->adldap->user()->info($username, array("cn","proxyaddresses"), $isGUID);
+        $user = $this->adldap->user()->info($username, array("cn", "proxyaddresses"), $isGUID);
         if ($user[0]["dn"] === NULL) { return false; }
         $userDn = $user[0]["dn"];
         
         // We do not have to demote an email address from the default so we can just add the new proxy address
-        $attributes['exchange_proxyaddress'] = $proxyValue . 'c=' . $country . ';a=' . $admd . ';p=' . $pdmd . ';o=' . $org . ';s=' . $surname . ';g=' . $givenName . ';';
+        $attributes['exchange_proxyaddress'] = $proxyValue.'c='.$country.';a='.$admd.';p='.$pdmd.';o='.$org.';s='.$surname.';g='.$givenName.';';
        
         // Translate the update to the LDAP schema                
         $add = $this->adldap->adldap_schema($attributes);
@@ -157,14 +157,14 @@ 
         }
               
         // Find the dn of the user
-        $user = $this->adldap->user()->info($username, array("cn","proxyaddresses"), $isGUID);
-        if ($user[0]["dn"] === NULL){ return false; }
+        $user = $this->adldap->user()->info($username, array("cn", "proxyaddresses"), $isGUID);
+        if ($user[0]["dn"] === NULL) { return false; }
         $userDn = $user[0]["dn"];
         
         // We need to scan existing proxy addresses and demote the default one
         if (is_array($user[0]["proxyaddresses"]) && $default === true) {
             $modAddresses = array();
-            for ($i=0;$i<$user[0]['proxyaddresses']['count'];$i++) {
+            for ($i = 0; $i < $user[0]['proxyaddresses']['count']; $i++) {
                 if (strpos($user[0]['proxyaddresses'][$i], 'SMTP:') !== false) {
                     $user[0]['proxyaddresses'][$i] = str_replace('SMTP:', 'smtp:', $user[0]['proxyaddresses'][$i]);
                 }
@@ -172,7 +172,7 @@ 
                     $modAddresses['proxyAddresses'][$i] = $user[0]['proxyaddresses'][$i];
                 }
             }
-            $modAddresses['proxyAddresses'][($user[0]['proxyaddresses']['count']-1)] = 'SMTP:' . $emailAddress;
+            $modAddresses['proxyAddresses'][($user[0]['proxyaddresses']['count'] - 1)] = 'SMTP:'.$emailAddress;
             
             $result = @ldap_mod_replace($this->adldap->getLdapConnection(), $userDn, $modAddresses);
             if ($result == false) { 
@@ -182,7 +182,7 @@ 
         }
         else {
             // We do not have to demote an email address from the default so we can just add the new proxy address
-            $attributes['exchange_proxyaddress'] = $proxyValue . $emailAddress;
+            $attributes['exchange_proxyaddress'] = $proxyValue.$emailAddress;
             
             // Translate the update to the LDAP schema                
             $add = $this->adldap->adldap_schema($attributes);
@@ -194,7 +194,7 @@ 
             // Do the update
             // Take out the @ to see any errors, usually this error might occur because the address already
             // exists in the list of proxyAddresses
-            $result = @ldap_mod_add($this->adldap->getLdapConnection(), $userDn,$add);
+            $result = @ldap_mod_add($this->adldap->getLdapConnection(), $userDn, $add);
             if ($result == false) { 
                 return false; 
             }
@@ -212,27 +212,27 @@ 
     * @param bool $isGUID Is the username passed a GUID or a samAccountName
     * @return bool
     */
-    public function deleteAddress($username, $emailAddress, $isGUID=false) {
+    public function deleteAddress($username, $emailAddress, $isGUID = false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }     
         if ($emailAddress === NULL) { return "Missing compulsory fields [emailAddress]"; }
         
         // Find the dn of the user
-        $user = $this->adldap->user()->info($username, array("cn","proxyaddresses"), $isGUID);
+        $user = $this->adldap->user()->info($username, array("cn", "proxyaddresses"), $isGUID);
         if ($user[0]["dn"] === NULL) { return false; }
         $userDn = $user[0]["dn"];
         
         if (is_array($user[0]["proxyaddresses"])) {
             $mod = array();
-            for ($i=0;$i<$user[0]['proxyaddresses']['count'];$i++) {
-                if (strpos($user[0]['proxyaddresses'][$i], 'SMTP:') !== false && $user[0]['proxyaddresses'][$i] == 'SMTP:' . $emailAddress) {
-                    $mod['proxyAddresses'][0] = 'SMTP:' . $emailAddress;
+            for ($i = 0; $i < $user[0]['proxyaddresses']['count']; $i++) {
+                if (strpos($user[0]['proxyaddresses'][$i], 'SMTP:') !== false && $user[0]['proxyaddresses'][$i] == 'SMTP:'.$emailAddress) {
+                    $mod['proxyAddresses'][0] = 'SMTP:'.$emailAddress;
                 }
-                elseif (strpos($user[0]['proxyaddresses'][$i], 'smtp:') !== false && $user[0]['proxyaddresses'][$i] == 'smtp:' . $emailAddress) {
-                    $mod['proxyAddresses'][0] = 'smtp:' . $emailAddress;
+                elseif (strpos($user[0]['proxyaddresses'][$i], 'smtp:') !== false && $user[0]['proxyaddresses'][$i] == 'smtp:'.$emailAddress) {
+                    $mod['proxyAddresses'][0] = 'smtp:'.$emailAddress;
                 }
             }
             
-            $result = @ldap_mod_del($this->adldap->getLdapConnection(), $userDn,$mod);
+            $result = @ldap_mod_del($this->adldap->getLdapConnection(), $userDn, $mod);
             if ($result == false) { 
                 return false; 
             }     
@@ -255,17 +255,17 @@ 
         if ($emailAddress === NULL) { return "Missing compulsory fields [emailAddress]"; }
         
         // Find the dn of the user
-        $user = $this->adldap->user()->info($username, array("cn","proxyaddresses"), $isGUID);
+        $user = $this->adldap->user()->info($username, array("cn", "proxyaddresses"), $isGUID);
         if ($user[0]["dn"] === NULL) { return false; }
         $userDn = $user[0]["dn"];
         
         if (is_array($user[0]["proxyaddresses"])) {
             $modAddresses = array();
-            for ($i=0;$i<$user[0]['proxyaddresses']['count'];$i++) {
+            for ($i = 0; $i < $user[0]['proxyaddresses']['count']; $i++) {
                 if (strpos($user[0]['proxyaddresses'][$i], 'SMTP:') !== false) {
                     $user[0]['proxyaddresses'][$i] = str_replace('SMTP:', 'smtp:', $user[0]['proxyaddresses'][$i]);
                 }
-                if ($user[0]['proxyaddresses'][$i] == 'smtp:' . $emailAddress) {
+                if ($user[0]['proxyaddresses'][$i] == 'smtp:'.$emailAddress) {
                     $user[0]['proxyaddresses'][$i] = str_replace('smtp:', 'SMTP:', $user[0]['proxyaddresses'][$i]);
                 }
                 if ($user[0]['proxyaddresses'][$i] != '') {
@@ -296,12 +296,12 @@ 
         
         if ($mailNickname !== NULL) {
             // Find the dn of the user
-            $user = $this->adldap->contact()->info($distinguishedName, array("cn","displayname"));
+            $user = $this->adldap->contact()->info($distinguishedName, array("cn", "displayname"));
             if ($user[0]["displayname"] === NULL) { return false; }
             $mailNickname = $user[0]['displayname'][0];
         }
         
-        $attributes = array("email"=>$emailAddress,"contact_email"=>"SMTP:" . $emailAddress,"exchange_proxyaddress"=>"SMTP:" . $emailAddress,"exchange_mailnickname" => $mailNickname);
+        $attributes = array("email"=>$emailAddress, "contact_email"=>"SMTP:".$emailAddress, "exchange_proxyaddress"=>"SMTP:".$emailAddress, "exchange_mailnickname" => $mailNickname);
          
         // Translate the update to the LDAP schema                
         $mod = $this->adldap->adldap_schema($attributes);
@@ -322,11 +322,11 @@ 
     * @param array $attributes An array of the AD attributes you wish to return
     * @return array
     */
-    public function servers($attributes = array('cn','distinguishedname','serialnumber')) {
+    public function servers($attributes = array('cn', 'distinguishedname', 'serialnumber')) {
         if (!$this->adldap->getLdapBind()) { return false; }
         
         $configurationNamingContext = $this->adldap->getRootDse(array('configurationnamingcontext'));
-        $sr = @ldap_search($this->adldap->getLdapConnection(), $configurationNamingContext[0]['configurationnamingcontext'][0],'(&(objectCategory=msExchExchangeServer))', $attributes);
+        $sr = @ldap_search($this->adldap->getLdapConnection(), $configurationNamingContext[0]['configurationnamingcontext'][0], '(&(objectCategory=msExchExchangeServer))', $attributes);
         $entries = @ldap_get_entries($this->adldap->getLdapConnection(), $sr);
         return $entries;
     }
@@ -339,7 +339,7 @@ 
     * @param bool $recursive If enabled this will automatically query the databases within a storage group
     * @return array
     */
-    public function storageGroups($exchangeServer, $attributes = array('cn','distinguishedname'), $recursive = NULL) {
+    public function storageGroups($exchangeServer, $attributes = array('cn', 'distinguishedname'), $recursive = NULL) {
         if (!$this->adldap->getLdapBind()) { return false; }
         if ($exchangeServer === NULL) { return "Missing compulsory field [exchangeServer]"; }
         if ($recursive === NULL) { $recursive = $this->adldap->getRecursiveGroups(); }
@@ -349,7 +349,7 @@ 
         $entries = @ldap_get_entries($this->adldap->getLdapConnection(), $sr);
 
         if ($recursive === true) {
-            for ($i=0; $i<$entries['count']; $i++) {
+            for ($i = 0; $i < $entries['count']; $i++) {
                 $entries[$i]['msexchprivatemdb'] = $this->storageDatabases($entries[$i]['distinguishedname'][0]);       
             }
         }
@@ -363,7 +363,7 @@ 
     * @param array $attributes An array of the AD attributes you wish to return
     * @return array
     */
-    public function storageDatabases($storageGroup, $attributes = array('cn','distinguishedname','displayname')) {
+    public function storageDatabases($storageGroup, $attributes = array('cn', 'distinguishedname', 'displayname')) {
         if (!$this->adldap->getLdapBind()) { return false; }
         if ($storageGroup === NULL) { return "Missing compulsory field [storageGroup]"; }
         

Braces +3 added lines, -6 removed lines

@@ -179,8 +179,7 @@ 
                 return false; 
             }
             return true;
-        }
-        else {
+        } else {
             // We do not have to demote an email address from the default so we can just add the new proxy address
             $attributes['exchange_proxyaddress'] = $proxyValue . $emailAddress;
             
@@ -226,8 +225,7 @@ 
             for ($i=0;$i<$user[0]['proxyaddresses']['count'];$i++) {
                 if (strpos($user[0]['proxyaddresses'][$i], 'SMTP:') !== false && $user[0]['proxyaddresses'][$i] == 'SMTP:' . $emailAddress) {
                     $mod['proxyAddresses'][0] = 'SMTP:' . $emailAddress;
-                }
-                elseif (strpos($user[0]['proxyaddresses'][$i], 'smtp:') !== false && $user[0]['proxyaddresses'][$i] == 'smtp:' . $emailAddress) {
+                } elseif (strpos($user[0]['proxyaddresses'][$i], 'smtp:') !== false && $user[0]['proxyaddresses'][$i] == 'smtp:' . $emailAddress) {
                     $mod['proxyAddresses'][0] = 'smtp:' . $emailAddress;
                 }
             }
@@ -237,8 +235,7 @@ 
                 return false; 
             }     
             return true;
-        }
-        else {
+        } else {
             return false;
         }
     }

includes/libraries/LDAP/adLDAP/classes/adLDAPFolders.php

Doc Comments +1 added lines, -1 removed lines

@@ -145,7 +145,7 @@
     * Create an organizational unit
     * 
     * @param array $attributes Default attributes of the ou
-    * @return bool
+    * @return string|boolean
     */
     public function create($attributes) {
         if (!is_array($attributes)) { return "Attributes must be an array"; }

Indentation +26 added lines, -26 removed lines

@@ -42,10 +42,10 @@ 
 */
 class adLDAPFolders {
     /**
-    * The current adLDAP connection via dependency injection
-    * 
-    * @var adLDAP
-    */
+     * The current adLDAP connection via dependency injection
+     * 
+     * @var adLDAP
+     */
     protected $adldap;
     
     public function __construct(adLDAP $adldap) {
@@ -53,12 +53,12 @@ 
     }
     
     /**
-    * Delete a distinguished name from Active Directory
-    * You should never need to call this yourself, just use the wrapper functions user_delete and contact_delete
-    *
-    * @param string $dn The distinguished name to delete
-    * @return bool
-    */
+     * Delete a distinguished name from Active Directory
+     * You should never need to call this yourself, just use the wrapper functions user_delete and contact_delete
+     *
+     * @param string $dn The distinguished name to delete
+     * @return bool
+     */
     public function delete($dn) { 
         $result = ldap_delete($this->adldap->getLdapConnection(), $dn);
         if ($result != true) { 
@@ -68,17 +68,17 @@ 
     }
     
     /**
-    * Returns a folder listing for a specific OU
-    * See http://adldap.sourceforge.net/wiki/doku.php?id=api_folder_functions
-    * 
-    * @param array $folderName An array to the OU you wish to list. 
-    *                           If set to NULL will list the root, strongly recommended to set 
-    *                           $recursive to false in that instance!
-    * @param string $dnType The type of record to list.  This can be ADLDAP_FOLDER or ADLDAP_CONTAINER.
-    * @param bool $recursive Recursively search sub folders
-    * @param bool $type Specify a type of object to search for
-    * @return array
-    */
+     * Returns a folder listing for a specific OU
+     * See http://adldap.sourceforge.net/wiki/doku.php?id=api_folder_functions
+     * 
+     * @param array $folderName An array to the OU you wish to list. 
+     *                           If set to NULL will list the root, strongly recommended to set 
+     *                           $recursive to false in that instance!
+     * @param string $dnType The type of record to list.  This can be ADLDAP_FOLDER or ADLDAP_CONTAINER.
+     * @param bool $recursive Recursively search sub folders
+     * @param bool $type Specify a type of object to search for
+     * @return array
+     */
     public function listing($folderName = NULL, $dnType = adLDAP::ADLDAP_FOLDER, $recursive = NULL, $type = NULL) {
         if ($recursive === NULL) { $recursive = $this->adldap->getRecursiveGroups(); } //use the default option if they haven't set it
         if (!$this->adldap->getLdapBind()) { return false; }
@@ -142,11 +142,11 @@ 
     }
 
     /**
-    * Create an organizational unit
-    * 
-    * @param array $attributes Default attributes of the ou
-    * @return bool
-    */
+     * Create an organizational unit
+     * 
+     * @param array $attributes Default attributes of the ou
+     * @return bool
+     */
     public function create($attributes) {
         if (!is_array($attributes)) { return "Attributes must be an array"; }
         if (!is_array($attributes["container"])) { return "Container attribute must be an array."; }

Spacing +11 added lines, -11 removed lines

@@ -35,7 +35,7 @@ 
  * @version 5.0.0
  * @link http://github.com/adldap/adLDAP
  */
-require_once(dirname(__FILE__) . '/../adLDAP.php');
+require_once(dirname(__FILE__).'/../adLDAP.php');
 
 /**
 * FOLDER / OU MANAGEMENT FUNCTIONS
@@ -116,12 +116,12 @@ 
         // This requires us to not have an OU= part, just the base_dn
         $searchOu = $this->adldap->getBaseDn();
         if (is_array($folderName)) {
-            $ou = $dnType . "=" . implode("," . $dnType . "=", $folderName);
-            $filter .= '(!(distinguishedname=' . $ou . ',' . $this->adldap->getBaseDn() . ')))';
-            $searchOu = $ou . ',' . $this->adldap->getBaseDn();
+            $ou = $dnType."=".implode(",".$dnType."=", $folderName);
+            $filter .= '(!(distinguishedname='.$ou.','.$this->adldap->getBaseDn().')))';
+            $searchOu = $ou.','.$this->adldap->getBaseDn();
         }
         else {
-            $filter .= '(!(distinguishedname=' . $this->adldap->getBaseDn() . ')))';
+            $filter .= '(!(distinguishedname='.$this->adldap->getBaseDn().')))';
         }
 
         if ($recursive === true) {
@@ -150,21 +150,21 @@ 
     public function create($attributes) {
         if (!is_array($attributes)) { return "Attributes must be an array"; }
         if (!is_array($attributes["container"])) { return "Container attribute must be an array."; }
-        if (!array_key_exists("ou_name",$attributes)) { return "Missing compulsory field [ou_name]"; }
-        if (!array_key_exists("container",$attributes)) { return "Missing compulsory field [container]"; }
+        if (!array_key_exists("ou_name", $attributes)) { return "Missing compulsory field [ou_name]"; }
+        if (!array_key_exists("container", $attributes)) { return "Missing compulsory field [container]"; }
         
         $attributes["container"] = array_reverse($attributes["container"]);
 
-        $add=array();
+        $add = array();
         $add["objectClass"] = "organizationalUnit";
         $add["OU"] = $attributes['ou_name'];
         $containers = "";
         if (count($attributes['container']) > 0) {
-            $containers = "OU=" . implode(",OU=", $attributes["container"]) . ",";
+            $containers = "OU=".implode(",OU=", $attributes["container"]).",";
         }
 
-        $containers = "OU=" . implode(",OU=", $attributes["container"]);
-        $result = ldap_add($this->adldap->getLdapConnection(), "OU=" . $add["OU"] . ", " . $containers . $this->adldap->getBaseDn(), $add);
+        $containers = "OU=".implode(",OU=", $attributes["container"]);
+        $result = ldap_add($this->adldap->getLdapConnection(), "OU=".$add["OU"].", ".$containers.$this->adldap->getBaseDn(), $add);
         if ($result != true) { 
             return false; 
         }

Braces +3 added lines, -6 removed lines

@@ -108,8 +108,7 @@ 
                     $filter .= '(objectClass=user)';
                     break;   
             }
-        }
-        else {
+        } else {
             $filter .= '(objectClass=*)';   
         }
         // If the folder name is null then we will search the root level of AD
@@ -119,8 +118,7 @@ 
             $ou = $dnType . "=" . implode("," . $dnType . "=", $folderName);
             $filter .= '(!(distinguishedname=' . $ou . ',' . $this->adldap->getBaseDn() . ')))';
             $searchOu = $ou . ',' . $this->adldap->getBaseDn();
-        }
-        else {
+        } else {
             $filter .= '(!(distinguishedname=' . $this->adldap->getBaseDn() . ')))';
         }
 
@@ -130,8 +128,7 @@ 
             if (is_array($entries)) {
                 return $entries;
             }
-        }
-        else {
+        } else {
             $sr = ldap_list($this->adldap->getLdapConnection(), $searchOu, $filter, array('objectclass', 'distinguishedname', 'samaccountname'));
             $entries = @ldap_get_entries($this->adldap->getLdapConnection(), $sr);
             if (is_array($entries)) {

includes/libraries/LDAP/adLDAP/classes/adLDAPGroups.php

Doc Comments +2 added lines, -2 removed lines

@@ -154,7 +154,7 @@ 
     * Create a group
     * 
     * @param array $attributes Default attributes of the group
-    * @return bool
+    * @return string|boolean
     */
     public function create($attributes) {
         if (!is_array($attributes)) { return "Attributes must be an array"; }
@@ -188,7 +188,7 @@ 
     * 
     * @param string $group The group to delete (please be careful here!) 
     * 
-    * @return array 
+    * @return string|boolean 
     */
     public function delete($group) {
         if (!$this->adldap->getLdapBind()) { return false; }

Indentation +165 added lines, -165 removed lines

@@ -43,10 +43,10 @@ 
 */
 class adLDAPGroups {
     /**
-    * The current adLDAP connection via dependency injection
-    * 
-    * @var adLDAP
-    */
+     * The current adLDAP connection via dependency injection
+     * 
+     * @var adLDAP
+     */
     protected $adldap;
     
     public function __construct(adLDAP $adldap) {
@@ -54,12 +54,12 @@ 
     }
     
     /**
-    * Add a group to a group
-    * 
-    * @param string $parent The parent group name
-    * @param string $child The child group name
-    * @return bool
-    */
+     * Add a group to a group
+     * 
+     * @param string $parent The parent group name
+     * @param string $child The child group name
+     * @return bool
+     */
     public function addGroup($parent,$child) {
 
         // Find the parent group's dn
@@ -87,13 +87,13 @@ 
     }
     
     /**
-    * Add a user to a group
-    * 
-    * @param string $group The group to add the user to
-    * @param string $user The user to add to the group
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
+     * Add a user to a group
+     * 
+     * @param string $group The group to add the user to
+     * @param string $user The user to add to the group
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return bool
+     */
     public function addUser($group, $user, $isGUID = false) {
         // Adding a user is a bit fiddly, we need to get the full DN of the user
         // and add it using the full DN of the group
@@ -122,12 +122,12 @@ 
     }
     
     /**
-    * Add a contact to a group
-    * 
-    * @param string $group The group to add the contact to
-    * @param string $contactDn The DN of the contact to add
-    * @return bool
-    */
+     * Add a contact to a group
+     * 
+     * @param string $group The group to add the contact to
+     * @param string $contactDn The DN of the contact to add
+     * @return bool
+     */
     public function addContact($group, $contactDn)
     {
         // To add a contact we take the contact's DN
@@ -151,11 +151,11 @@ 
     }
 
     /**
-    * Create a group
-    * 
-    * @param array $attributes Default attributes of the group
-    * @return bool
-    */
+     * Create a group
+     * 
+     * @param array $attributes Default attributes of the group
+     * @return bool
+     */
     public function create($attributes) {
         if (!is_array($attributes)) { return "Attributes must be an array"; }
         if (!array_key_exists("group_name", $attributes)) { return "Missing compulsory field [group_name]"; }
@@ -184,12 +184,12 @@ 
     }
     
     /**
-    * Delete a group account 
-    * 
-    * @param string $group The group to delete (please be careful here!) 
-    * 
-    * @return array 
-    */
+     * Delete a group account 
+     * 
+     * @param string $group The group to delete (please be careful here!) 
+     * 
+     * @return array 
+     */
     public function delete($group) {
         if (!$this->adldap->getLdapBind()) { return false; }
         if ($group === null) { return "Missing compulsory field [group]"; }
@@ -200,7 +200,7 @@ 
         if ($result !== true) { 
             return false; 
         } 
-	return true;   
+    return true;   
     }
 
     /**
@@ -234,12 +234,12 @@ 
     }
 
     /**
-    * Remove a group from a group
-    * 
-    * @param string $parent The parent group name
-    * @param string $child The child group name
-    * @return bool
-    */
+     * Remove a group from a group
+     * 
+     * @param string $parent The parent group name
+     * @param string $child The child group name
+     * @return bool
+     */
     public function removeGroup($parent , $child) {
     
         // Find the parent dn
@@ -267,13 +267,13 @@ 
     }
     
     /**
-    * Remove a user from a group
-    * 
-    * @param string $group The group to remove a user from
-    * @param string $user The AD user to remove from the group
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
+     * Remove a user from a group
+     * 
+     * @param string $group The group to remove a user from
+     * @param string $user The AD user to remove from the group
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return bool
+     */
     public function removeUser($group, $user, $isGUID = false) {
     
         // Find the parent dn
@@ -300,12 +300,12 @@ 
     }
     
     /**
-    * Remove a contact from a group
-    * 
-    * @param string $group The group to remove a user from
-    * @param string $contactDn The DN of a contact to remove from the group
-    * @return bool
-    */
+     * Remove a contact from a group
+     * 
+     * @param string $group The group to remove a user from
+     * @param string $contactDn The DN of a contact to remove from the group
+     * @return bool
+     */
     public function removeContact($group, $contactDn) {
     
         // Find the parent dn
@@ -326,12 +326,12 @@ 
     }
     
     /**
-    * Return a list of groups in a group
-    * 
-    * @param string $group The group to query
-    * @param bool $recursive Recursively get groups
-    * @return array
-    */
+     * Return a list of groups in a group
+     * 
+     * @param string $group The group to query
+     * @param bool $recursive Recursively get groups
+     * @return array
+     */
     public function inGroup($group, $recursive = NULL) {
         if (!$this->adldap->getLdapBind()){ return false; }
         if ($recursive === NULL){ $recursive = $this->adldap->getRecursiveGroups(); } // Use the default option if they haven't set it 
@@ -346,13 +346,13 @@ 
         $groupArray = array();
 
         for ($i=0; $i<$groups["count"]; $i++) { 
-             $filter = "(&(objectCategory=group)(distinguishedName=" . $this->adldap->utilities()->ldapSlashes($groups[$i]) . "))";
-             $fields = array("samaccountname", "distinguishedname", "objectClass");
-             $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);
-             $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
+                $filter = "(&(objectCategory=group)(distinguishedName=" . $this->adldap->utilities()->ldapSlashes($groups[$i]) . "))";
+                $fields = array("samaccountname", "distinguishedname", "objectClass");
+                $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);
+                $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
 
-             // not a person, look for a group  
-             if ($entries['count'] == 0 && $recursive == true) {  
+                // not a person, look for a group  
+                if ($entries['count'] == 0 && $recursive == true) {  
                 $filter = "(&(objectCategory=group)(distinguishedName=" . $this->adldap->utilities()->ldapSlashes($groups[$i]) . "))";  
                 $fields = array("distinguishedname");  
                 $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);  
@@ -366,19 +366,19 @@ 
                     $groupArray = array_unique($groupArray);  
                 }
                 continue;  
-             } 
-             $groupArray[] = $entries[0]['distinguishedname'][0];
+                } 
+                $groupArray[] = $entries[0]['distinguishedname'][0];
         }
         return $groupArray;
     }
     
     /**
-    * Return a list of members in a group
-    * 
-    * @param string $group The group to query
-    * @param bool $recursive Recursively get group members
-    * @return array
-    */
+     * Return a list of members in a group
+     * 
+     * @param string $group The group to query
+     * @param bool $recursive Recursively get group members
+     * @return array
+     */
     public function members($group, $recursive = NULL) {
         if (!$this->adldap->getLdapBind()) { return false; }
         if ($recursive === NULL){ $recursive = $this->adldap->getRecursiveGroups(); } // Use the default option if they haven't set it 
@@ -396,13 +396,13 @@ 
         $userArray = array();
 
         for ($i=0; $i<$users["count"]; $i++) { 
-             $filter = "(&(objectCategory=person)(distinguishedName=" . $this->adldap->utilities()->ldapSlashes($users[$i]) . "))";
-             $fields = array("samaccountname", "distinguishedname", "objectClass");
-             $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);
-             $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
+                $filter = "(&(objectCategory=person)(distinguishedName=" . $this->adldap->utilities()->ldapSlashes($users[$i]) . "))";
+                $fields = array("samaccountname", "distinguishedname", "objectClass");
+                $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);
+                $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
 
-             // not a person, look for a group  
-             if ($entries['count'] == 0 && $recursive == true) {  
+                // not a person, look for a group  
+                if ($entries['count'] == 0 && $recursive == true) {  
                 $filter = "(&(objectCategory=group)(distinguishedName=" . $this->adldap->utilities()->ldapSlashes($users[$i]) . "))";  
                 $fields = array("samaccountname");  
                 $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);  
@@ -416,29 +416,29 @@ 
                     $userArray = array_unique($userArray);  
                 }
                 continue;  
-             } 
-             else if ($entries['count'] == 0) {   
+                } 
+                else if ($entries['count'] == 0) {   
                 continue; 
-             } 
+                } 
 
-             if ((!isset($entries[0]['samaccountname'][0]) || $entries[0]['samaccountname'][0] === NULL) && $entries[0]['distinguishedname'][0] !== NULL) {
-                 $userArray[] = $entries[0]['distinguishedname'][0];
-             }
-             else if ($entries[0]['samaccountname'][0] !== NULL) {
+                if ((!isset($entries[0]['samaccountname'][0]) || $entries[0]['samaccountname'][0] === NULL) && $entries[0]['distinguishedname'][0] !== NULL) {
+                    $userArray[] = $entries[0]['distinguishedname'][0];
+                }
+                else if ($entries[0]['samaccountname'][0] !== NULL) {
                 $userArray[] = $entries[0]['samaccountname'][0];
-             }
+                }
         }
         return $userArray;
     }
     
     /**
-    * Group Information.  Returns an array of raw information about a group.
-    * The group name is case sensitive
-    * 
-    * @param string $groupName The group name to retrieve info about
-    * @param array $fields Fields to retrieve
-    * @return array
-    */
+     * Group Information.  Returns an array of raw information about a group.
+     * The group name is case sensitive
+     * 
+     * @param string $groupName The group name to retrieve info about
+     * @param array $fields Fields to retrieve
+     * @return array
+     */
     public function info($groupName, $fields = NULL) {
         if ($groupName === NULL) { return false; }
         if (!$this->adldap->getLdapBind()) { return false; }
@@ -479,13 +479,13 @@ 
     }
     
     /**
-    * Group Information.  Returns an collection
-    * The group name is case sensitive
-    * 
-    * @param string $groupName The group name to retrieve info about
-    * @param array $fields Fields to retrieve
-    * @return \adLDAP\collections\adLDAPGroupCollection
-    */
+     * Group Information.  Returns an collection
+     * The group name is case sensitive
+     * 
+     * @param string $groupName The group name to retrieve info about
+     * @param array $fields Fields to retrieve
+     * @return \adLDAP\collections\adLDAPGroupCollection
+     */
     public function infoCollection($groupName, $fields = NULL) {
         if ($groupName === NULL) { return false; }
         if (!$this->adldap->getLdapBind()) { return false; }
@@ -499,11 +499,11 @@ 
     }
     
     /**
-    * Return a complete list of "groups in groups"
-    * 
-    * @param string $group The group to get the list from
-    * @return array
-    */
+     * Return a complete list of "groups in groups"
+     * 
+     * @param string $group The group to get the list from
+     * @return array
+     */
     public function recursiveGroups($group) {
         if ($group === NULL) { return false; }
 
@@ -535,14 +535,14 @@ 
     }
     
     /**
-    * Returns a complete list of the groups in AD based on a SAM Account Type  
-    * 
-    * @param string $sAMAaccountType The account type to return
-    * @param bool $includeDescription Whether to return a description
-    * @param string $search Search parameters
-    * @param bool $sorted Whether to sort the results
-    * @return array
-    */
+     * Returns a complete list of the groups in AD based on a SAM Account Type  
+     * 
+     * @param string $sAMAaccountType The account type to return
+     * @param bool $includeDescription Whether to return a description
+     * @param string $search Search parameters
+     * @param bool $sorted Whether to sort the results
+     * @return array
+     */
     public function search($sAMAaccountType = adLDAP::ADLDAP_SECURITY_GLOBAL_GROUP, $includeDescription = false, $search = "*", $sorted = true) {
         if (!$this->adldap->getLdapBind()) { return false; }
         
@@ -575,12 +575,12 @@ 
     }
 
     /**
-    * Obtain the group's distinguished name based on their groupid
-    *
-    *
-    * @param string $groupname The groupname
-    * @return string
-    */
+     * Obtain the group's distinguished name based on their groupid
+     *
+     *
+     * @param string $groupname The groupname
+     * @return string
+     */
     public function dn($groupname) {
         $group = $this->info($groupname, array("cn"));
         if ($group[0]["dn"] === NULL) {
@@ -591,55 +591,55 @@ 
     }
 
     /**
-    * Returns a complete list of all groups in AD
-    * 
-    * @param bool $includeDescription Whether to return a description
-    * @param string $search Search parameters
-    * @param bool $sorted Whether to sort the results
-    * @return array
-    */
+     * Returns a complete list of all groups in AD
+     * 
+     * @param bool $includeDescription Whether to return a description
+     * @param string $search Search parameters
+     * @param bool $sorted Whether to sort the results
+     * @return array
+     */
     public function all($includeDescription = false, $search = "*", $sorted = true) {
         $groupsArray = $this->search(null, $includeDescription, $search, $sorted);
         return $groupsArray;
     }
     
     /**
-    * Returns a complete list of security groups in AD
-    * 
-    * @param bool $includeDescription Whether to return a description
-    * @param string $search Search parameters
-    * @param bool $sorted Whether to sort the results
-    * @return array
-    */
+     * Returns a complete list of security groups in AD
+     * 
+     * @param bool $includeDescription Whether to return a description
+     * @param string $search Search parameters
+     * @param bool $sorted Whether to sort the results
+     * @return array
+     */
     public function allSecurity($includeDescription = false, $search = "*", $sorted = true) {
         $groupsArray = $this->search(adLDAP::ADLDAP_SECURITY_GLOBAL_GROUP, $includeDescription, $search, $sorted);
         return $groupsArray;
     }
     
     /**
-    * Returns a complete list of distribution lists in AD
-    * 
-    * @param bool $includeDescription Whether to return a description
-    * @param string $search Search parameters
-    * @param bool $sorted Whether to sort the results
-    * @return array
-    */
+     * Returns a complete list of distribution lists in AD
+     * 
+     * @param bool $includeDescription Whether to return a description
+     * @param string $search Search parameters
+     * @param bool $sorted Whether to sort the results
+     * @return array
+     */
     public function allDistribution($includeDescription = false, $search = "*", $sorted = true) {
         $groupsArray = $this->search(adLDAP::ADLDAP_DISTRIBUTION_GROUP, $includeDescription, $search, $sorted);
         return $groupsArray;
     }
     
     /**
-    * Coping with AD not returning the primary group
-    * http://support.microsoft.com/?kbid=321360 
-    * 
-    * This is a re-write based on code submitted by Bruce which prevents the 
-    * need to search each security group to find the true primary group
-    * 
-    * @param string $gid Group ID
-    * @param string $usersid User's Object SID
-    * @return mixed
-    */
+     * Coping with AD not returning the primary group
+     * http://support.microsoft.com/?kbid=321360 
+     * 
+     * This is a re-write based on code submitted by Bruce which prevents the 
+     * need to search each security group to find the true primary group
+     * 
+     * @param string $gid Group ID
+     * @param string $usersid User's Object SID
+     * @return mixed
+     */
     public function getPrimaryGroup($gid, $usersid) {
         if ($gid === NULL || $usersid === NULL) { return false; }
         $sr = false;
@@ -654,20 +654,20 @@ 
             return $entries[0]['distinguishedname'][0];
         }
         return false;
-     }
+        }
      
-     /**
-    * Coping with AD not returning the primary group
-    * http://support.microsoft.com/?kbid=321360 
-    * 
-    * For some reason it's not possible to search on primarygrouptoken=XXX
-    * If someone can show otherwise, I'd like to know about it :)
-    * this way is resource intensive and generally a pain in the @#%^
-    * 
-    * @deprecated deprecated since version 3.1, see get get_primary_group
-    * @param string $gid Group ID
-    * @return string
-    */
+        /**
+         * Coping with AD not returning the primary group
+         * http://support.microsoft.com/?kbid=321360 
+         * 
+         * For some reason it's not possible to search on primarygrouptoken=XXX
+         * If someone can show otherwise, I'd like to know about it :)
+         * this way is resource intensive and generally a pain in the @#%^
+         * 
+         * @deprecated deprecated since version 3.1, see get get_primary_group
+         * @param string $gid Group ID
+         * @return string
+         */
     public function cn($gid) {    
         if ($gid === NULL) { return false; }
         $sr = false;

Spacing +37 added lines, -37 removed lines

@@ -35,8 +35,8 @@ 
  * @version 5.0.0
  * @link http://github.com/adldap/adLDAP
  */
-require_once(dirname(__FILE__) . '/../adLDAP.php');
-require_once(dirname(__FILE__) . '/../collections/adLDAPGroupCollection.php');
+require_once(dirname(__FILE__).'/../adLDAP.php');
+require_once(dirname(__FILE__).'/../collections/adLDAPGroupCollection.php');
 
 /**
 * GROUP FUNCTIONS
@@ -60,7 +60,7 @@ 
     * @param string $child The child group name
     * @return bool
     */
-    public function addGroup($parent,$child) {
+    public function addGroup($parent, $child) {
 
         // Find the parent group's dn
         $parentGroup = $this->ginfo($parent, array("cn"));
@@ -175,8 +175,8 @@ 
         $add["description"] = $attributes["description"];
         //$add["member"] = $member_array; UNTESTED
 
-        $container = "OU=" . implode(",OU=", $attributes["container"]);
-        $result = ldap_add($this->adldap->getLdapConnection(), "CN=" . $add["cn"] . ", " . $container . "," . $this->adldap->getBaseDn(), $add);
+        $container = "OU=".implode(",OU=", $attributes["container"]);
+        $result = ldap_add($this->adldap->getLdapConnection(), "CN=".$add["cn"].", ".$container.",".$this->adldap->getBaseDn(), $add);
         if ($result != true) { 
             return false; 
         }
@@ -216,14 +216,14 @@ 
         if ($info[0]["dn"] === NULL) {
             return false;
         }
-        else{
+        else {
             $groupDN = $info[0]["dn"];
         }
         $newRDN = 'CN='.$newName;
 
         // Determine the container
         $container = array_reverse($container);
-        $container = "OU=" . implode(", OU=",$container);
+        $container = "OU=".implode(", OU=", $container);
 
         // Do the update
         $result = @ldap_rename($this->adldap->getLdapConnection(), $groupDN, $newRDN, $container.', '.$this->adldap->getBaseDn(), true);
@@ -240,7 +240,7 @@ 
     * @param string $child The child group name
     * @return bool
     */
-    public function removeGroup($parent , $child) {
+    public function removeGroup($parent, $child) {
     
         // Find the parent dn
         $parentGroup = $this->info($parent, array("cn"));
@@ -333,11 +333,11 @@ 
     * @return array
     */
     public function inGroup($group, $recursive = NULL) {
-        if (!$this->adldap->getLdapBind()){ return false; }
-        if ($recursive === NULL){ $recursive = $this->adldap->getRecursiveGroups(); } // Use the default option if they haven't set it 
+        if (!$this->adldap->getLdapBind()) { return false; }
+        if ($recursive === NULL) { $recursive = $this->adldap->getRecursiveGroups(); } // Use the default option if they haven't set it 
         
         // Search the directory for the members of a group
-        $info = $this->info($group, array("member","cn"));
+        $info = $this->info($group, array("member", "cn"));
         $groups = $info[0]["member"];
         if (!is_array($groups)) {
             return false;   
@@ -345,15 +345,15 @@ 
  
         $groupArray = array();
 
-        for ($i=0; $i<$groups["count"]; $i++) { 
-             $filter = "(&(objectCategory=group)(distinguishedName=" . $this->adldap->utilities()->ldapSlashes($groups[$i]) . "))";
+        for ($i = 0; $i < $groups["count"]; $i++) { 
+             $filter = "(&(objectCategory=group)(distinguishedName=".$this->adldap->utilities()->ldapSlashes($groups[$i])."))";
              $fields = array("samaccountname", "distinguishedname", "objectClass");
              $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);
              $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
 
              // not a person, look for a group  
              if ($entries['count'] == 0 && $recursive == true) {  
-                $filter = "(&(objectCategory=group)(distinguishedName=" . $this->adldap->utilities()->ldapSlashes($groups[$i]) . "))";  
+                $filter = "(&(objectCategory=group)(distinguishedName=".$this->adldap->utilities()->ldapSlashes($groups[$i])."))";  
                 $fields = array("distinguishedname");  
                 $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);  
                 $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);  
@@ -381,9 +381,9 @@ 
     */
     public function members($group, $recursive = NULL) {
         if (!$this->adldap->getLdapBind()) { return false; }
-        if ($recursive === NULL){ $recursive = $this->adldap->getRecursiveGroups(); } // Use the default option if they haven't set it 
+        if ($recursive === NULL) { $recursive = $this->adldap->getRecursiveGroups(); } // Use the default option if they haven't set it 
         // Search the directory for the members of a group
-        $info = $this->info($group, array("member","cn"));
+        $info = $this->info($group, array("member", "cn"));
         if (isset($info[0]["member"])) {
             $users = $info[0]["member"];
             if (!is_array($users)) {
@@ -395,15 +395,15 @@ 
  
         $userArray = array();
 
-        for ($i=0; $i<$users["count"]; $i++) { 
-             $filter = "(&(objectCategory=person)(distinguishedName=" . $this->adldap->utilities()->ldapSlashes($users[$i]) . "))";
+        for ($i = 0; $i < $users["count"]; $i++) { 
+             $filter = "(&(objectCategory=person)(distinguishedName=".$this->adldap->utilities()->ldapSlashes($users[$i])."))";
              $fields = array("samaccountname", "distinguishedname", "objectClass");
              $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);
              $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
 
              // not a person, look for a group  
              if ($entries['count'] == 0 && $recursive == true) {  
-                $filter = "(&(objectCategory=group)(distinguishedName=" . $this->adldap->utilities()->ldapSlashes($users[$i]) . "))";  
+                $filter = "(&(objectCategory=group)(distinguishedName=".$this->adldap->utilities()->ldapSlashes($users[$i])."))";  
                 $fields = array("samaccountname");  
                 $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);  
                 $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);  
@@ -447,9 +447,9 @@ 
             $groupName = stripslashes($groupName);   
         }
         
-        $filter = "(&(objectCategory=group)(name=" . $this->adldap->utilities()->ldapSlashes($groupName) . "))";
+        $filter = "(&(objectCategory=group)(name=".$this->adldap->utilities()->ldapSlashes($groupName)."))";
         if ($fields === NULL) { 
-            $fields = array("member","memberof","cn","description","distinguishedname","objectcategory","samaccountname"); 
+            $fields = array("member", "memberof", "cn", "description", "distinguishedname", "objectcategory", "samaccountname"); 
         }
         $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);
         $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
@@ -457,22 +457,22 @@ 
         // Windows 2003: Returns up to 1500 values (Windows 2000 only 1000 is not supported).
         if (isset($entries[0]['member;range=0-1499']) && $entries[0]['member;range=0-1499']['count'] == 1500) {
             $entries[0]['member']['count'] = "0";
-            $rangestep = 1499;     // Step site
-            $rangelow  = 0;        // Initial low range
-            $rangehigh = $rangelow + $rangestep;     // Initial high range
+            $rangestep = 1499; // Step site
+            $rangelow  = 0; // Initial low range
+            $rangehigh = $rangelow + $rangestep; // Initial high range
             // do until array_keys($members[0])[0] ends with a '*', e. g. member;range=1499-*. It indicates end of the range
             do {
-                $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, array("member;range=" . $rangelow . "-" . $rangehigh));
+                $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, array("member;range=".$rangelow."-".$rangehigh));
                 $members = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
                 $memberrange = array_keys($members[0]);
                 $membercount = $members[0][$memberrange[0]]['count'];
                 // Copy range entries to member
-                for ($i = 0; $i <= $membercount -1; $i++) {
+                for ($i = 0; $i <= $membercount - 1; $i++) {
                     $entries[0]['member'][] = $members[0][$memberrange[0]][$i];
                 }
                 $entries[0]['member']['count'] += $membercount;
-                $rangelow  += $rangestep +1;
-                $rangehigh += $rangestep +1;
+                $rangelow  += $rangestep + 1;
+                $rangehigh += $rangestep + 1;
             } while (substr($memberrange[0], -1) != '*');
         }
         return $entries;
@@ -548,17 +548,17 @@ 
         
         $filter = '(&(objectCategory=group)';
         if ($sAMAaccountType !== null) {
-            $filter .= '(samaccounttype='. $sAMAaccountType .')';
+            $filter .= '(samaccounttype='.$sAMAaccountType.')';
         }
-        $filter .= '(cn=' . $search . '))';
+        $filter .= '(cn='.$search.'))';
         // Perform the search and grab all their details
         $fields = array("samaccountname", "description");
         $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);
         $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
 
         $groupsArray = array();        
-        for ($i=0; $i<$entries["count"]; $i++) {
-            if ($includeDescription && strlen($entries[$i]["description"][0]) > 0 ) {
+        for ($i = 0; $i < $entries["count"]; $i++) {
+            if ($includeDescription && strlen($entries[$i]["description"][0]) > 0) {
                 $groupsArray[$entries[$i]["samaccountname"][0]] = $entries[$i]["description"][0];
             }
             else if ($includeDescription) {
@@ -644,9 +644,9 @@ 
         if ($gid === NULL || $usersid === NULL) { return false; }
         $sr = false;
 
-        $gsid = substr_replace($usersid, pack('V',$gid), strlen($usersid)-4,4);
-        $filter = '(objectsid=' . $this->adldap->utilities()->getTextSID($gsid).')';
-        $fields = array("samaccountname","distinguishedname");
+        $gsid = substr_replace($usersid, pack('V', $gid), strlen($usersid) - 4, 4);
+        $filter = '(objectsid='.$this->adldap->utilities()->getTextSID($gsid).')';
+        $fields = array("samaccountname", "distinguishedname");
         $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);
         $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
 
@@ -673,12 +673,12 @@ 
         $sr = false;
         $r = '';
         
-        $filter = "(&(objectCategory=group)(samaccounttype=" . adLDAP::ADLDAP_SECURITY_GLOBAL_GROUP . "))";
+        $filter = "(&(objectCategory=group)(samaccounttype=".adLDAP::ADLDAP_SECURITY_GLOBAL_GROUP."))";
         $fields = array("primarygrouptoken", "samaccountname", "distinguishedname");
         $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);
         $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
         
-        for ($i=0; $i<$entries["count"]; $i++) {
+        for ($i = 0; $i < $entries["count"]; $i++) {
             if ($entries[$i]["primarygrouptoken"][0] == $gid) {
                 $r = $entries[$i]["distinguishedname"][0];
                 $i = $entries["count"];

Braces +5 added lines, -10 removed lines

@@ -215,8 +215,7 @@ 
         $info = $this->info($group);
         if ($info[0]["dn"] === NULL) {
             return false;
-        }
-        else{
+        } else{
             $groupDN = $info[0]["dn"];
         }
         $newRDN = 'CN='.$newName;
@@ -416,15 +415,13 @@ 
                     $userArray = array_unique($userArray);  
                 }
                 continue;  
-             } 
-             else if ($entries['count'] == 0) {   
+             } else if ($entries['count'] == 0) {   
                 continue; 
              } 
 
              if ((!isset($entries[0]['samaccountname'][0]) || $entries[0]['samaccountname'][0] === NULL) && $entries[0]['distinguishedname'][0] !== NULL) {
                  $userArray[] = $entries[0]['distinguishedname'][0];
-             }
-             else if ($entries[0]['samaccountname'][0] !== NULL) {
+             } else if ($entries[0]['samaccountname'][0] !== NULL) {
                 $userArray[] = $entries[0]['samaccountname'][0];
              }
         }
@@ -560,11 +557,9 @@ 
         for ($i=0; $i<$entries["count"]; $i++) {
             if ($includeDescription && strlen($entries[$i]["description"][0]) > 0 ) {
                 $groupsArray[$entries[$i]["samaccountname"][0]] = $entries[$i]["description"][0];
-            }
-            else if ($includeDescription) {
+            } else if ($includeDescription) {
                 $groupsArray[$entries[$i]["samaccountname"][0]] = $entries[$i]["samaccountname"][0];
-            }
-            else {
+            } else {
                 array_push($groupsArray, $entries[$i]["samaccountname"][0]);
             }
         }

includes/libraries/LDAP/adLDAP/classes/adLDAPUsers.php

Doc Comments +7 added lines, -7 removed lines

@@ -71,7 +71,7 @@ 
     * If you specify a password here, this can only be performed over SSL
     * 
     * @param array $attributes The attributes to set to the user account
-    * @return bool
+    * @return string|boolean
     */
     public function create($attributes) {
         // Check for compulsory fields
@@ -124,7 +124,7 @@ 
     /**
     * Account control options
     *
-    * @param array $options The options to convert to int 
+    * @param string[] $options The options to convert to int 
     * @return int
     */
     protected function accountControl($options) {
@@ -162,7 +162,7 @@ 
     * 
     * @param string $username The username to delete (please be careful here!)
     * @param bool $isGUID Is the username a GUID or a samAccountName
-    * @return array
+    * @return boolean
     */
     public function delete($username, $isGUID = false) {      
         $userinfo = $this->info($username, array("*"), $isGUID);
@@ -375,7 +375,7 @@ 
     * @param string $username The username to query
     * @param array $attributes The attributes to modify.  Note if you set the enabled attribute you must not specify any other attributes
     * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
+    * @return string|boolean
     */
     public function modify($username, $attributes, $isGUID = false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }
@@ -421,7 +421,7 @@ 
     * 
     * @param string $username The username to disable
     * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
+    * @return string|boolean
     */
     public function disable($username, $isGUID = false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }
@@ -437,7 +437,7 @@ 
     * 
     * @param string $username The username to enable
     * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
+    * @return string|boolean
     */
     public function enable($username, $isGUID = false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }
@@ -620,7 +620,7 @@ 
     * @param string $username The username to move (please be careful here!)
     * @param array $container The container or containers to move the user to (please be careful here!).
     * accepts containers in 1. parent 2. child order
-    * @return array
+    * @return string|boolean
     */
     public function move($username, $container) {
         if (!$this->adldap->getLdapBind()) { return false; }

Indentation +167 added lines, -167 removed lines

@@ -43,10 +43,10 @@ 
 */
 class adLDAPUsers {
     /**
-    * The current adLDAP connection via dependency injection
-    * 
-    * @var adLDAP
-    */
+     * The current adLDAP connection via dependency injection
+     * 
+     * @var adLDAP
+     */
     protected $adldap;
     
     public function __construct(adLDAP $adldap) {
@@ -54,25 +54,25 @@ 
     }
     
     /**
-    * Validate a user's login credentials
-    * 
-    * @param string $username A user's AD username
-    * @param string $password A user's AD password
-    * @param bool optional $prevent_rebind
-    * @return bool
-    */
+     * Validate a user's login credentials
+     * 
+     * @param string $username A user's AD username
+     * @param string $password A user's AD password
+     * @param bool optional $prevent_rebind
+     * @return bool
+     */
     public function authenticate($username, $password, $preventRebind = false) {
         return $this->adldap->authenticate($username, $password, $preventRebind);
     }
     
     /**
-    * Create a user
-    * 
-    * If you specify a password here, this can only be performed over SSL
-    * 
-    * @param array $attributes The attributes to set to the user account
-    * @return bool
-    */
+     * Create a user
+     * 
+     * If you specify a password here, this can only be performed over SSL
+     * 
+     * @param array $attributes The attributes to set to the user account
+     * @return bool
+     */
     public function create($attributes) {
         // Check for compulsory fields
         if (!array_key_exists("username", $attributes)) { return "Missing compulsory field [username]"; }
@@ -122,11 +122,11 @@ 
     }
     
     /**
-    * Account control options
-    *
-    * @param array $options The options to convert to int 
-    * @return int
-    */
+     * Account control options
+     *
+     * @param array $options The options to convert to int 
+     * @return int
+     */
     protected function accountControl($options) {
         $val=0;
 
@@ -158,12 +158,12 @@ 
     }
     
     /**
-    * Delete a user account
-    * 
-    * @param string $username The username to delete (please be careful here!)
-    * @param bool $isGUID Is the username a GUID or a samAccountName
-    * @return array
-    */
+     * Delete a user account
+     * 
+     * @param string $username The username to delete (please be careful here!)
+     * @param bool $isGUID Is the username a GUID or a samAccountName
+     * @return array
+     */
     public function delete($username, $isGUID = false) {      
         $userinfo = $this->info($username, array("*"), $isGUID);
         $dn = $userinfo[0]['distinguishedname'][0];
@@ -175,13 +175,13 @@ 
     }
     
     /**
-    * Groups the user is a member of
-    * 
-    * @param string $username The username to query
-    * @param bool $recursive Recursive list of groups
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return array
-    */
+     * Groups the user is a member of
+     * 
+     * @param string $username The username to query
+     * @param bool $recursive Recursive list of groups
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return array
+     */
     public function groups($username, $recursive = NULL, $isGUID = false) {
         if ($username === NULL) { return false; }
         if ($recursive === NULL) { $recursive = $this->adldap->getRecursiveGroups(); } // Use the default option if they haven't set it
@@ -201,13 +201,13 @@ 
     }
     
     /**
-    * Find information about the users. Returned in a raw array format from AD
-    * 
-    * @param string $username The username to query
-    * @param array $fields Array of parameters to query
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return array
-    */
+     * Find information about the users. Returned in a raw array format from AD
+     * 
+     * @param string $username The username to query
+     * @param array $fields Array of parameters to query
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return array
+     */
     public function info($username, $fields = NULL, $isGUID = false) {
         if ($username === NULL) { return false; }
         if (!$this->adldap->getLdapBind()) { return false; }
@@ -217,10 +217,10 @@ 
             $filter = "objectguid=" . $username;
         }
         else if (strpos($username, "@")) {
-             $filter = "userPrincipalName=" . $username;
+                $filter = "userPrincipalName=" . $username;
         }
         else {
-             $filter = "samaccountname=" . $username;
+                $filter = "samaccountname=" . $username;
         }
         $filter = "(&(objectCategory=person)({$filter}))";
         if ($fields === NULL) { 
@@ -254,13 +254,13 @@ 
     }
     
     /**
-    * Find information about the users. Returned in a raw array format from AD
-    * 
-    * @param string $username The username to query
-    * @param array $fields Array of parameters to query
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return mixed
-    */
+     * Find information about the users. Returned in a raw array format from AD
+     * 
+     * @param string $username The username to query
+     * @param array $fields Array of parameters to query
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return mixed
+     */
     public function infoCollection($username, $fields = NULL, $isGUID = false) {
         if ($username === NULL) { return false; }
         if (!$this->adldap->getLdapBind()) { return false; }
@@ -275,14 +275,14 @@ 
     }
     
     /**
-    * Determine if a user is in a specific group
-    * 
-    * @param string $username The username to query
-    * @param string $group The name of the group to check against
-    * @param bool $recursive Check groups recursively
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
+     * Determine if a user is in a specific group
+     * 
+     * @param string $username The username to query
+     * @param string $group The name of the group to check against
+     * @param bool $recursive Check groups recursively
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return bool
+     */
     public function inGroup($username, $group, $recursive = NULL, $isGUID = false) {
         if ($username === NULL) { return false; }
         if ($group === NULL) { return false; }
@@ -300,13 +300,13 @@ 
     }
     
     /**
-    * Determine a user's password expiry date
-    * 
-    * @param string $username The username to query
-    * @param book $isGUID Is the username passed a GUID or a samAccountName
-    * @requires bcmath http://www.php.net/manual/en/book.bc.php
-    * @return array
-    */
+     * Determine a user's password expiry date
+     * 
+     * @param string $username The username to query
+     * @param book $isGUID Is the username passed a GUID or a samAccountName
+     * @requires bcmath http://www.php.net/manual/en/book.bc.php
+     * @return array
+     */
     public function passwordExpiry($username, $isGUID = false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }
         if (!$this->adldap->getLdapBind()) { return false; }
@@ -325,36 +325,36 @@ 
             return "Password has expired";
         }
         
-         // Password expiry in AD can be calculated from TWO values:
-         //   - User's own pwdLastSet attribute: stores the last time the password was changed
-         //   - Domain's maxPwdAge attribute: how long passwords last in the domain
-         //
-         // Although Microsoft chose to use a different base and unit for time measurements.
-         // This function will convert them to Unix timestamps
-         $sr = ldap_read($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), 'objectclass=*', array('maxPwdAge'));
-         if (!$sr) {
-             return false;
-         }
-         $info = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
-         $maxPwdAge = $info[0]['maxpwdage'][0];
+            // Password expiry in AD can be calculated from TWO values:
+            //   - User's own pwdLastSet attribute: stores the last time the password was changed
+            //   - Domain's maxPwdAge attribute: how long passwords last in the domain
+            //
+            // Although Microsoft chose to use a different base and unit for time measurements.
+            // This function will convert them to Unix timestamps
+            $sr = ldap_read($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), 'objectclass=*', array('maxPwdAge'));
+            if (!$sr) {
+                return false;
+            }
+            $info = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
+            $maxPwdAge = $info[0]['maxpwdage'][0];
          
-         // See MSDN: http://msdn.microsoft.com/en-us/library/ms974598.aspx
-         //
-         // pwdLastSet contains the number of 100 nanosecond intervals since January 1, 1601 (UTC), 
-         // stored in a 64 bit integer. 
-         //
-         // The number of seconds between this date and Unix epoch is 11644473600.
-         //
-         // maxPwdAge is stored as a large integer that represents the number of 100 nanosecond
-         // intervals from the time the password was set before the password expires.
-         //
-         // We also need to scale this to seconds but also this value is a _negative_ quantity!
-         //
-         // If the low 32 bits of maxPwdAge are equal to 0 passwords do not expire
-         //
-         // Unfortunately the maths involved are too big for PHP integers, so I've had to require
-         // BCMath functions to work with arbitrary precision numbers.
-         if (bcmod($maxPwdAge, 4294967296) === '0') {
+            // See MSDN: http://msdn.microsoft.com/en-us/library/ms974598.aspx
+            //
+            // pwdLastSet contains the number of 100 nanosecond intervals since January 1, 1601 (UTC), 
+            // stored in a 64 bit integer. 
+            //
+            // The number of seconds between this date and Unix epoch is 11644473600.
+            //
+            // maxPwdAge is stored as a large integer that represents the number of 100 nanosecond
+            // intervals from the time the password was set before the password expires.
+            //
+            // We also need to scale this to seconds but also this value is a _negative_ quantity!
+            //
+            // If the low 32 bits of maxPwdAge are equal to 0 passwords do not expire
+            //
+            // Unfortunately the maths involved are too big for PHP integers, so I've had to require
+            // BCMath functions to work with arbitrary precision numbers.
+            if (bcmod($maxPwdAge, 4294967296) === '0') {
             return "Domain does not expire passwords";
         }
         
@@ -370,13 +370,13 @@ 
     }
     
     /**
-    * Modify a user
-    * 
-    * @param string $username The username to query
-    * @param array $attributes The attributes to modify.  Note if you set the enabled attribute you must not specify any other attributes
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
+     * Modify a user
+     * 
+     * @param string $username The username to query
+     * @param array $attributes The attributes to modify.  Note if you set the enabled attribute you must not specify any other attributes
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return bool
+     */
     public function modify($username, $attributes, $isGUID = false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }
         if (array_key_exists("password", $attributes) && !$this->adldap->getUseSSL() && !$this->adldap->getUseTLS()) { 
@@ -417,12 +417,12 @@ 
     }
     
     /**
-    * Disable a user account
-    * 
-    * @param string $username The username to disable
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
+     * Disable a user account
+     * 
+     * @param string $username The username to disable
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return bool
+     */
     public function disable($username, $isGUID = false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }
         $attributes = array("enabled" => 0);
@@ -433,12 +433,12 @@ 
     }
     
     /**
-    * Enable a user account
-    * 
-    * @param string $username The username to enable
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
+     * Enable a user account
+     * 
+     * @param string $username The username to enable
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return bool
+     */
     public function enable($username, $isGUID = false) {
         if ($username === NULL) { return "Missing compulsory field [username]"; }
         $attributes = array("enabled" => 1);
@@ -449,13 +449,13 @@ 
     }
     
     /**
-    * Set the password of a user - This must be performed over SSL
-    * 
-    * @param string $username The username to modify
-    * @param string $password The new password
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
+     * Set the password of a user - This must be performed over SSL
+     * 
+     * @param string $username The username to modify
+     * @param string $password The new password
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return bool
+     */
     public function password($username, $password, $isGUID = false) {
         if ($username === NULL) { return false; }
         if ($password === NULL) { return false; }
@@ -490,11 +490,11 @@ 
     }
     
     /**
-    * Encode a password for transmission over LDAP
-    *
-    * @param string $password The password to encode
-    * @return string
-    */
+     * Encode a password for transmission over LDAP
+     *
+     * @param string $password The password to encode
+     * @return string
+     */
     public function encodePassword($password) {
         $password="\"".$password."\"";
         $encoded="";
@@ -503,13 +503,13 @@ 
     }
      
     /**
-    * Obtain the user's distinguished name based on their userid 
-    * 
-    * 
-    * @param string $username The username
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return string
-    */
+     * Obtain the user's distinguished name based on their userid 
+     * 
+     * 
+     * @param string $username The username
+     * @param bool $isGUID Is the username passed a GUID or a samAccountName
+     * @return string
+     */
     public function dn($username, $isGUID=false) {
         $user = $this->info($username, array("cn"), $isGUID);
         if ($user[0]["dn"] === NULL) { 
@@ -520,13 +520,13 @@ 
     }
     
     /**
-    * Return a list of all users in AD
-    * 
-    * @param bool $includeDescription Return a description of the user
-    * @param string $search Search parameter
-    * @param bool $sorted Sort the user accounts
-    * @return array
-    */
+     * Return a list of all users in AD
+     * 
+     * @param bool $includeDescription Return a description of the user
+     * @param string $search Search parameter
+     * @param bool $sorted Sort the user accounts
+     * @return array
+     */
     public function all($includeDescription = false, $search = "*", $sorted = true) {
         if (!$this->adldap->getLdapBind()) { return false; }
         
@@ -553,11 +553,11 @@ 
     }
     
     /**
-    * Converts a username (samAccountName) to a GUID
-    * 
-    * @param string $username The username to query
-    * @return string
-    */
+     * Converts a username (samAccountName) to a GUID
+     * 
+     * @param string $username The username to query
+     * @return string
+     */
     public function usernameToGuid($username) {
         if (!$this->adldap->getLdapBind()){ return false; }
         if ($username === null){ return "Missing compulsory field [username]"; }
@@ -575,14 +575,14 @@ 
     }
     
     /**
-    * Return a list of all users in AD that have a specific value in a field
-    *
-    * @param bool $includeDescription Return a description of the user
-    * @param string $searchField Field to search search for
-    * @param string $searchFilter Value to search for in the specified field
-    * @param bool $sorted Sort the user accounts
-    * @return array
-    */
+     * Return a list of all users in AD that have a specific value in a field
+     *
+     * @param bool $includeDescription Return a description of the user
+     * @param string $searchField Field to search search for
+     * @param string $searchFilter Value to search for in the specified field
+     * @param bool $sorted Sort the user accounts
+     * @return array
+     */
     public function find($includeDescription = false, $searchField = false, $searchFilter = false, $sorted = true) {
         if (!$this->adldap->getLdapBind()) { return false; }
           
@@ -609,19 +609,19 @@ 
             }
         }
         if ($sorted) { 
-          asort($usersArray); 
+            asort($usersArray); 
         }
         return ($usersArray);
     }
     
     /**
-    * Move a user account to a different OU
-    *
-    * @param string $username The username to move (please be careful here!)
-    * @param array $container The container or containers to move the user to (please be careful here!).
-    * accepts containers in 1. parent 2. child order
-    * @return array
-    */
+     * Move a user account to a different OU
+     *
+     * @param string $username The username to move (please be careful here!)
+     * @param array $container The container or containers to move the user to (please be careful here!).
+     * accepts containers in 1. parent 2. child order
+     * @return array
+     */
     public function move($username, $container) {
         if (!$this->adldap->getLdapBind()) { return false; }
         if ($username === null) { return "Missing compulsory field [username]"; }
@@ -642,11 +642,11 @@ 
     }
     
     /**
-    * Get the last logon time of any user as a Unix timestamp
-    * 
-    * @param string $username
-    * @return long $unixTimestamp
-    */
+     * Get the last logon time of any user as a Unix timestamp
+     * 
+     * @param string $username
+     * @return long $unixTimestamp
+     */
     public function getLastLogon($username) {
         if (!$this->adldap->getLdapBind()) { return false; }
         if ($username === null) { return "Missing compulsory field [username]"; }

Spacing +53 added lines, -53 removed lines

@@ -35,8 +35,8 @@ 
  * @version 5.0.0
  * @link http://github.com/adldap/adLDAP
  */
-require_once(dirname(__FILE__) . '/../adLDAP.php');
-require_once(dirname(__FILE__) . '/../collections/adLDAPUserCollection.php');
+require_once(dirname(__FILE__).'/../adLDAP.php');
+require_once(dirname(__FILE__).'/../collections/adLDAPUserCollection.php');
 
 /**
 * USER FUNCTIONS
@@ -82,12 +82,12 @@ 
         if (!array_key_exists("container", $attributes)) { return "Missing compulsory field [container]"; }
         if (!is_array($attributes["container"])) { return "Container attribute must be an array."; }
 
-        if (array_key_exists("password",$attributes) && (!$this->adldap->getUseSSL() && !$this->adldap->getUseTLS())) { 
+        if (array_key_exists("password", $attributes) && (!$this->adldap->getUseSSL() && !$this->adldap->getUseTLS())) { 
             throw new \adLDAP\adLDAPException('SSL must be configured on your webserver and enabled in the class to set passwords.');
         }
 
         if (!array_key_exists("display_name", $attributes)) { 
-            $attributes["display_name"] = $attributes["firstname"] . " " . $attributes["surname"]; 
+            $attributes["display_name"] = $attributes["firstname"]." ".$attributes["surname"]; 
         }
 
         // Translate the schema
@@ -111,10 +111,10 @@ 
         
         // Determine the container
         $attributes["container"] = array_reverse($attributes["container"]);
-        $container = "OU=" . implode(", OU=",$attributes["container"]);
+        $container = "OU=".implode(", OU=", $attributes["container"]);
 
         // Add the entry
-        $result = @ldap_add($this->adldap->getLdapConnection(), "CN=" . $add["cn"][0] . ", " . $container . "," . $this->adldap->getBaseDn(), $add);
+        $result = @ldap_add($this->adldap->getLdapConnection(), "CN=".$add["cn"][0].", ".$container.",".$this->adldap->getBaseDn(), $add);
         if ($result != true) { 
             return false; 
         }
@@ -128,31 +128,31 @@ 
     * @return int
     */
     protected function accountControl($options) {
-        $val=0;
+        $val = 0;
 
         if (is_array($options)) {
-            if (in_array("SCRIPT",$options)) { $val=$val+1; }
-            if (in_array("ACCOUNTDISABLE",$options)) { $val=$val+2; }
-            if (in_array("HOMEDIR_REQUIRED",$options)) { $val=$val+8; }
-            if (in_array("LOCKOUT",$options)) { $val=$val+16; }
-            if (in_array("PASSWD_NOTREQD",$options)) { $val=$val+32; }
+            if (in_array("SCRIPT", $options)) { $val = $val + 1; }
+            if (in_array("ACCOUNTDISABLE", $options)) { $val = $val + 2; }
+            if (in_array("HOMEDIR_REQUIRED", $options)) { $val = $val + 8; }
+            if (in_array("LOCKOUT", $options)) { $val = $val + 16; }
+            if (in_array("PASSWD_NOTREQD", $options)) { $val = $val + 32; }
             //PASSWD_CANT_CHANGE Note You cannot assign this permission by directly modifying the UserAccountControl attribute.
             //For information about how to set the permission programmatically, see the "Property flag descriptions" section.
-            if (in_array("ENCRYPTED_TEXT_PWD_ALLOWED",$options)) { $val=$val+128; }
-            if (in_array("TEMP_DUPLICATE_ACCOUNT",$options)) { $val=$val+256; }
-            if (in_array("NORMAL_ACCOUNT",$options)) { $val=$val+512; }
-            if (in_array("INTERDOMAIN_TRUST_ACCOUNT",$options)) { $val=$val+2048; }
-            if (in_array("WORKSTATION_TRUST_ACCOUNT",$options)) { $val=$val+4096; }
-            if (in_array("SERVER_TRUST_ACCOUNT",$options)) { $val=$val+8192; }
-            if (in_array("DONT_EXPIRE_PASSWORD",$options)){ $val=$val+65536; }
-            if (in_array("MNS_LOGON_ACCOUNT",$options)) { $val=$val+131072; }
-            if (in_array("SMARTCARD_REQUIRED",$options)) { $val=$val+262144; }
-            if (in_array("TRUSTED_FOR_DELEGATION",$options)) { $val=$val+524288; }
-            if (in_array("NOT_DELEGATED",$options)) { $val=$val+1048576; }
-            if (in_array("USE_DES_KEY_ONLY",$options)) { $val=$val+2097152; }
-            if (in_array("DONT_REQ_PREAUTH",$options)) { $val=$val+4194304; } 
-            if (in_array("PASSWORD_EXPIRED",$options)) { $val=$val+8388608; }
-            if (in_array("TRUSTED_TO_AUTH_FOR_DELEGATION",$options)) { $val=$val+16777216; }
+            if (in_array("ENCRYPTED_TEXT_PWD_ALLOWED", $options)) { $val = $val + 128; }
+            if (in_array("TEMP_DUPLICATE_ACCOUNT", $options)) { $val = $val + 256; }
+            if (in_array("NORMAL_ACCOUNT", $options)) { $val = $val + 512; }
+            if (in_array("INTERDOMAIN_TRUST_ACCOUNT", $options)) { $val = $val + 2048; }
+            if (in_array("WORKSTATION_TRUST_ACCOUNT", $options)) { $val = $val + 4096; }
+            if (in_array("SERVER_TRUST_ACCOUNT", $options)) { $val = $val + 8192; }
+            if (in_array("DONT_EXPIRE_PASSWORD", $options)) { $val = $val + 65536; }
+            if (in_array("MNS_LOGON_ACCOUNT", $options)) { $val = $val + 131072; }
+            if (in_array("SMARTCARD_REQUIRED", $options)) { $val = $val + 262144; }
+            if (in_array("TRUSTED_FOR_DELEGATION", $options)) { $val = $val + 524288; }
+            if (in_array("NOT_DELEGATED", $options)) { $val = $val + 1048576; }
+            if (in_array("USE_DES_KEY_ONLY", $options)) { $val = $val + 2097152; }
+            if (in_array("DONT_REQ_PREAUTH", $options)) { $val = $val + 4194304; } 
+            if (in_array("PASSWORD_EXPIRED", $options)) { $val = $val + 8388608; }
+            if (in_array("TRUSTED_TO_AUTH_FOR_DELEGATION", $options)) { $val = $val + 16777216; }
         }
         return $val;
     }
@@ -214,17 +214,17 @@ 
 
         if ($isGUID === true) {
             $username = $this->adldap->utilities()->strGuidToHex($username);
-            $filter = "objectguid=" . $username;
+            $filter = "objectguid=".$username;
         }
         else if (strpos($username, "@")) {
-             $filter = "userPrincipalName=" . $username;
+             $filter = "userPrincipalName=".$username;
         }
         else {
-             $filter = "samaccountname=" . $username;
+             $filter = "samaccountname=".$username;
         }
         $filter = "(&(objectCategory=person)({$filter}))";
         if ($fields === NULL) { 
-            $fields = array("samaccountname","mail","memberof","department","displayname","telephonenumber","primarygroupid","objectsid"); 
+            $fields = array("samaccountname", "mail", "memberof", "department", "displayname", "telephonenumber", "primarygroupid", "objectsid"); 
         }
         if (!in_array("objectsid", $fields)) {
             $fields[] = "objectsid";
@@ -240,7 +240,7 @@ 
                         //$entries[0]["memberof"][]=$this->group_cn($entries[0]["primarygroupid"][0]);
                         $entries[0]["memberof"][] = $this->adldap->group()->getPrimaryGroup($entries[0]["primarygroupid"][0], $entries[0]["objectsid"][0]);
                     } else {
-                        $entries[0]["memberof"][] = "CN=Domain Users,CN=Users," . $this->adldap->getBaseDn();
+                        $entries[0]["memberof"][] = "CN=Domain Users,CN=Users,".$this->adldap->getBaseDn();
                     }
                     if (!isset($entries[0]["memberof"]["count"])) {
                         $entries[0]["memberof"]["count"] = 0;
@@ -469,15 +469,15 @@ 
             return false; 
         }
                 
-        $add=array();
+        $add = array();
         $add["unicodePwd"][0] = $this->encodePassword($password);
         
         $result = @ldap_mod_replace($this->adldap->getLdapConnection(), $userDn, $add);
         if ($result === false) {
             $err = ldap_errno($this->adldap->getLdapConnection());
             if ($err) {
-                $msg = 'Error ' . $err . ': ' . ldap_err2str($err) . '.';
-                if($err == 53) {
+                $msg = 'Error '.$err.': '.ldap_err2str($err).'.';
+                if ($err == 53) {
                     $msg .= ' Your password might not match the password policy.';
                 }
                 throw new \adLDAP\adLDAPException($msg);
@@ -496,9 +496,9 @@ 
     * @return string
     */
     public function encodePassword($password) {
-        $password="\"".$password."\"";
-        $encoded="";
-        for ($i=0; $i <strlen($password); $i++) { $encoded.="{$password{$i}}\000"; }
+        $password = "\"".$password."\"";
+        $encoded = "";
+        for ($i = 0; $i < strlen($password); $i++) { $encoded .= "{$password{$i}}\000"; }
         return $encoded;
     }
      
@@ -510,7 +510,7 @@ 
     * @param bool $isGUID Is the username passed a GUID or a samAccountName
     * @return string
     */
-    public function dn($username, $isGUID=false) {
+    public function dn($username, $isGUID = false) {
         $user = $this->info($username, array("cn"), $isGUID);
         if ($user[0]["dn"] === NULL) { 
             return false; 
@@ -531,14 +531,14 @@ 
         if (!$this->adldap->getLdapBind()) { return false; }
         
         // Perform the search and grab all their details
-        $filter = "(&(objectClass=user)(samaccounttype=" . adLDAP::ADLDAP_NORMAL_ACCOUNT .")(objectCategory=person)(cn=" . $search . "))";
-        $fields = array("samaccountname","displayname");
+        $filter = "(&(objectClass=user)(samaccounttype=".adLDAP::ADLDAP_NORMAL_ACCOUNT.")(objectCategory=person)(cn=".$search."))";
+        $fields = array("samaccountname", "displayname");
         $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);
         $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
 
         $usersArray = array();
-        for ($i=0; $i<$entries["count"]; $i++) {
-            if ($includeDescription && strlen($entries[$i]["displayname"][0])>0) {
+        for ($i = 0; $i < $entries["count"]; $i++) {
+            if ($includeDescription && strlen($entries[$i]["displayname"][0]) > 0) {
                 $usersArray[$entries[$i]["samaccountname"][0]] = $entries[$i]["displayname"][0];
             } elseif ($includeDescription) {
                 $usersArray[$entries[$i]["samaccountname"][0]] = $entries[$i]["samaccountname"][0];
@@ -559,10 +559,10 @@ 
     * @return string
     */
     public function usernameToGuid($username) {
-        if (!$this->adldap->getLdapBind()){ return false; }
-        if ($username === null){ return "Missing compulsory field [username]"; }
+        if (!$this->adldap->getLdapBind()) { return false; }
+        if ($username === null) { return "Missing compulsory field [username]"; }
         
-        $filter = "samaccountname=" . $username; 
+        $filter = "samaccountname=".$username; 
         $fields = array("objectGUID"); 
         $sr = @ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields); 
         if (ldap_count_entries($this->adldap->getLdapConnection(), $sr) > 0) { 
@@ -589,15 +589,15 @@ 
         // Perform the search and grab all their details
         $searchParams = "";
         if ($searchField) {
-            $searchParams = "(" . $searchField . "=" . $searchFilter . ")";
+            $searchParams = "(".$searchField."=".$searchFilter.")";
         }                           
-        $filter = "(&(objectClass=user)(samaccounttype=" . adLDAP::ADLDAP_NORMAL_ACCOUNT .")(objectCategory=person)" . $searchParams . ")";
-        $fields = array("samaccountname","displayname");
+        $filter = "(&(objectClass=user)(samaccounttype=".adLDAP::ADLDAP_NORMAL_ACCOUNT.")(objectCategory=person)".$searchParams.")";
+        $fields = array("samaccountname", "displayname");
         $sr = ldap_search($this->adldap->getLdapConnection(), $this->adldap->getBaseDn(), $filter, $fields);
         $entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr);
 
         $usersArray = array();
-        for ($i=0; $i < $entries["count"]; $i++) {
+        for ($i = 0; $i < $entries["count"]; $i++) {
             if ($includeDescription && strlen($entries[$i]["displayname"][0]) > 0) {
                 $usersArray[$entries[$i]["samaccountname"][0]] = $entries[$i]["displayname"][0];
             }
@@ -630,10 +630,10 @@ 
         
         $userInfo = $this->info($username, array("*"));
         $dn = $userInfo[0]['distinguishedname'][0];
-        $newRDn = "cn=" . $username;
+        $newRDn = "cn=".$username;
         $container = array_reverse($container);
-        $newContainer = "ou=" . implode(",ou=",$container);
-        $newBaseDn = strtolower($newContainer) . "," . $this->adldap->getBaseDn();
+        $newContainer = "ou=".implode(",ou=", $container);
+        $newBaseDn = strtolower($newContainer).",".$this->adldap->getBaseDn();
         $result = @ldap_rename($this->adldap->getLdapConnection(), $dn, $newRDn, $newBaseDn, true);
         if ($result !== true) {
             return false;

Braces +6 added lines, -12 removed lines

@@ -215,11 +215,9 @@ 
         if ($isGUID === true) {
             $username = $this->adldap->utilities()->strGuidToHex($username);
             $filter = "objectguid=" . $username;
-        }
-        else if (strpos($username, "@")) {
+        } else if (strpos($username, "@")) {
              $filter = "userPrincipalName=" . $username;
-        }
-        else {
+        } else {
              $filter = "samaccountname=" . $username;
         }
         $filter = "(&(objectCategory=person)({$filter}))";
@@ -401,8 +399,7 @@ 
         if (array_key_exists("enabled", $attributes)) {
             if ($attributes["enabled"]) { 
                 $controlOptions = array("NORMAL_ACCOUNT"); 
-            }
-            else { 
+            } else { 
                 $controlOptions = array("NORMAL_ACCOUNT", "ACCOUNTDISABLE"); 
             }
             $mod["userAccountControl"][0] = $this->accountControl($controlOptions);
@@ -481,8 +478,7 @@ 
                     $msg .= ' Your password might not match the password policy.';
                 }
                 throw new \adLDAP\adLDAPException($msg);
-            }
-            else {
+            } else {
                 return false;
             }
         }
@@ -600,11 +596,9 @@ 
         for ($i=0; $i < $entries["count"]; $i++) {
             if ($includeDescription && strlen($entries[$i]["displayname"][0]) > 0) {
                 $usersArray[$entries[$i]["samaccountname"][0]] = $entries[$i]["displayname"][0];
-            }
-            else if ($includeDescription) {
+            } else if ($includeDescription) {
                 $usersArray[$entries[$i]["samaccountname"][0]] = $entries[$i]["samaccountname"][0];
-            }
-            else {
+            } else {
                 array_push($usersArray, $entries[$i]["samaccountname"][0]);
             }
         }

includes/libraries/LDAP/adLDAP/classes/adLDAPUtils.php

Doc Comments +1 added lines, -1 removed lines

@@ -253,7 +253,7 @@
     * Round a Windows timestamp down to seconds and remove the seconds between 1601-01-01 and 1970-01-01
     * 
     * @param long $windowsTime
-    * @return long $unixTime
+    * @return double $unixTime
     */
     public static function convertWindowsTimeToUnixTime($windowsTime) {
       $unixTime = round($windowsTime / 10000000) - 11644473600; 

Indentation +79 added lines, -79 removed lines

@@ -44,10 +44,10 @@ 
     const ADLDAP_VERSION = '5.0.0';
     
     /**
-    * The current adLDAP connection via dependency injection
-    * 
-    * @var adLDAP
-    */
+     * The current adLDAP connection via dependency injection
+     * 
+     * @var adLDAP
+     */
     protected $adldap;
     
     public function __construct(adLDAP $adldap) {
@@ -56,11 +56,11 @@ 
     
     
     /**
-    * Take an LDAP query and return the nice names, without all the LDAP prefixes (eg. CN, DN)
-    *
-    * @param array $groups
-    * @return array
-    */
+     * Take an LDAP query and return the nice names, without all the LDAP prefixes (eg. CN, DN)
+     *
+     * @param array $groups
+     * @return array
+     */
     public function niceNames($groups) {
 
         $groupArray = array();
@@ -79,43 +79,43 @@ 
     }
     
     /**
-    * Escape characters for use in an ldap_create function
-    * 
-    * @param string $str
-    * @return string
-    */
+     * Escape characters for use in an ldap_create function
+     * 
+     * @param string $str
+     * @return string
+     */
     public function escapeCharacters($str) {
         $str = str_replace(",", "\,", $str);
         return $str;
     }
     
     /**
-    * Escape strings for the use in LDAP filters
-    * 
-    * DEVELOPERS SHOULD BE DOING PROPER FILTERING IF THEY'RE ACCEPTING USER INPUT
-    * Ported from Perl's Net::LDAP::Util escape_filter_value
-    *
-    * @param string $str The string the parse
-    * @author Port by Andreas Gohr <andi@splitbrain.org>
-    * @author Modified for PHP55 by Esteban Santana Santana <MentalPower@GMail.com>
-    * @return string
-    */
+     * Escape strings for the use in LDAP filters
+     * 
+     * DEVELOPERS SHOULD BE DOING PROPER FILTERING IF THEY'RE ACCEPTING USER INPUT
+     * Ported from Perl's Net::LDAP::Util escape_filter_value
+     *
+     * @param string $str The string the parse
+     * @author Port by Andreas Gohr <andi@splitbrain.org>
+     * @author Modified for PHP55 by Esteban Santana Santana <MentalPower@GMail.com>
+     * @return string
+     */
     public function ldapSlashes($str) {
         return preg_replace_callback(
-      		'/([\x00-\x1F\*\(\)\\\\])/',
-        	function ($matches) {
-            	return "\\".join("", unpack("H2", $matches[1]));
-        	},
-        	$str
-    	);
+                '/([\x00-\x1F\*\(\)\\\\])/',
+            function ($matches) {
+                return "\\".join("", unpack("H2", $matches[1]));
+            },
+            $str
+        );
     }
     
     /**
-    * Converts a string GUID to a hexdecimal value so it can be queried
-    * 
-    * @param string $strGUID A string representation of a GUID
-    * @return string
-    */
+     * Converts a string GUID to a hexdecimal value so it can be queried
+     * 
+     * @param string $strGUID A string representation of a GUID
+     * @return string
+     */
     public function strGuidToHex($strGUID) {
         $strGUID = str_replace('-', '', $strGUID);
 
@@ -138,12 +138,12 @@ 
     }
     
     /**
-    * Convert a binary SID to a text SID
-    * 
-    * @param string $binsid A Binary SID
-    * @return string
-    */
-     public function getTextSID($binsid) {
+     * Convert a binary SID to a text SID
+     * 
+     * @param string $binsid A Binary SID
+     * @return string
+     */
+        public function getTextSID($binsid) {
         $hex_sid = bin2hex($binsid);
         $rev = hexdec(substr($hex_sid, 0, 2));
         $subcount = hexdec(substr($hex_sid, 2, 2));
@@ -158,28 +158,28 @@ 
 
         // Cheat by tacking on the S-
         return 'S-' . $result;
-     }
+        }
      
     /**
-    * Converts a little-endian hex number to one that hexdec() can convert
-    * 
-    * @param string $hex A hex code
-    * @return string
-    */
-     public function littleEndian($hex) {
+     * Converts a little-endian hex number to one that hexdec() can convert
+     * 
+     * @param string $hex A hex code
+     * @return string
+     */
+        public function littleEndian($hex) {
         $result = '';
         for ($x = strlen($hex) - 2; $x >= 0; $x = $x - 2) {
             $result .= substr($hex, $x, 2);
         }
         return $result;
-     }
+        }
      
-     /**
-    * Converts a binary attribute to a string
-    * 
-    * @param string $bin A binary LDAP attribute
-    * @return string
-    */
+        /**
+         * Converts a binary attribute to a string
+         * 
+         * @param string $bin A binary LDAP attribute
+         * @return string
+         */
     public function binaryToText($bin) {
         $hex_guid = bin2hex($bin); 
         $hex_guid_to_guid_str = ''; 
@@ -200,11 +200,11 @@ 
     }
     
     /**
-    * Converts a binary GUID to a string GUID
-    * 
-    * @param string $binaryGuid The binary GUID attribute to convert
-    * @return string
-    */
+     * Converts a binary GUID to a string GUID
+     * 
+     * @param string $binaryGuid The binary GUID attribute to convert
+     * @return string
+     */
     public function decodeGuid($binaryGuid) {
         if ($binaryGuid === null){ return "Missing compulsory field [binaryGuid]"; }
         
@@ -213,19 +213,19 @@ 
     }
     
     /**
-    * Convert a boolean value to a string
-    * You should never need to call this yourself
-    *
-    * @param bool $bool Boolean value
-    * @return string
-    */
+     * Convert a boolean value to a string
+     * You should never need to call this yourself
+     *
+     * @param bool $bool Boolean value
+     * @return string
+     */
     public function boolToStr($bool) {
         return ($bool) ? 'TRUE' : 'FALSE';
     }
     
     /**
-    * Convert 8bit characters e.g. accented characters to UTF8 encoded characters
-    */
+     * Convert 8bit characters e.g. accented characters to UTF8 encoded characters
+     */
     public function encode8Bit(&$item, $key) {
         $encode = false;
         if (is_string($item)) {
@@ -241,23 +241,23 @@ 
     }  
     
     /**
-    * Get the current class version number
-    * 
-    * @return string
-    */
+     * Get the current class version number
+     * 
+     * @return string
+     */
     public function getVersion() {
         return self::ADLDAP_VERSION;
     }
     
     /**
-    * Round a Windows timestamp down to seconds and remove the seconds between 1601-01-01 and 1970-01-01
-    * 
-    * @param long $windowsTime
-    * @return long $unixTime
-    */
+     * Round a Windows timestamp down to seconds and remove the seconds between 1601-01-01 and 1970-01-01
+     * 
+     * @param long $windowsTime
+     * @return long $unixTime
+     */
     public static function convertWindowsTimeToUnixTime($windowsTime) {
-      $unixTime = round($windowsTime / 10000000) - 11644473600; 
-      return $unixTime; 
+        $unixTime = round($windowsTime / 10000000) - 11644473600; 
+        return $unixTime; 
     }
 
     /**

Spacing +31 added lines, -31 removed lines

@@ -35,7 +35,7 @@ 
  * @version 5.0.0
  * @link http://github.com/adldap/adLDAP
  */
-require_once(dirname(__FILE__) . '/../adLDAP.php');
+require_once(dirname(__FILE__).'/../adLDAP.php');
 
 /**
 * UTILITY FUNCTIONS
@@ -64,15 +64,15 @@ 
     public function niceNames($groups) {
 
         $groupArray = array();
-        for ($i=0; $i<$groups["count"]; $i++) { // For each group
+        for ($i = 0; $i < $groups["count"]; $i++) { // For each group
             $line = $groups[$i];
             
-            if (strlen($line)>0) { 
+            if (strlen($line) > 0) { 
                 // More presumptions, they're all prefixed with CN=
                 // so we ditch the first three characters and the group
                 // name goes up to the first comma
-                $bits=explode(",", $line);
-                $groupArray[] = substr($bits[0], 3, (strlen($bits[0])-3));
+                $bits = explode(",", $line);
+                $groupArray[] = substr($bits[0], 3, (strlen($bits[0]) - 3));
             }
         }
         return $groupArray;    
@@ -103,7 +103,7 @@ 
     public function ldapSlashes($str) {
         return preg_replace_callback(
       		'/([\x00-\x1F\*\(\)\\\\])/',
-        	function ($matches) {
+        	function($matches) {
             	return "\\".join("", unpack("H2", $matches[1]));
         	},
         	$str
@@ -119,18 +119,18 @@ 
     public function strGuidToHex($strGUID) {
         $strGUID = str_replace('-', '', $strGUID);
 
-        $octet_str = '\\' . substr($strGUID, 6, 2);
-        $octet_str .= '\\' . substr($strGUID, 4, 2);
-        $octet_str .= '\\' . substr($strGUID, 2, 2);
-        $octet_str .= '\\' . substr($strGUID, 0, 2);
-        $octet_str .= '\\' . substr($strGUID, 10, 2);
-        $octet_str .= '\\' . substr($strGUID, 8, 2);
-        $octet_str .= '\\' . substr($strGUID, 14, 2);
-        $octet_str .= '\\' . substr($strGUID, 12, 2);
+        $octet_str = '\\'.substr($strGUID, 6, 2);
+        $octet_str .= '\\'.substr($strGUID, 4, 2);
+        $octet_str .= '\\'.substr($strGUID, 2, 2);
+        $octet_str .= '\\'.substr($strGUID, 0, 2);
+        $octet_str .= '\\'.substr($strGUID, 10, 2);
+        $octet_str .= '\\'.substr($strGUID, 8, 2);
+        $octet_str .= '\\'.substr($strGUID, 14, 2);
+        $octet_str .= '\\'.substr($strGUID, 12, 2);
         //$octet_str .= '\\' . substr($strGUID, 16, strlen($strGUID));
-        for ($i=16; $i<=(strlen($strGUID)-2); $i++) {
+        for ($i = 16; $i <= (strlen($strGUID) - 2); $i++) {
             if (($i % 2) == 0) {
-                $octet_str .= '\\' . substr($strGUID, $i, 2);
+                $octet_str .= '\\'.substr($strGUID, $i, 2);
             }
         }
         
@@ -150,14 +150,14 @@ 
         $auth = hexdec(substr($hex_sid, 4, 12));
         $result = "$rev-$auth";
 
-        for ($x=0;$x < $subcount; $x++) {
+        for ($x = 0; $x < $subcount; $x++) {
             $subauth[$x] =
                 hexdec($this->littleEndian(substr($hex_sid, 16 + ($x * 8), 8)));
-                $result .= "-" . $subauth[$x];
+                $result .= "-".$subauth[$x];
         }
 
         // Cheat by tacking on the S-
-        return 'S-' . $result;
+        return 'S-'.$result;
      }
      
     /**
@@ -183,19 +183,19 @@ 
     public function binaryToText($bin) {
         $hex_guid = bin2hex($bin); 
         $hex_guid_to_guid_str = ''; 
-        for($k = 1; $k <= 4; ++$k) { 
+        for ($k = 1; $k <= 4; ++$k) { 
             $hex_guid_to_guid_str .= substr($hex_guid, 8 - 2 * $k, 2); 
         } 
         $hex_guid_to_guid_str .= '-'; 
-        for($k = 1; $k <= 2; ++$k) { 
+        for ($k = 1; $k <= 2; ++$k) { 
             $hex_guid_to_guid_str .= substr($hex_guid, 12 - 2 * $k, 2); 
         } 
         $hex_guid_to_guid_str .= '-'; 
-        for($k = 1; $k <= 2; ++$k) { 
+        for ($k = 1; $k <= 2; ++$k) { 
             $hex_guid_to_guid_str .= substr($hex_guid, 16 - 2 * $k, 2); 
         } 
-        $hex_guid_to_guid_str .= '-' . substr($hex_guid, 16, 4); 
-        $hex_guid_to_guid_str .= '-' . substr($hex_guid, 20); 
+        $hex_guid_to_guid_str .= '-'.substr($hex_guid, 16, 4); 
+        $hex_guid_to_guid_str .= '-'.substr($hex_guid, 20); 
         return strtoupper($hex_guid_to_guid_str);   
     }
     
@@ -206,7 +206,7 @@ 
     * @return string
     */
     public function decodeGuid($binaryGuid) {
-        if ($binaryGuid === null){ return "Missing compulsory field [binaryGuid]"; }
+        if ($binaryGuid === null) { return "Missing compulsory field [binaryGuid]"; }
         
         $strGUID = $this->binaryToText($binaryGuid);          
         return $strGUID; 
@@ -229,7 +229,7 @@ 
     public function encode8Bit(&$item, $key) {
         $encode = false;
         if (is_string($item)) {
-            for ($i=0; $i<strlen($item); $i++) {
+            for ($i = 0; $i < strlen($item); $i++) {
                 if (ord($item[$i]) >> 7) {
                     $encode = true;
                 }
@@ -268,16 +268,16 @@ 
      *
      * @return array
      */
-    public function dnStrToArr($dnStr, $excludeBaseDn = true){
+    public function dnStrToArr($dnStr, $excludeBaseDn = true) {
         $dnArr = array();
-        if(!empty($dnStr)){
+        if (!empty($dnStr)) {
             $tmpArr = explode(',', $dnStr);
             $baseDnArr = explode(',', $this->adldap->getBaseDn());
-            foreach($tmpArr as $_tmpStr){
-                if($excludeBaseDn && in_array($_tmpStr, $baseDnArr)){
+            foreach ($tmpArr as $_tmpStr) {
+                if ($excludeBaseDn && in_array($_tmpStr, $baseDnArr)) {
                     continue;
                 }
-                $dnArr[]= substr($_tmpStr, strpos($_tmpStr, '=') + 1);
+                $dnArr[] = substr($_tmpStr, strpos($_tmpStr, '=') + 1);
             }
         }
         return $dnArr;

includes/libraries/PasswordLib/Core/BigMath/BCMath.php

Doc Comments +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
      * @param string $left  The left argument
      * @param string $right The right argument
      * 
-     * @return A base-10 string of the sum of the two arguments
+     * @return string base-10 string of the sum of the two arguments
      */
     public function add($left, $right) {
         return bcadd($left, $right, 0);
@@ -41,7 +41,7 @@ 
      * @param string $left  The left argument
      * @param string $right The right argument
      * 
-     * @return A base-10 string of the difference of the two arguments
+     * @return string base-10 string of the difference of the two arguments
      */
     public function subtract($left, $right) {
         return bcsub($left, $right);

includes/libraries/PasswordLib/Core/BigMath/GMP.php

Doc Comments +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
      * @param string $left  The left argument
      * @param string $right The right argument
      * 
-     * @return A base-10 string of the sum of the two arguments
+     * @return string base-10 string of the sum of the two arguments
      */
     public function add($left, $right) {
         return gmp_strval(gmp_add($left, $right));
@@ -41,7 +41,7 @@ 
      * @param string $left  The left argument
      * @param string $right The right argument
      * 
-     * @return A base-10 string of the difference of the two arguments
+     * @return string base-10 string of the difference of the two arguments
      */
     public function subtract($left, $right) {
         return gmp_strval(gmp_sub($left, $right));