design-patterns/Behavioral/Visitor/FormField.php at master · vria/design-patterns · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<?php

namespace DesignPatterns\Behavioral\Visitor;

/**
 * Basic class for a form field.
 * It defines common properties and methods to all form fields.
 * On top of that there is an abstract @see FormField::accept method that takes a visitor as an argument.
 * Through this method the form fields can be extended by introducing a new concrete visitor.
 *
 * It corresponds to `Element` in the Strategy pattern.
 *
 * @author Vlad Riabchenko <contact@vria.eu>
 */
abstract class FormField
{
    /**
     * Model value for PHP processing.
     *
     * @var mixed
     */
    private $value;

    /**
     * View value for HTML page.
     *
     * @var mixed
     */
    private $viewValue;

    /**
     * Required flag.
     *
     * @var boolean
     */
    private $required = false;

    /**
     * Error message.
     *
     * @var string
     */
    private $error;

    /**
     * Accept a visitor.
     * A concrete form field will request the visitor to perform its operation.
     * The name of requested operation depends on the concrete form field class.
     *
     * @param VisitorInterface $visitor
     */
    public abstract function accept(VisitorInterface $visitor);

    /**
     * Get view value.
     *
     * @return mixed
     */
    public function getViewValue()
    {
        return $this->viewValue;
    }

    /**
     * Set view value.
     *
     * @param mixed $viewValue
     */
    public function setViewValue($viewValue)
    {
        $this->viewValue = $viewValue;
    }

    /**
     * Get value.
     *
     * @return mixed|null
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * Set value.
     *
     * @param mixed $value
     */
    public function setValue($value)
    {
        $this->value = $value;
    }

    /**
     * Check if the field is required.
     *
     * @return boolean
     */
    public function isRequired()
    {
        return $this->required;
    }

    /**
     * Set required flag.
     *
     * @param boolean $required
     */
    public function setRequired($required)
    {
        $this->required = $required;
    }

    /**
     * Get error message.
     *
     * @return string|null
     */
    public function getError()
    {
        return $this->error;
    }

    /**
     * Set error message.
     *
     * @param string $error
     */
    public function setError($error)
    {
        $this->error = $error;
    }
}