merged branch gimler/encoder_fix (PR #3122)

fabpot · fabpot · commit 277b78149d2e · 2012-01-16T21:52:05.000+01:00
Commits ------- f3c413d add missing class var; add phpdocs Discussion ---------- add missing class var; add phpdocs Bug fix: yes Feature addition: no Backwards compatibility break: no Symfony2 tests pass: yes --------------------------------------------------------------------------- by fabpot at 2012-01-16T11:12:27Z We don't document properties, especially private ones. --------------------------------------------------------------------------- by vicb at 2012-01-16T11:20:44Z Good doc always help and should be accepted even for private properties. However sometimes doc isn't necessary: `The digest algorithm to use` does not bring more information than the name itself `MessageDigestPasswordEncoder::algorithm`, the `@var` annotation could be useful - even more for objects & arrays. --------------------------------------------------------------------------- by gimler at 2012-01-16T11:37:54Z i have remove the private property comments.
diff --git a/src/Symfony/Component/Security/Core/Encoder/MessageDigestPasswordEncoder.php b/src/Symfony/Component/Security/Core/Encoder/MessageDigestPasswordEncoder.php
@@ -20,6 +20,7 @@ class MessageDigestPasswordEncoder extends BasePasswordEncoder
 {
     private $algorithm;
     private $encodeHashAsBase64;
+    private $iterations;
 
     /**
      * Constructor.
diff --git a/src/Symfony/Component/Security/Core/Encoder/PlaintextPasswordEncoder.php b/src/Symfony/Component/Security/Core/Encoder/PlaintextPasswordEncoder.php
@@ -20,6 +20,11 @@ class PlaintextPasswordEncoder extends BasePasswordEncoder
 {
     private $ignorePasswordCase;
 
+    /**
+     * Constructor.
+     *
+     * @param Boolean $ignorePasswordCase Compare password case-insensitive
+     */
     public function __construct($ignorePasswordCase = false)
     {
         $this->ignorePasswordCase = $ignorePasswordCase;

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ class MessageDigestPasswordEncoder extends BasePasswordEncoder`
`20`	`20`	`{`
`21`	`21`	`private $algorithm;`
`22`	`22`	`private $encodeHashAsBase64;`
	`23`	`+ private $iterations;`
`23`	`24`
`24`	`25`	`/**`
`25`	`26`	`* Constructor.`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,11 @@ class PlaintextPasswordEncoder extends BasePasswordEncoder`
`20`	`20`	`{`
`21`	`21`	`private $ignorePasswordCase;`
`22`	`22`
	`23`	`+ /**`
	`24`	`+ * Constructor.`
	`25`	`+ *`
	`26`	`+ * @param Boolean $ignorePasswordCase Compare password case-insensitive`
	`27`	`+ */`
`23`	`28`	`public function __construct($ignorePasswordCase = false)`
`24`	`29`	`{`
`25`	`30`	`$this->ignorePasswordCase = $ignorePasswordCase;`