Your IP : 216.73.216.81
<?php // phpcs:disable SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing
namespace Laminas\Captcha;
use Laminas\Validator\AbstractValidator;
use Traversable;
use function in_array;
use function is_array;
use function method_exists;
use function property_exists;
use function strtolower;
use function ucfirst;
/**
* Base class for Captcha adapters
*
* Provides some utility functionality to build on
*/
abstract class AbstractAdapter extends AbstractValidator implements AdapterInterface
{
/**
* Captcha name
*
* Useful to generate/check form fields
*
* @var string
*/
protected $name;
/**
* Captcha options
*
* @var array<string, mixed>
*/
protected $options = [];
/**
* Options to skip when processing options
*
* @var list<string>
*/
protected $skipOptions = [
'options',
'config',
];
/**
* Get name
*
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Set name
*
* @param string $name
* @return AbstractAdapter Provides a fluent interface
*/
public function setName($name)
{
$this->name = $name;
return $this;
}
/**
* Set single option for the object
*
* @param string $key
* @return $this Provides a fluent interface
*/
public function setOption($key, mixed $value)
{
if (in_array(strtolower($key), $this->skipOptions)) {
return $this;
}
$method = 'set' . ucfirst($key);
if (method_exists($this, $method)) {
// Setter exists; use it
$this->$method($value);
$this->options[$key] = $value;
} elseif (property_exists($this, $key)) {
// Assume it's metadata
$this->$key = $value;
$this->options[$key] = $value;
}
return $this;
}
/** @inheritDoc */
public function setOptions($options = [])
{
if (! is_array($options) && ! $options instanceof Traversable) {
throw new Exception\InvalidArgumentException(__METHOD__ . ' expects an array or Traversable');
}
foreach ($options as $key => $value) {
$this->setOption($key, $value);
}
return $this;
}
/** @inheritDoc */
public function getOptions()
{
return $this->options;
}
/**
* Get helper name used to render captcha
*
* By default, return empty string, indicating no helper needed.
*
* @return string
*/
public function getHelperName()
{
return '';
}
}