silverstripe / silverstripe-activedirectory

code/model/LDAPUtil.php

Doc Comments +8 added lines, -1 removed lines

@@ -9,7 +9,7 @@ 
     /**
      * Checks if the string is a valid guid in the format of A98C5A1E-A742-4808-96FA-6F409E799937
      *
-     * @param $guid
+     * @param string $guid
      * @return bool
      */
     public static function validGuid($guid)
@@ -41,6 +41,9 @@ 
         return strtoupper($hex_guid_to_guid_str);
     }
 
+    /**
+     * @param string $str_guid
+     */
     public static function str_to_hex_guid($str_guid, $escape = false)
     {
         $str_guid = str_replace('-', '', $str_guid);
@@ -87,6 +90,10 @@ 
     }
 
     // Converts a little-endian hex-number to one, that 'hexdec' can convert
+
+    /**
+     * @param string $hex
+     */
     public static function little_endian($hex)
     {
         $result = '';

code/tasks/LDAPMigrateExistingMembersTask.php

Doc Comments +3 added lines

@@ -52,6 +52,9 @@
         $this->log(sprintf('Done. Migrated %s Member records. Duration: %s seconds', $count, round($end, 0)));
     }
 
+    /**
+     * @param string $message
+     */
     protected function log($message)
     {
         $message = sprintf('[%s] ', date('Y-m-d H:i:s')) . $message;

code/tasks/LDAPGroupSyncTask.php

Doc Comments +3 added lines

@@ -115,6 +115,9 @@
         ));
     }
 
+    /**
+     * @param string $message
+     */
     protected function log($message)
     {
         $message = sprintf('[%s] ', date('Y-m-d H:i:s')) . $message;

code/tasks/LDAPMemberSyncTask.php

Doc Comments +3 added lines

@@ -115,6 +115,9 @@
         ));
     }
 
+    /**
+     * @param string $message
+     */
     protected function log($message)
     {
         $message = sprintf('[%s] ', date('Y-m-d H:i:s')) . $message;

code/control/LDAPSecurityController.php

Doc Comments +2 added lines, -2 removed lines

@@ -38,7 +38,7 @@ 
     /**
      * Factory method for the lost password form
      *
-     * @return Form Returns the lost password form
+     * @return Object Returns the lost password form
      */
     public function ChangePasswordForm()
     {
@@ -101,7 +101,7 @@ 
     }
 
     /**
-     * @param null $action
+     * @param string $action
      * @return String
      */
     public function Link($action = null)

code/services/LDAPService.php

Doc Comments +4 added lines, -4 removed lines

@@ -83,7 +83,7 @@ 
      * Get the cache objecgt used for LDAP results. Note that the default lifetime set here
      * is 8 hours, but you can change that by calling SS_Cache::set_lifetime('ldap', <lifetime in seconds>)
      *
-     * @return Zend_Cache_Frontend
+     * @return Zend_Cache_Core
      */
     public static function get_cache()
     {
@@ -237,7 +237,7 @@ 
      * Note that these get cached in-memory per-request for performance to avoid re-querying for the same results.
      *
      * @param string $dn
-     * @param array $attributes List of specific AD attributes to return. Empty array means return everything.
+     * @param string[] $attributes List of specific AD attributes to return. Empty array means return everything.
      * @return array
      */
     public function getNestedGroups($dn, $attributes = [])
@@ -444,7 +444,7 @@ 
      * @param Member
      * @param array|null $data If passed, this is pre-existing AD attribute data to update the Member with.
      *            If not given, the data will be looked up by the user's GUID.
-     * @return bool
+     * @return false|null
      */
     public function updateMemberFromLDAP(Member $member, $data = null)
     {
@@ -619,7 +619,7 @@ 
      * @param Group $group An existing Group or a new Group object
      * @param array $data LDAP group object data
      *
-     * @return bool
+     * @return false|null
      */
     public function updateGroupFromLDAP(Group $group, $data)
     {

code/authenticators/LDAPAuthenticator.php

Doc Comments +4 added lines, -1 removed lines

@@ -67,7 +67,7 @@ 
      *
      * @throws SS_HTTPResponse_Exception
      *
-     * @return bool|Member|void
+     * @return null|Member
      */
     public static function authenticate($data, Form $form = null)
     {
@@ -145,6 +145,9 @@ 
         );
     }
 
+    /**
+     * @param null|Form $form
+     */
     private static function form_error_msg($form, $message)
     {
         if (!$form) {