Attribute.php in Zircon Profile 8

File

vendor/phpunit/phpunit/src/Framework/Constraint/Attribute.php

<?php

/*
 * This file is part of PHPUnit.
 *
 * (c) Sebastian Bergmann <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * @since Class available since Release 3.1.0
 */
class PHPUnit_Framework_Constraint_Attribute extends PHPUnit_Framework_Constraint_Composite {

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

  /**
   * @param PHPUnit_Framework_Constraint $constraint
   * @param string                       $attributeName
   */
  public function __construct(PHPUnit_Framework_Constraint $constraint, $attributeName) {
    parent::__construct($constraint);
    $this->attributeName = $attributeName;
  }

  /**
   * Evaluates the constraint for parameter $other
   *
   * If $returnResult is set to false (the default), an exception is thrown
   * in case of a failure. null is returned otherwise.
   *
   * If $returnResult is true, the result of the evaluation is returned as
   * a boolean value instead: true in case of success, false in case of a
   * failure.
   *
   * @param  mixed                                        $other        Value or object to evaluate.
   * @param  string                                       $description  Additional information about the test
   * @param  bool                                         $returnResult Whether to return a result or throw an exception
   * @return mixed
   * @throws PHPUnit_Framework_ExpectationFailedException
   */
  public function evaluate($other, $description = '', $returnResult = false) {
    return parent::evaluate(PHPUnit_Framework_Assert::readAttribute($other, $this->attributeName), $description, $returnResult);
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    return 'attribute "' . $this->attributeName . '" ' . $this->innerConstraint
      ->toString();
  }

  /**
   * Returns the description of the failure
   *
   * The beginning of failure messages is "Failed asserting that" in most
   * cases. This method should return the second part of that sentence.
   *
   * @param  mixed  $other Evaluated value or object.
   * @return string
   */
  protected function failureDescription($other) {
    return $this
      ->toString();
  }

}

Classes

Name	Description
PHPUnit_Framework_Constraint_Attribute	@since Class available since Release 3.1.0