render($element);
}
/**
* 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.
*
* @throws Exception\DomainException
*/
protected function renderCaptchaInputs(ElementInterface $element): string
{
$name = $element->getName();
if ($name === null || $name === '') {
throw new Exception\DomainException(sprintf(
'%s requires that the element has an assigned name; none discovered',
__METHOD__
));
}
assert($element instanceof Captcha);
$captcha = $element->getCaptcha();
if ($captcha === null) {
throw new Exception\DomainException(sprintf(
'%s requires that the element has a "captcha" attribute implementing Laminas\Captcha\AdapterInterface; '
. 'none found',
__METHOD__
));
}
$attributes = $element->getAttributes();
$hidden = $this->renderCaptchaHidden($captcha, $attributes);
$input = $this->renderCaptchaInput($captcha, $attributes);
return $hidden . $input;
}
/**
* Render the hidden input with the captcha identifier
*/
protected function renderCaptchaHidden(CaptchaAdapter $captcha, array $attributes): string
{
$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();
return sprintf(
'createAttributesString($attributes),
$closingBracket
);
}
/**
* Render the input for capturing the captcha value from the client
*/
protected function renderCaptchaInput(CaptchaAdapter $captcha, array $attributes): string
{
$attributes['type'] = 'text';
$attributes['name'] .= '[input]';
if (array_key_exists('value', $attributes)) {
unset($attributes['value']);
}
$closingBracket = $this->getInlineClosingBracket();
return sprintf(
'createAttributesString($attributes),
$closingBracket
);
}
/**
* Set value for captchaPosition
*
* @throws Exception\InvalidArgumentException
* @return $this
*/
public function setCaptchaPosition(string $captchaPosition)
{
$captchaPosition = strtolower($captchaPosition);
if (! in_array($captchaPosition, [self::CAPTCHA_APPEND, self::CAPTCHA_PREPEND])) {
throw new Exception\InvalidArgumentException(sprintf(
'%s expects either %s::CAPTCHA_APPEND or %s::CAPTCHA_PREPEND; received "%s"',
__METHOD__,
self::class,
self::class,
$captchaPosition
));
}
$this->captchaPosition = $captchaPosition;
return $this;
}
/**
* Get position of captcha
*/
public function getCaptchaPosition(): string
{
return $this->captchaPosition;
}
/**
* Set separator string for captcha and inputs
*
* @return $this
*/
public function setSeparator(string $separator)
{
$this->separator = $separator;
return $this;
}
/**
* Get separator for captcha and inputs
*/
public function getSeparator(): string
{
return $this->separator;
}
}