Merge remote-tracking branch 'Maks3w/hotfix/ZF-27-LDAP'

zendframework · May 1, 2012 · f50be5f · f50be5f
commit f50be5f
Show file tree

Hide file tree

Showing 35 changed files with 169 additions and 189 deletions.
diff --git a/src/Attribute.php b/src/Attribute.php
@@ -39,25 +39,24 @@ class Attribute
     /**
      * Sets a LDAP attribute.
      *
-     * @param  array                    $data
-     * @param  string                   $attribName
-     * @param  scalar|array|Traversable $value
-     * @param  boolean                  $append
+     * @param  array                     $data
+     * @param  string                    $attribName
+     * @param  string|array|\Traversable $value
+     * @param  boolean                   $append
      * @return void
      */
     public static function setAttribute(array &$data, $attribName, $value, $append = false)
     {
         $attribName = strtolower($attribName);
         $valArray   = array();
         if (is_array($value) || ($value instanceof \Traversable)) {
-            foreach ($value as $v)
-            {
+            foreach ($value as $v) {
                 $v = self::valueToLdap($v);
                 if ($v !== null) {
                     $valArray[] = $v;
                 }
             }
-        } elseif ($value !== null) {
+        } else if ($value !== null) {
             $value = self::valueToLdap($value);
             if ($value !== null) {
                 $valArray[] = $value;
@@ -90,8 +89,7 @@ public static function getAttribute(array $data, $attribName, $index = null)
                 return array();
             }
             $retArray = array();
-            foreach ($data[$attribName] as $v)
-            {
+            foreach ($data[$attribName] as $v) {
                 $retArray[] = self::valueFromLDAP($v);
             }
             return $retArray;
@@ -173,8 +171,7 @@ public static function removeFromAttribute(array &$data, $attribName, $value)
         }
 
         $valArray = array();
-        foreach ($value as $v)
-        {
+        foreach ($value as $v) {
             $v = self::valueToLDAP($v);
             if ($v !== null) {
                 $valArray[] = $v;
@@ -284,16 +281,16 @@ public static function convertFromLdapDateTimeValue($value)
     /**
      * Sets a LDAP password.
      *
-     * @param  array       $data
-     * @param  string      $password
-     * @param  string      $hashType
-     * @param  string|null $attribName
-     * @return null
+     * @param array  $data
+     * @param string $password
+     * @param string $hashType   Optional by default MD5
+     * @param string $attribName Optional
      */
     public static function setPassword(
         array &$data, $password, $hashType = self::PASSWORD_HASH_MD5,
         $attribName = null
-    ) {
+    )
+    {
         if ($attribName === null) {
             if ($hashType === self::PASSWORD_UNICODEPWD) {
                 $attribName = 'unicodePwd';
@@ -360,12 +357,11 @@ public static function createPassword($password, $hashType = self::PASSWORD_HASH
     /**
      * Sets a LDAP date/time attribute.
      *
-     * @param  array                     $data
-     * @param  string                    $attribName
-     * @param  integer|array|Traversable $value
-     * @param  boolean                   $utc
-     * @param  boolean                   $append
-     * @return null
+     * @param  array                      $data
+     * @param  string                     $attribName
+     * @param  integer|array|\Traversable $value
+     * @param  boolean                    $utc
+     * @param  boolean                    $append
      */
     public static function setDateTimeAttribute(
         array &$data, $attribName, $value, $utc = false,

diff --git a/src/Collection/DefaultIterator.php b/src/Collection/DefaultIterator.php
@@ -20,8 +20,8 @@
 
 namespace Zend\Ldap\Collection;
 
-use Zend\Ldap,
-    Zend\Ldap\Exception;
+use Zend\Ldap;
+use Zend\Ldap\Exception;
 
 /**
  * Zend\Ldap\Collection\DefaultIterator is the default collection iterator implementation
@@ -41,7 +41,7 @@ class DefaultIterator implements \Iterator, \Countable
     /**
      * LDAP Connection
      *
-     * @var Ldap\Ldap
+     * @var \Zend\Ldap\Ldap
      */
     protected $ldap = null;
 
@@ -76,10 +76,10 @@ class DefaultIterator implements \Iterator, \Countable
     /**
      * Constructor.
      *
-     * @param  Ldap\Ldap $ldap
-     * @param  resource  $resultId
-     * @return void
-     * @throws Exception\LdapException if no entries was found.
+     * @param  \Zend\Ldap\Ldap $ldap
+     * @param  resource        $resultId
+     * @throws \Zend\Ldap\Exception\LdapException if no entries was found.
+     * @return DefaultIterator
      */
     public function __construct(Ldap\Ldap $ldap, $resultId)
     {
@@ -115,7 +115,7 @@ public function close()
     /**
      * Gets the current LDAP connection.
      *
-     * @return Ldap\Ldap
+     * @return \Zend\Ldap\Ldap
      */
     public function getLDAP()
     {
@@ -190,7 +190,7 @@ public function count()
      * Implements Iterator
      *
      * @return array|null
-     * @throws Exception\LdapException
+     * @throws \Zend\Ldap\Exception\LdapException
      */
     public function current()
     {
@@ -239,8 +239,8 @@ public function current()
      * Return the result item key
      * Implements Iterator
      *
+     * @throws \Zend\Ldap\Exception\LdapException
      * @return string|null
-     * @throws Exception\LdapException if can't get Dn.
      */
     public function key()
     {
@@ -263,7 +263,8 @@ public function key()
      * Move forward to next result item
      * Implements Iterator
      *
-     * @throws Exception\LdapException
+     * @throws \Zend\Ldap\Exception\LdapException
+     * @return
      */
     public function next()
     {
@@ -289,7 +290,8 @@ public function next()
      * Rewind the Iterator to the first result item
      * Implements Iterator
      *
-     * @throws Exception\LdapException
+     *
+     * @throws \Zend\Ldap\Exception\LdapException
      */
     public function rewind()
     {

diff --git a/src/Dn.php b/src/Dn.php
@@ -148,6 +148,7 @@ public function getRdnString($caseFold = null)
      * Get the parent DN $levelUp levels up the tree
      *
      * @param  int $levelUp
+     * @throws Exception\LdapException
      * @return Dn
      */
     public function getParentDn($levelUp = 1)

diff --git a/src/Exception/BadMethodCallException.php b/src/Exception/BadMethodCallException.php
@@ -20,14 +20,12 @@
 
 namespace Zend\Ldap\Exception;
 
-use Zend\Ldap\Exception;
-
 /**
  * @category   Zend
  * @package    Zend_Ldap
  * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
-class BadMethodCallException extends \BadMethodCallException implements Exception
+class BadMethodCallException extends \BadMethodCallException implements ExceptionInterface
 {
 }
diff --git a/src/Exception.php → src/Exception/ExceptionInterface.php b/src/Exception.php → src/Exception/ExceptionInterface.php
@@ -19,14 +19,14 @@
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 
-namespace Zend\Ldap;
+namespace Zend\Ldap\Exception;
 
 /**
  * @category   Zend
  * @package    Zend_Ldap
  * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
-interface Exception
+interface ExceptionInterface
 {
 }
diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php
@@ -20,14 +20,12 @@
 
 namespace Zend\Ldap\Exception;
 
-use Zend\Ldap\Exception;
-
 /**
  * @category   Zend
  * @package    Zend_Ldap
  * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
-class InvalidArgumentException extends \InvalidArgumentException implements Exception
+class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
 {
 }
diff --git a/src/Exception/LdapException.php b/src/Exception/LdapException.php
@@ -20,16 +20,15 @@
 
 namespace Zend\Ldap\Exception;
 
-use Zend\Ldap\Ldap,
-    Zend\Ldap\Exception;
+use Zend\Ldap\Ldap;
 
 /**
  * @category   Zend
  * @package    Zend_Ldap
  * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
-class LdapException extends \Exception implements Exception
+class LdapException extends \Exception implements ExceptionInterface
 {
     const LDAP_SUCCESS                        = 0x00;
     const LDAP_OPERATIONS_ERROR               = 0x01;
@@ -114,9 +113,9 @@ class LdapException extends \Exception implements Exception
     const LDAP_X_EXTENSION_NOT_LOADED = 0x7002;
 
     /**
-     * @param Ldap   $ldap A Zend\Ldap\Ldap object
-     * @param string $str  An informtive exception message
-     * @param int    $code An LDAP error code
+     * @param Ldap   $ldap Zend\Ldap\Ldap object
+     * @param string $str  Informative exception message
+     * @param int    $code LDAP error code
      */
     public function __construct(Ldap $ldap = null, $str = null, $code = 0)
     {

diff --git a/src/Filter/Exception.php → src/Filter/Exception/ExceptionInterface.php b/src/Filter/Exception.php → src/Filter/Exception/ExceptionInterface.php
@@ -18,16 +18,16 @@
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 
-namespace Zend\Ldap\Filter;
+namespace Zend\Ldap\Filter\Exception;
 
-use Zend\Ldap;
+use Zend\Ldap\Exception\ExceptionInterface as MainLdapException;
 
 /**
  * @category   Zend
  * @package    Zend_Ldap
  * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
-interface Exception extends Ldap\Exception
+interface ExceptionInterface extends MainLdapException
 {
 }
diff --git a/src/Filter/Exception/FilterException.php b/src/Filter/Exception/FilterException.php
@@ -21,15 +21,13 @@
 
 namespace Zend\Ldap\Filter\Exception;
 
-use Zend\Ldap\Filter\Exception;
-
 /**
  * @category   Zend
  * @package    Zend_Ldap
  * @subpackage Filter
  * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
-class FilterException extends \Exception implements Exception
+class FilterException extends \Exception implements ExceptionInterface
 {
 }
diff --git a/src/Filter/LogicalFilter.php b/src/Filter/LogicalFilter.php
@@ -56,6 +56,7 @@ abstract class LogicalFilter extends AbstractFilter
      *
      * @param array  $subfilters
      * @param string $symbol
+     * @throws Exception\FilterException
      */
     protected function __construct(array $subfilters, $symbol)
     {

diff --git a/src/Ldap.php b/src/Ldap.php
@@ -88,8 +88,7 @@ class Ldap
      * Constructor.
      *
      * @param  array|Traversable $options Options used in connecting, binding, etc.
-     * @return void
-     * @throws Exception\LdapException if ext/ldap is not installed
+     * @throws Exception\LdapException
      */
     public function __construct($options = array())
     {
@@ -175,9 +174,8 @@ public function getLastError(&$errorCode = null, array &$errorMessages = null)
         $message = '';
         if ($errorCode > 0) {
             $message = '0x' . dechex($errorCode) . ' ';
-        } else {
-            $message = '';
         }
+
         if (count($errorMessages) > 0) {
             $message .= '(' . implode('; ', $errorMessages) . ')';
         } else {
@@ -194,7 +192,7 @@ public function getLastError(&$errorCode = null, array &$errorMessages = null)
      * NULL if there has been an anonymous bind
      * username of the currently bound user
      *
-     * @return false|null|string
+     * @return bool|null|string
      */
     public function getBoundUser()
     {
@@ -452,14 +450,13 @@ protected function getNetworkTimeout()
     }
 
     /**
-     * @param  strint $acctname
+     * @param  string $acctname
      * @return string The LDAP search filter for matching directory accounts
      */
     protected function getAccountFilter($acctname)
     {
         $dname = '';
         $aname = '';
-
         $this->splitName($acctname, $dname, $aname);
         $accountFilterFormat = $this->getAccountFilterFormat();
         $aname               = Filter\AbstractFilter::escapeValue($aname);
@@ -1074,8 +1071,8 @@ public function getEntry($dn, array $attributes = array(), $throwOnNotFound = fa
      * Prepares an ldap data entry array for insert/update operation
      *
      * @param  array $entry
+     * @throws Exception\InvalidArgumentException
      * @return void
-     * @throws InvalidArgumentException\LdapException
      */
     public static function prepareLdapEntryArray(array &$entry)
     {
@@ -1263,6 +1260,7 @@ public function delete($dn, $recursively = false)
      * or {@see copy()}
      *
      * @param  string|Dn $parentDn
+     * @throws Exception\LdapException
      * @return array of DNs
      */
     protected function getChildrenDns($parentDn)
@@ -1338,7 +1336,7 @@ public function move($from, $to, $recursively = false, $alwaysEmulate = false)
     /**
      * Renames a LDAP entry from one DN to another DN.
      *
-     * This method implicitely moves the entry to another location within the tree.
+     * This method implicitly moves the entry to another location within the tree.
      *
      * @param  string|Dn $from
      * @param  string|Dn $to

diff --git a/src/Ldif/Encoder.php b/src/Ldif/Encoder.php
@@ -179,8 +179,8 @@ protected function _encode($value)
      *
      * @link http://www.faqs.org/rfcs/rfc2849.html
      *
-     * @param  string $string
-     * @param  boolen $base64
+     * @param  string  $string
+     * @param  boolean $base64
      * @return string
      */
     protected function encodeString($string, &$base64 = null)