1<?php
2/**
3 * Zend Framework (http://framework.zend.com/)
4 *
5 * @link      http://github.com/zendframework/zf2 for the canonical source repository
6 * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
7 * @license   http://framework.zend.com/license/new-bsd New BSD License
8 */
9
10namespace Zend\InputFilter;
11
12use Zend\Filter\FilterChain;
13use Zend\Validator\ValidatorChain;
14
15interface InputInterface
16{
17    /**
18     * @deprecated 2.4.8 Add Zend\Validator\NotEmpty validator to the ValidatorChain and set this to `true`.
19     *
20     * @param bool $allowEmpty
21     * @return self
22     */
23    public function setAllowEmpty($allowEmpty);
24
25    /**
26     * @param bool $breakOnFailure
27     * @return self
28     */
29    public function setBreakOnFailure($breakOnFailure);
30
31    /**
32     * @param string|null $errorMessage
33     * @return self
34     */
35    public function setErrorMessage($errorMessage);
36
37    /**
38     * @param FilterChain $filterChain
39     * @return self
40     */
41    public function setFilterChain(FilterChain $filterChain);
42
43    /**
44     * @param string $name
45     * @return self
46     */
47    public function setName($name);
48
49    /**
50     * @param bool $required
51     * @return self
52     */
53    public function setRequired($required);
54
55    /**
56     * @param ValidatorChain $validatorChain
57     * @return self
58     */
59    public function setValidatorChain(ValidatorChain $validatorChain);
60
61    /**
62     * @param mixed $value
63     * @return self
64     */
65    public function setValue($value);
66
67    /**
68     * @param InputInterface $input
69     * @return self
70     */
71    public function merge(InputInterface $input);
72
73    /**
74     * @deprecated 2.4.8 Add Zend\Validator\NotEmpty validator to the ValidatorChain.
75     *
76     * @return bool
77     */
78    public function allowEmpty();
79
80    /**
81     * @return bool
82     */
83    public function breakOnFailure();
84
85    /**
86     * @return string|null
87     */
88    public function getErrorMessage();
89
90    /**
91     * @return FilterChain
92     */
93    public function getFilterChain();
94
95    /**
96     * @return string
97     */
98    public function getName();
99
100    /**
101     * @return mixed
102     */
103    public function getRawValue();
104
105    /**
106     * @return bool
107     */
108    public function isRequired();
109
110    /**
111     * @return ValidatorChain
112     */
113    public function getValidatorChain();
114
115    /**
116     * @return mixed
117     */
118    public function getValue();
119
120    /**
121     * @return bool
122     */
123    public function isValid();
124
125    /**
126     * @return string[]
127     */
128    public function getMessages();
129}
130