interface/modules/zend_modules/library/Zend/Validator/IsInstanceOf.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-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9 namespace Zend\Validator;
  10
  11 use Traversable;
  12
  13 class IsInstanceOf extends AbstractValidator
  14 {
  15     const NOT_INSTANCE_OF = 'notInstanceOf';
  16
  17     /**
  18      * Validation failure message template definitions
  19      *
  20      * @var array
  21      */
  22     protected $messageTemplates = array(
  23         self::NOT_INSTANCE_OF => "The input is not an instance of '%className%'",
  24     );
  25
  26     /**
  27      * Additional variables available for validation failure messages
  28      *
  29      * @var array
  30      */
  31     protected $messageVariables = array(
  32         'className' => 'className'
  33     );
  34
  35     /**
  36      * Class name
  37      *
  38      * @var string
  39      */
  40     protected $className;
  41
  42     /**
  43      * Sets validator options
  44      *
  45      * @param  array|Traversable $options
  46      * @throws Exception\InvalidArgumentException
  47      */
  48     public function __construct($options = null)
  49     {
  50         if ($options instanceof Traversable) {
  51             $options = iterator_to_array($options);
  52         }
  53
  54         // If argument is not an array, consider first argument as class name
  55         if (!is_array($options)) {
  56             $options = func_get_args();
  57
  58             $tmpOptions = array();
  59             $tmpOptions['className'] = array_shift($options);
  60
  61             $options = $tmpOptions;
  62         }
  63
  64         if (!array_key_exists('className', $options)) {
  65             throw new Exception\InvalidArgumentException('Missing option "className"');
  66         }
  67
  68         parent::__construct($options);
  69     }
  70
  71     /**
  72      * Get class name
  73      *
  74      * @return string
  75      */
  76     public function getClassName()
  77     {
  78         return $this->className;
  79     }
  80
  81     /**
  82      * Set class name
  83      *
  84      * @param  string $className
  85      * @return self
  86      */
  87     public function setClassName($className)
  88     {
  89         $this->className = $className;
  90         return $this;
  91     }
  92
  93     /**
  94      * Returns true if $value is instance of $this->className
  95      *
  96      * @param  mixed $value
  97      * @return bool
  98      */
  99     public function isValid($value)
 100     {
 101         if ($value instanceof $this->className) {
 102             return true;
 103         }
 104         $this->error(self::NOT_INSTANCE_OF);
 105         return false;
 106     }
 107 }