Permalink
Browse files

* Fixed phpdoc comments to please PHP_CodeSniffer and (especially) Ph…

…pStorm.

* Other minor phpdoc and CS fixes
 Last batch


git-svn-id: http://svn.php.net/repository/pear/packages/HTML_QuickForm2/trunk@323363 c90b9560-bf6c-de11-be94-00142212c4b1
  • Loading branch information...
1 parent 2e18855 commit d7c7ac5554995c0dae2917b56c9ee75866e764a8 @sad-spirit sad-spirit committed Feb 19, 2012
Showing with 995 additions and 835 deletions.
  1. +17 −15 HTML/QuickForm2/Controller/Action.php
  2. +15 −13 HTML/QuickForm2/Controller/Action/Back.php
  3. +15 −13 HTML/QuickForm2/Controller/Action/Direct.php
  4. +16 −14 HTML/QuickForm2/Controller/Action/Display.php
  5. +22 −17 HTML/QuickForm2/Controller/Action/Jump.php
  6. +16 −14 HTML/QuickForm2/Controller/Action/Next.php
  7. +15 −13 HTML/QuickForm2/Controller/Action/Submit.php
  8. +21 −18 HTML/QuickForm2/Controller/DefaultAction.php
  9. +31 −23 HTML/QuickForm2/Controller/Page.php
  10. +37 −29 HTML/QuickForm2/Controller/SessionContainer.php
  11. +28 −23 HTML/QuickForm2/Element/Button.php
  12. +114 −107 HTML/QuickForm2/Element/Date.php
  13. +35 −27 HTML/QuickForm2/Element/Hierselect.php
  14. +15 −13 HTML/QuickForm2/Element/Input.php
  15. +21 −17 HTML/QuickForm2/Element/InputButton.php
  16. +19 −16 HTML/QuickForm2/Element/InputCheckable.php
  17. +15 −13 HTML/QuickForm2/Element/InputCheckbox.php
  18. +31 −26 HTML/QuickForm2/Element/InputFile.php
  19. +18 −15 HTML/QuickForm2/Element/InputHidden.php
  20. +26 −22 HTML/QuickForm2/Element/InputImage.php
  21. +15 −13 HTML/QuickForm2/Element/InputPassword.php
  22. +15 −13 HTML/QuickForm2/Element/InputRadio.php
  23. +20 −16 HTML/QuickForm2/Element/InputReset.php
  24. +23 −19 HTML/QuickForm2/Element/InputSubmit.php
  25. +15 −13 HTML/QuickForm2/Element/InputText.php
  26. +17 −14 HTML/QuickForm2/Element/Script.php
  27. +78 −68 HTML/QuickForm2/Element/Select.php
  28. +36 −28 HTML/QuickForm2/Element/Static.php
  29. +15 −13 HTML/QuickForm2/Element/Textarea.php
  30. +26 −21 HTML/QuickForm2/Rule/Callback.php
  31. +23 −18 HTML/QuickForm2/Rule/Compare.php
  32. +19 −15 HTML/QuickForm2/Rule/Each.php
  33. +15 −13 HTML/QuickForm2/Rule/Empty.php
  34. +30 −24 HTML/QuickForm2/Rule/Length.php
  35. +19 −15 HTML/QuickForm2/Rule/MaxFileSize.php
  36. +19 −15 HTML/QuickForm2/Rule/MimeType.php
  37. +17 −14 HTML/QuickForm2/Rule/Nonempty.php
  38. +15 −13 HTML/QuickForm2/Rule/NotCallback.php
  39. +15 −13 HTML/QuickForm2/Rule/NotRegex.php
  40. +17 −14 HTML/QuickForm2/Rule/Regex.php
  41. +19 −15 HTML/QuickForm2/Rule/Required.php
@@ -6,7 +6,7 @@
*
* LICENSE:
*
- * Copyright (c) 2006-2011, Alexey Borzov <avb@php.net>,
+ * Copyright (c) 2006-2012, Alexey Borzov <avb@php.net>,
* Bertrand Mansion <golgote@mamasam.com>
* All rights reserved.
*
@@ -34,32 +34,34 @@
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
- * @category HTML
- * @package HTML_QuickForm2
- * @author Alexey Borzov <avb@php.net>
- * @author Bertrand Mansion <golgote@mamasam.com>
- * @license http://opensource.org/licenses/bsd-license.php New BSD License
- * @version SVN: $Id$
- * @link http://pear.php.net/package/HTML_QuickForm2
+ * @category HTML
+ * @package HTML_QuickForm2
+ * @author Alexey Borzov <avb@php.net>
+ * @author Bertrand Mansion <golgote@mamasam.com>
+ * @license http://opensource.org/licenses/bsd-license.php New BSD License
+ * @version SVN: $Id$
+ * @link http://pear.php.net/package/HTML_QuickForm2
*/
/**
* Interface for Controller action handlers
*
- * @category HTML
- * @package HTML_QuickForm2
- * @author Alexey Borzov <avb@php.net>
- * @author Bertrand Mansion <golgote@mamasam.com>
- * @version Release: @package_version@
+ * @category HTML
+ * @package HTML_QuickForm2
+ * @author Alexey Borzov <avb@php.net>
+ * @author Bertrand Mansion <golgote@mamasam.com>
+ * @license http://opensource.org/licenses/bsd-license.php New BSD License
+ * @version Release: @package_version@
+ * @link http://pear.php.net/package/HTML_QuickForm2
*/
interface HTML_QuickForm2_Controller_Action
{
/**
* Performs the given action upon the given page
*
- * @param HTML_QuickForm2_Controller_Page page of the multipage form
- * @param string action name, some action handlers
+ * @param HTML_QuickForm2_Controller_Page $page page of the multipage form
+ * @param string $name action name, some action handlers
* may perform different tasks depending
* on this
*/
@@ -6,7 +6,7 @@
*
* LICENSE:
*
- * Copyright (c) 2006-2011, Alexey Borzov <avb@php.net>,
+ * Copyright (c) 2006-2012, Alexey Borzov <avb@php.net>,
* Bertrand Mansion <golgote@mamasam.com>
* All rights reserved.
*
@@ -34,13 +34,13 @@
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
- * @category HTML
- * @package HTML_QuickForm2
- * @author Alexey Borzov <avb@php.net>
- * @author Bertrand Mansion <golgote@mamasam.com>
- * @license http://opensource.org/licenses/bsd-license.php New BSD License
- * @version SVN: $Id$
- * @link http://pear.php.net/package/HTML_QuickForm2
+ * @category HTML
+ * @package HTML_QuickForm2
+ * @author Alexey Borzov <avb@php.net>
+ * @author Bertrand Mansion <golgote@mamasam.com>
+ * @license http://opensource.org/licenses/bsd-license.php New BSD License
+ * @version SVN: $Id$
+ * @link http://pear.php.net/package/HTML_QuickForm2
*/
/** Interface for Controller action handlers */
@@ -49,11 +49,13 @@
/**
* Action handler for a 'back' button of wizard-type multipage form
*
- * @category HTML
- * @package HTML_QuickForm2
- * @author Alexey Borzov <avb@php.net>
- * @author Bertrand Mansion <golgote@mamasam.com>
- * @version Release: @package_version@
+ * @category HTML
+ * @package HTML_QuickForm2
+ * @author Alexey Borzov <avb@php.net>
+ * @author Bertrand Mansion <golgote@mamasam.com>
+ * @license http://opensource.org/licenses/bsd-license.php New BSD License
+ * @version Release: @package_version@
+ * @link http://pear.php.net/package/HTML_QuickForm2
*/
class HTML_QuickForm2_Controller_Action_Back
implements HTML_QuickForm2_Controller_Action
@@ -6,7 +6,7 @@
*
* LICENSE:
*
- * Copyright (c) 2006-2011, Alexey Borzov <avb@php.net>,
+ * Copyright (c) 2006-2012, Alexey Borzov <avb@php.net>,
* Bertrand Mansion <golgote@mamasam.com>
* All rights reserved.
*
@@ -34,13 +34,13 @@
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
- * @category HTML
- * @package HTML_QuickForm2
- * @author Alexey Borzov <avb@php.net>
- * @author Bertrand Mansion <golgote@mamasam.com>
- * @license http://opensource.org/licenses/bsd-license.php New BSD License
- * @version SVN: $Id$
- * @link http://pear.php.net/package/HTML_QuickForm2
+ * @category HTML
+ * @package HTML_QuickForm2
+ * @author Alexey Borzov <avb@php.net>
+ * @author Bertrand Mansion <golgote@mamasam.com>
+ * @license http://opensource.org/licenses/bsd-license.php New BSD License
+ * @version SVN: $Id$
+ * @link http://pear.php.net/package/HTML_QuickForm2
*/
/** Interface for Controller action handlers */
@@ -52,11 +52,13 @@
* When an instance of this class is added in addHandler(), action name
* should be set to ID of a page you want to go to, not 'direct'
*
- * @category HTML
- * @package HTML_QuickForm2
- * @author Alexey Borzov <avb@php.net>
- * @author Bertrand Mansion <golgote@mamasam.com>
- * @version Release: @package_version@
+ * @category HTML
+ * @package HTML_QuickForm2
+ * @author Alexey Borzov <avb@php.net>
+ * @author Bertrand Mansion <golgote@mamasam.com>
+ * @license http://opensource.org/licenses/bsd-license.php New BSD License
+ * @version Release: @package_version@
+ * @link http://pear.php.net/package/HTML_QuickForm2
*/
class HTML_QuickForm2_Controller_Action_Direct
implements HTML_QuickForm2_Controller_Action
@@ -6,7 +6,7 @@
*
* LICENSE:
*
- * Copyright (c) 2006-2011, Alexey Borzov <avb@php.net>,
+ * Copyright (c) 2006-2012, Alexey Borzov <avb@php.net>,
* Bertrand Mansion <golgote@mamasam.com>
* All rights reserved.
*
@@ -34,13 +34,13 @@
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
- * @category HTML
- * @package HTML_QuickForm2
- * @author Alexey Borzov <avb@php.net>
- * @author Bertrand Mansion <golgote@mamasam.com>
- * @license http://opensource.org/licenses/bsd-license.php New BSD License
- * @version SVN: $Id$
- * @link http://pear.php.net/package/HTML_QuickForm2
+ * @category HTML
+ * @package HTML_QuickForm2
+ * @author Alexey Borzov <avb@php.net>
+ * @author Bertrand Mansion <golgote@mamasam.com>
+ * @license http://opensource.org/licenses/bsd-license.php New BSD License
+ * @version SVN: $Id$
+ * @link http://pear.php.net/package/HTML_QuickForm2
*/
/** Interface for Controller action handlers */
@@ -55,11 +55,13 @@
* If you want to customize the form display, subclass this class and override
* the renderForm() method, you don't need to change the perform() method.
*
- * @category HTML
- * @package HTML_QuickForm2
- * @author Alexey Borzov <avb@php.net>
- * @author Bertrand Mansion <golgote@mamasam.com>
- * @version Release: @package_version@
+ * @category HTML
+ * @package HTML_QuickForm2
+ * @author Alexey Borzov <avb@php.net>
+ * @author Bertrand Mansion <golgote@mamasam.com>
+ * @license http://opensource.org/licenses/bsd-license.php New BSD License
+ * @version Release: @package_version@
+ * @link http://pear.php.net/package/HTML_QuickForm2
*/
class HTML_QuickForm2_Controller_Action_Display
implements HTML_QuickForm2_Controller_Action
@@ -107,7 +109,7 @@ public function perform(HTML_QuickForm2_Controller_Page $page, $name)
* If you want to customize form appearance or use a different Renderer,
* you should override this method.
*
- * @param HTML_QuickForm2
+ * @param HTML_QuickForm2 $form
*/
protected function renderForm(HTML_QuickForm2 $form)
{
@@ -6,7 +6,7 @@
*
* LICENSE:
*
- * Copyright (c) 2006-2011, Alexey Borzov <avb@php.net>,
+ * Copyright (c) 2006-2012, Alexey Borzov <avb@php.net>,
* Bertrand Mansion <golgote@mamasam.com>
* All rights reserved.
*
@@ -34,13 +34,13 @@
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
- * @category HTML
- * @package HTML_QuickForm2
- * @author Alexey Borzov <avb@php.net>
- * @author Bertrand Mansion <golgote@mamasam.com>
- * @license http://opensource.org/licenses/bsd-license.php New BSD License
- * @version SVN: $Id$
- * @link http://pear.php.net/package/HTML_QuickForm2
+ * @category HTML
+ * @package HTML_QuickForm2
+ * @author Alexey Borzov <avb@php.net>
+ * @author Bertrand Mansion <golgote@mamasam.com>
+ * @license http://opensource.org/licenses/bsd-license.php New BSD License
+ * @version SVN: $Id$
+ * @link http://pear.php.net/package/HTML_QuickForm2
*/
/** Interface for Controller action handlers */
@@ -49,19 +49,22 @@
/**
* This handler performs an HTTP redirect to a specific page
*
- * @category HTML
- * @package HTML_QuickForm2
- * @author Alexey Borzov <avb@php.net>
- * @author Bertrand Mansion <golgote@mamasam.com>
- * @version Release: @package_version@
+ * @category HTML
+ * @package HTML_QuickForm2
+ * @author Alexey Borzov <avb@php.net>
+ * @author Bertrand Mansion <golgote@mamasam.com>
+ * @license http://opensource.org/licenses/bsd-license.php New BSD License
+ * @version Release: @package_version@
+ * @link http://pear.php.net/package/HTML_QuickForm2
*/
class HTML_QuickForm2_Controller_Action_Jump
implements HTML_QuickForm2_Controller_Action
{
/**
* Splits (part of) the URI into path and query components
*
- * @param string String of the form 'foo?bar'
+ * @param string $uri String of the form 'foo?bar'
+ *
* @return array Array of the form array('foo', '?bar)
*/
protected static function splitUri($uri)
@@ -76,7 +79,8 @@ protected static function splitUri($uri)
/**
* Removes the '..' and '.' segments from the path component
*
- * @param string Path component of the URL, possibly with '.' and '..' segments
+ * @param string $path Path component of the URL, possibly with '.' and '..' segments
+ *
* @return string Path component of the URL with '.' and '..' segments removed
*/
protected static function normalizePath($path)
@@ -121,7 +125,8 @@ protected static function normalizePath($path)
* passes the examples provided in section 5 of said RFC. Values from
* $_SERVER array are used for calculation of "current URL"
*
- * @param string Relative URL, probably from form's action attribute
+ * @param string $url Relative URL, probably from form's action attribute
+ *
* @return string Absolute URL
*/
protected static function resolveRelativeURL($url)
@@ -198,7 +203,7 @@ public function perform(HTML_QuickForm2_Controller_Page $page, $name)
* A separate method is mostly needed for creating mocks of this class
* during testing.
*
- * @param string URL to redirect to
+ * @param string $url URL to redirect to
*/
protected function doRedirect($url)
{
@@ -6,7 +6,7 @@
*
* LICENSE:
*
- * Copyright (c) 2006-2011, Alexey Borzov <avb@php.net>,
+ * Copyright (c) 2006-2012, Alexey Borzov <avb@php.net>,
* Bertrand Mansion <golgote@mamasam.com>
* All rights reserved.
*
@@ -34,13 +34,13 @@
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
- * @category HTML
- * @package HTML_QuickForm2
- * @author Alexey Borzov <avb@php.net>
- * @author Bertrand Mansion <golgote@mamasam.com>
- * @license http://opensource.org/licenses/bsd-license.php New BSD License
- * @version SVN: $Id$
- * @link http://pear.php.net/package/HTML_QuickForm2
+ * @category HTML
+ * @package HTML_QuickForm2
+ * @author Alexey Borzov <avb@php.net>
+ * @author Bertrand Mansion <golgote@mamasam.com>
+ * @license http://opensource.org/licenses/bsd-license.php New BSD License
+ * @version SVN: $Id$
+ * @link http://pear.php.net/package/HTML_QuickForm2
*/
/** Interface for Controller action handlers */
@@ -49,11 +49,13 @@
/**
* Action handler for a 'next' button of wizard-type multipage form
*
- * @category HTML
- * @package HTML_QuickForm2
- * @author Alexey Borzov <avb@php.net>
- * @author Bertrand Mansion <golgote@mamasam.com>
- * @version Release: @package_version@
+ * @category HTML
+ * @package HTML_QuickForm2
+ * @author Alexey Borzov <avb@php.net>
+ * @author Bertrand Mansion <golgote@mamasam.com>
+ * @license http://opensource.org/licenses/bsd-license.php New BSD License
+ * @version Release: @package_version@
+ * @link http://pear.php.net/package/HTML_QuickForm2
*/
class HTML_QuickForm2_Controller_Action_Next
implements HTML_QuickForm2_Controller_Action
@@ -72,7 +74,7 @@ public function perform(HTML_QuickForm2_Controller_Page $page, $name)
return $next->handle('jump');
// Consider this a 'finish' button, if there is no explicit one
- } elseif($page->getController()->isWizard()) {
+ } elseif ($page->getController()->isWizard()) {
if ($page->getController()->isValid()) {
return $page->handle('process');
} else {
Oops, something went wrong.

0 comments on commit d7c7ac5

Please sign in to comment.