DeprecatedFeature.php (3476B)
1 <?php 2 /** 3 * PHPUnit 4 * 5 * Copyright (c) 2001-2014, 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 39 * @author Ralph Schindler <ralph.schindler@zend.com> 40 * @author Sebastian Bergmann <sebastian@phpunit.de> 41 * @copyright 2001-2014 Sebastian Bergmann <sebastian@phpunit.de> 42 * @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License 43 * @link http://www.phpunit.de/ 44 * @since File available since Release 3.5.7 45 */ 46 47 /** 48 * Class to hold the information about a deprecated feature that was used 49 * 50 * @package PHPUnit 51 * @subpackage Framework 52 * @author Ralph Schindler <ralph.schindler@zend.com> 53 * @author Sebastian Bergmann <sebastian@phpunit.de> 54 * @copyright 2001-2014 Sebastian Bergmann <sebastian@phpunit.de> 55 * @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License 56 * @link http://www.phpunit.de/ 57 * @since Interface available since Release 3.5.7 58 */ 59 class PHPUnit_Util_DeprecatedFeature 60 { 61 /** 62 * @var array 63 */ 64 protected $traceInfo = array(); 65 66 /** 67 * @var string 68 */ 69 protected $message = NULL; 70 71 /** 72 * @param string $message 73 * @param array $traceInfo 74 */ 75 public function __construct($message, array $traceInfo = array()) 76 { 77 $this->message = $message; 78 $this->traceInfo = $traceInfo; 79 } 80 81 /** 82 * Build a string representation of the deprecated feature that was raised 83 * 84 * @return string 85 */ 86 public function __toString() 87 { 88 $string = ''; 89 90 if (isset($this->traceInfo['file'])) { 91 $string .= $this->traceInfo['file']; 92 93 if (isset($this->traceInfo['line'])) { 94 $string .= ':' . $this->traceInfo['line'] . ' - '; 95 } 96 } 97 98 $string .= $this->message; 99 100 return $string; 101 } 102 }