[CLEANUP] Correct phpdoc in extbase's validator classes 43/36143/3
authorFrederic Gaus <gaus@flagbit.de>
Tue, 20 Jan 2015 16:46:58 +0000 (17:46 +0100)
committerWouter Wolters <typo3@wouterwolters.nl>
Thu, 22 Jan 2015 20:57:07 +0000 (21:57 +0100)
Set the correct @return in phpdoc of extbase validators.
Further correct some typos and remove disabled code including a
not needed comment in ValidatorInterface

Change-Id: I0966176eb4079f6c6fcd6f182e5c608acac0a01c
Resolves: #57453
Releases: master, 6.2
Reviewed-on: http://review.typo3.org/36143
Reviewed-by: Oliver Klee <typo3-coding@oliverklee.de>
Reviewed-by: Markus Klein <klein.t3@reelworx.at>
Tested-by: Markus Klein <klein.t3@reelworx.at>
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
typo3/sysext/extbase/Classes/Validation/Validator/AbstractValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/BooleanValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/DateTimeValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/NotEmptyValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/NumberValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/ValidatorInterface.php

index af2d9a9..fa0c233 100644 (file)
@@ -87,7 +87,7 @@ abstract class AbstractValidator implements ValidatorInterface {
 
        /**
         * Checks if the given value is valid according to the validator, and returns
-        * the Error Messages object which occurred.
+        * the error messages object which occurred.
         *
         * @param mixed $value The value that should be validated
         * @return \TYPO3\CMS\Extbase\Error\Result
@@ -103,7 +103,7 @@ abstract class AbstractValidator implements ValidatorInterface {
 
        /**
         * Check if $value is valid. If it is not valid, needs to add an error
-        * to Result.
+        * to result.
         *
         * @param mixed $value
         * @return void
index 52695c4..abbf233 100644 (file)
@@ -33,15 +33,14 @@ class BooleanValidator extends AbstractValidator {
 
 
        /**
-        * Returns TRUE if the given property value is a boolean matching the expectation.
-        *
-        * If at least one error occurred, the result is FALSE.
+        * Check if $value matches the expectation given to the validator.
+        * If it does not match, the function adds an error to the result.
         *
         * Also testing for '1' (true), '0' and '' (false) because casting varies between
         * tests and actual usage. This makes the validator loose but still keeping functionality.
         *
         * @param mixed $value The value that should be validated
-        * @return bool TRUE if the value is within the range, otherwise FALSE
+        * @return void
         */
        public function isValid($value) {
                // see comment above, check if expectation is NULL, then nothing to do!
index 0307fe3..b8b67ab 100644 (file)
@@ -22,12 +22,11 @@ namespace TYPO3\CMS\Extbase\Validation\Validator;
 class DateTimeValidator extends AbstractValidator {
 
        /**
-        * Checks if the given value is a valid DateTime object.
-        *
-        * If at least one error occurred, the result is FALSE.
+        * Checks if the given value is a valid DateTime object. If this is not
+        * the case, the function adds an error.
         *
         * @param mixed $value The value that should be validated
-        * @return bool TRUE if the value is valid, FALSE if an error occurred
+        * @return void
         */
        public function isValid($value) {
                $this->result->clear();
index 1168f76..1f968b6 100644 (file)
@@ -32,10 +32,8 @@ class NotEmptyValidator extends AbstractValidator {
        /**
         * Checks if the given property ($propertyValue) is not empty (NULL, empty string, empty array or empty object).
         *
-        * If at least one error occurred, the result is FALSE.
-        *
         * @param mixed $value The value that should be validated
-        * @return bool TRUE if the value is valid, FALSE if an error occurred
+        * @return void
         */
        public function isValid($value) {
                if ($value === NULL) {
index ca3107d..3398676 100644 (file)
@@ -24,10 +24,8 @@ class NumberValidator extends AbstractValidator {
        /**
         * Checks if the given value is a valid number.
         *
-        * If at least one error occurred, the result is FALSE.
-        *
         * @param mixed $value The value that should be validated
-        * @return bool TRUE if the value is valid, FALSE if an error occurred
+        * @return void
         */
        public function isValid($value) {
                if (!is_numeric($value)) {
index edaba0f..2440dd6 100644 (file)
@@ -21,14 +21,6 @@ namespace TYPO3\CMS\Extbase\Validation\Validator;
  */
 interface ValidatorInterface {
 
-       /**
-        * Constructs the validator and sets validation options
-        *
-        * @param array $options The validation options
-        * @api
-        */
-       //public function __construct(array $options = array());
-
        /**
         * Checks if the given value is valid according to the validator, and returns
         * the Error Messages object which occurred.