class PHPUnit_Framework_Constraint_IsType

Constraint that asserts that the value it is evaluated for is of a specified type.

The expected value is passed in the constructor.

@package PHPUnit @subpackage Framework_Constraint @author Sebastian Bergmann <sebastian@phpunit.de> @author Bernhard Schussek <bschussek@2bepublished.at> @copyright 2001-2013 Sebastian Bergmann <sebastian@phpunit.de> @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License @link http://www.phpunit.de/ @since Class available since Release 3.0.0

Hierarchy

Expanded class hierarchy of PHPUnit_Framework_Constraint_IsType

File

drupal/core/vendor/phpunit/phpunit/PHPUnit/Framework/Constraint/IsType.php, line 62

View source
class PHPUnit_Framework_Constraint_IsType extends PHPUnit_Framework_Constraint {
  const TYPE_ARRAY = 'array';
  const TYPE_BOOL = 'bool';
  const TYPE_FLOAT = 'float';
  const TYPE_INT = 'int';
  const TYPE_NULL = 'null';
  const TYPE_NUMERIC = 'numeric';
  const TYPE_OBJECT = 'object';
  const TYPE_RESOURCE = 'resource';
  const TYPE_STRING = 'string';
  const TYPE_SCALAR = 'scalar';
  const TYPE_CALLABLE = 'callable';

  /**
   * @var array
   */
  protected $types = array(
    'array' => TRUE,
    'boolean' => TRUE,
    'bool' => TRUE,
    'float' => TRUE,
    'integer' => TRUE,
    'int' => TRUE,
    'null' => TRUE,
    'numeric' => TRUE,
    'object' => TRUE,
    'resource' => TRUE,
    'string' => TRUE,
    'scalar' => TRUE,
    'callable' => TRUE,
  );

  /**
   * @var string
   */
  protected $type;

  /**
   * @param  string $type
   * @throws PHPUnit_Framework_Exception
   */
  public function __construct($type) {
    if (!isset($this->types[$type])) {
      throw new PHPUnit_Framework_Exception(sprintf('Type specified for PHPUnit_Framework_Constraint_IsType <%s> ' . 'is not a valid type.', $type));
    }
    $this->type = $type;
  }

  /**
   * Evaluates the constraint for parameter $other. Returns TRUE if the
   * constraint is met, FALSE otherwise.
   *
   * @param mixed $other Value or object to evaluate.
   * @return bool
   */
  protected function matches($other) {
    switch ($this->type) {
      case 'numeric':
        return is_numeric($other);
      case 'integer':
      case 'int':
        return is_integer($other);
      case 'float':
        return is_float($other);
      case 'string':
        return is_string($other);
      case 'boolean':
      case 'bool':
        return is_bool($other);
      case 'null':
        return is_null($other);
      case 'array':
        return is_array($other);
      case 'object':
        return is_object($other);
      case 'resource':
        return is_resource($other);
      case 'scalar':
        return is_scalar($other);
      case 'callable':
        return is_callable($other);
    }
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    return sprintf('is of type "%s"', $this->type);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PHPUnit_Framework_Constraint::additionalFailureDescription protected function Return additional failure description where needed 1
PHPUnit_Framework_Constraint::count public function Counts the number of constraint elements. 6
PHPUnit_Framework_Constraint::evaluate public function Evaluates the constraint for parameter $other 9
PHPUnit_Framework_Constraint::fail protected function Throws an exception for the given compared value and test description
PHPUnit_Framework_Constraint::failureDescription protected function Returns the description of the failure 15
PHPUnit_Framework_Constraint_IsType::$type protected property
PHPUnit_Framework_Constraint_IsType::$types protected property
PHPUnit_Framework_Constraint_IsType::matches protected function Evaluates the constraint for parameter $other. Returns TRUE if the constraint is met, FALSE otherwise. Overrides PHPUnit_Framework_Constraint::matches
PHPUnit_Framework_Constraint_IsType::toString public function Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString
PHPUnit_Framework_Constraint_IsType::TYPE_ARRAY constant
PHPUnit_Framework_Constraint_IsType::TYPE_BOOL constant
PHPUnit_Framework_Constraint_IsType::TYPE_CALLABLE constant
PHPUnit_Framework_Constraint_IsType::TYPE_FLOAT constant
PHPUnit_Framework_Constraint_IsType::TYPE_INT constant
PHPUnit_Framework_Constraint_IsType::TYPE_NULL constant
PHPUnit_Framework_Constraint_IsType::TYPE_NUMERIC constant
PHPUnit_Framework_Constraint_IsType::TYPE_OBJECT constant
PHPUnit_Framework_Constraint_IsType::TYPE_RESOURCE constant
PHPUnit_Framework_Constraint_IsType::TYPE_SCALAR constant
PHPUnit_Framework_Constraint_IsType::TYPE_STRING constant
PHPUnit_Framework_Constraint_IsType::__construct public function