interface/modules/zend_modules/library/Zend/Captcha/AbstractAdapter.php

   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
  10 namespace Zend\Captcha;
  11
  12 use Traversable;
  13 use Zend\Validator\AbstractValidator;
  14
  15 /**
  16  * Base class for Captcha adapters
  17  *
  18  * Provides some utility functionality to build on
  19  */
  20 abstract class AbstractAdapter extends AbstractValidator implements AdapterInterface
  21 {
  22     /**
  23      * Captcha name
  24      *
  25      * Useful to generate/check form fields
  26      *
  27      * @var string
  28      */
  29     protected $name;
  30
  31     /**
  32      * Captcha options
  33      *
  34      * @var array
  35      */
  36     protected $options = array();
  37
  38     /**
  39      * Options to skip when processing options
  40      * @var array
  41      */
  42     protected $skipOptions = array(
  43         'options',
  44         'config',
  45     );
  46
  47     /**
  48      * Get name
  49      *
  50      * @return string
  51      */
  52     public function getName()
  53     {
  54         return $this->name;
  55     }
  56
  57     /**
  58      * Set name
  59      *
  60      * @param string $name
  61      * @return AbstractAdapter
  62      */
  63     public function setName($name)
  64     {
  65         $this->name = $name;
  66         return $this;
  67     }
  68
  69     /**
  70      * Set single option for the object
  71      *
  72      * @param  string $key
  73      * @param  string $value
  74      * @return AbstractAdapter
  75      */
  76     public function setOption($key, $value)
  77     {
  78         if (in_array(strtolower($key), $this->skipOptions)) {
  79             return $this;
  80         }
  81
  82         $method = 'set' . ucfirst($key);
  83         if (method_exists($this, $method)) {
  84             // Setter exists; use it
  85             $this->$method($value);
  86             $this->options[$key] = $value;
  87         } elseif (property_exists($this, $key)) {
  88             // Assume it's metadata
  89             $this->$key = $value;
  90             $this->options[$key] = $value;
  91         }
  92         return $this;
  93     }
  94
  95     /**
  96      * Set object state from options array
  97      *
  98      * @param  array|Traversable $options
  99      * @throws Exception\InvalidArgumentException
 100      * @return AbstractAdapter
 101      */
 102     public function setOptions($options = array())
 103     {
 104         if (!is_array($options) && !$options instanceof Traversable) {
 105             throw new Exception\InvalidArgumentException(__METHOD__ . ' expects an array or Traversable');
 106         }
 107
 108         foreach ($options as $key => $value) {
 109             $this->setOption($key, $value);
 110         }
 111         return $this;
 112     }
 113
 114     /**
 115      * Retrieve options representing object state
 116      *
 117      * @return array
 118      */
 119     public function getOptions()
 120     {
 121         return $this->options;
 122     }
 123
 124     /**
 125      * Get helper name used to render captcha
 126      *
 127      * By default, return empty string, indicating no helper needed.
 128      *
 129      * @return string
 130      */
 131     public function getHelperName()
 132     {
 133         return '';
 134     }
 135 }