tests/PHPUnit/PHPUnit/Framework/Constraint/PCREMatch.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2011, Sebastian Bergmann <sebastian@phpunit.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @package    PHPUnit
  38  * @subpackage Framework_Constraint
  39  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  40  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42  * @link       http://www.phpunit.de/
  43  * @since      File available since Release 3.0.0
  44  */
  45
  46 /**
  47  * Constraint that asserts that the string it is evaluated for matches
  48  * a regular expression.
  49  *
  50  * Checks a given value using the Perl Compatible Regular Expression extension
  51  * in PHP. The pattern is matched by executing preg_match().
  52  *
  53  * The pattern string passed in the constructor.
  54  *
  55  * @package    PHPUnit
  56  * @subpackage Framework_Constraint
  57  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  58  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  59  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  60  * @version    Release: 3.5.13
  61  * @link       http://www.phpunit.de/
  62  * @since      Class available since Release 3.0.0
  63  */
  64 class PHPUnit_Framework_Constraint_PCREMatch extends PHPUnit_Framework_Constraint
  65 {
  66     /**
  67      * @var string
  68      */
  69     protected $pattern;
  70
  71     /**
  72      * @param string $pattern
  73      */
  74     public function __construct($pattern)
  75     {
  76         $this->pattern = $pattern;
  77     }
  78
  79     /**
  80      * Evaluates the constraint for parameter $other. Returns TRUE if the
  81      * constraint is met, FALSE otherwise.
  82      *
  83      * @param mixed $other Value or object to evaluate.
  84      * @return bool
  85      */
  86     public function evaluate($other)
  87     {
  88         return preg_match($this->pattern, $other) > 0;
  89     }
  90
  91     /**
  92      * Returns a string representation of the constraint.
  93      *
  94      * @return string
  95      */
  96     public function toString()
  97     {
  98         return sprintf(
  99           'matches PCRE pattern "%s"',
 100
 101           $this->pattern
 102         );
 103     }
 104 }