/vendor/phpunit/phpunit/PHPUnit/Framework/Constraint/StringContains.php
PHP | 122 lines | 31 code | 7 blank | 84 comment | 4 complexity | 38f628640924d5dae6868b6a22e7f1ab MD5 | raw file
Possible License(s): BSD-3-Clause
- <?php
- /**
- * PHPUnit
- *
- * Copyright (c) 2001-2012, Sebastian Bergmann <sebastian@phpunit.de>.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * * Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * * Neither the name of Sebastian Bergmann nor the names of his
- * contributors may be used to endorse or promote products derived
- * from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- *
- * @package PHPUnit
- * @subpackage Framework_Constraint
- * @author Sebastian Bergmann <sebastian@phpunit.de>
- * @author Bernhard Schussek <bschussek@2bepublished.at>
- * @copyright 2001-2012 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 File available since Release 3.0.0
- */
- /**
- * Constraint that asserts that the string it is evaluated for contains
- * a given string.
- *
- * Uses strpos() to find the position of the string in the input, if not found
- * the evaluaton fails.
- *
- * The sub-string is passed in the constructor.
- *
- * @package PHPUnit
- * @subpackage Framework_Constraint
- * @author Sebastian Bergmann <sebastian@phpunit.de>
- * @author Bernhard Schussek <bschussek@2bepublished.at>
- * @copyright 2001-2012 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
- */
- class PHPUnit_Framework_Constraint_StringContains extends PHPUnit_Framework_Constraint
- {
- /**
- * @var string
- */
- protected $string;
- /**
- * @var boolean
- */
- protected $ignoreCase;
- /**
- * @param string $string
- * @param boolean $ignoreCase
- */
- public function __construct($string, $ignoreCase = FALSE)
- {
- $this->string = $string;
- $this->ignoreCase = $ignoreCase;
- }
- /**
- * 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)
- {
- if ($this->ignoreCase) {
- return stripos($other, $this->string) !== FALSE;
- } else {
- return strpos($other, $this->string) !== FALSE;
- }
- }
- /**
- * Returns a string representation of the constraint.
- *
- * @return string
- */
- public function toString()
- {
- if ($this->ignoreCase) {
- $string = strtolower($this->string);
- } else {
- $string = $this->string;
- }
- return sprintf(
- 'contains "%s"',
- $string
- );
- }
- }