[TASK] Streamline phpdoc annotations in EXT:extbase
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Validation / Validator / ValidatorInterface.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Validation\Validator;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * Contract for a validator
19 */
20 interface ValidatorInterface
21 {
22 /**
23 * Checks if the given value is valid according to the validator, and returns
24 * the Error Messages object which occurred.
25 *
26 * @param mixed $value The value that should be validated
27 * @return \TYPO3\CMS\Extbase\Error\Result
28 */
29 public function validate($value);
30
31 /**
32 * Returns the options of this validator which can be specified in the constructor
33 *
34 * @return array
35 */
36 public function getOptions();
37 }