This repository has been archived by the owner on Jan 8, 2020. It is now read-only.
/
AbstractWord.php
212 lines (187 loc) · 5.72 KB
/
AbstractWord.php
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @package Zend_Form
*/
namespace Zend\Form\View\Helper\Captcha;
use Zend\Captcha\AdapterInterface as CaptchaAdapter;
use Zend\Form\ElementInterface;
use Zend\Form\Exception;
use Zend\Form\View\Helper\FormInput;
/**
* @category Zend
* @package Zend_Form
* @subpackage View
*/
abstract class AbstractWord extends FormInput
{
const CAPTCHA_APPEND = 'append';
const CAPTCHA_PREPEND = 'prepend';
/**
* @var FormInput
*/
protected $inputHelper;
/**
* @var string
*/
protected $captchaPosition = self::CAPTCHA_APPEND;
/**
* @var string
*/
protected $separator = '';
/**
* Set value for captchaPosition
*
* @param mixed $captchaPosition
* @throws Exception\InvalidArgumentException
* @return self
*/
public function setCaptchaPosition($captchaPosition)
{
$captchaPosition = strtolower($captchaPosition);
if (!in_array($captchaPosition, array(self::CAPTCHA_APPEND, self::CAPTCHA_PREPEND))) {
throw new Exception\InvalidArgumentException(sprintf(
'%s expects either %s::CAPTCHA_APPEND or %s::CAPTCHA_PREPEND; received "%s"',
__METHOD__,
__CLASS__,
__CLASS__,
(string) $captchaPosition
));
}
$this->captchaPosition = $captchaPosition;
return $this;
}
/**
* Get position of captcha
*
* @return string
*/
public function getCaptchaPosition()
{
return $this->captchaPosition;
}
/**
* Set separator string for captcha and inputs
*
* @param string $separator
* @return AbstractWord
*/
public function setSeparator($separator)
{
$this->separator = (string) $separator;
return $this;
}
/**
* Get separator for captcha and inputs
*
* @return string
*/
public function getSeparator()
{
return $this->separator;
}
/**
* Render captcha form elements for the given element
*
* Creates and returns:
* - Hidden input with captcha identifier (name[id])
* - Text input for entering captcha value (name[input])
*
* More specific renderers will consume this and render it.
*
* @param ElementInterface $element
* @throws Exception\DomainException
* @return string
*/
protected function renderCaptchaInputs(ElementInterface $element)
{
$name = $element->getName();
if ($name === null || $name === '') {
throw new Exception\DomainException(sprintf(
'%s requires that the element has an assigned name; none discovered',
__METHOD__
));
}
$attributes = $element->getAttributes();
$captcha = $element->getCaptcha();
if ($captcha === null || !$captcha instanceof CaptchaAdapter) {
throw new Exception\DomainException(sprintf(
'%s requires that the element has a "captcha" attribute implementing Zend\Captcha\AdapterInterface; none found',
__METHOD__
));
}
$hidden = $this->renderCaptchaHidden($captcha, $attributes);
$input = $this->renderCaptchaInput($captcha, $attributes);
return $hidden . $input;
}
/**
* Invoke helper as functor
*
* Proxies to {@link render()}.
*
* @param ElementInterface $element
* @return string
*/
public function __invoke(ElementInterface $element = null)
{
if (!$element) {
return $this;
}
return $this->render($element);
}
/**
* Render the hidden input with the captcha identifier
*
* @param CaptchaAdapter $captcha
* @param array $attributes
* @return string
*/
protected function renderCaptchaHidden(CaptchaAdapter $captcha, array $attributes)
{
$attributes['type'] = 'hidden';
$attributes['name'] .= '[id]';
if (isset($attributes['id'])) {
$attributes['id'] .= '-hidden';
}
if (method_exists($captcha, 'getId')) {
$attributes['value'] = $captcha->getId();
} elseif (array_key_exists('value', $attributes)) {
if (is_array($attributes['value']) && array_key_exists('id', $attributes['value'])) {
$attributes['value'] = $attributes['value']['id'];
}
}
$closingBracket = $this->getInlineClosingBracket();
$hidden = sprintf(
'<input %s%s',
$this->createAttributesString($attributes),
$closingBracket
);
return $hidden;
}
/**
* Render the input for capturing the captcha value from the client
*
* @param CaptchaAdapter $captcha
* @param array $attributes
* @return string
*/
protected function renderCaptchaInput(CaptchaAdapter $captcha, array $attributes)
{
$attributes['type'] = 'text';
$attributes['name'] .= '[input]';
if (array_key_exists('value', $attributes)) {
unset($attributes['value']);
}
$closingBracket = $this->getInlineClosingBracket();
$input = sprintf(
'<input %s%s',
$this->createAttributesString($attributes),
$closingBracket
);
return $input;
}
}