5 * Copyright (c) 2002-2011, Sebastian Bergmann <sebastian@phpunit.de>.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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.
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.
38 * @subpackage Util_TestDox
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 2.3.0
47 * Prettifies class and method names for use in TestDox documentation.
50 * @subpackage Util_TestDox
51 * @author Sebastian Bergmann <sebastian@phpunit.de>
52 * @copyright 2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
53 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
54 * @version Release: 3.5.14
55 * @link http://www.phpunit.de/
56 * @since Class available since Release 2.1.0
58 class PHPUnit_Util_TestDox_NamePrettifier
63 protected $prefix = 'Test';
68 protected $suffix = 'Test';
73 protected $strings = array();
76 * Prettifies the name of a test class.
81 public function prettifyTestClass($name)
85 if ($this->suffix !== NULL &&
86 $this->suffix == substr($name, -1 * strlen($this->suffix))) {
87 $title = substr($title, 0, strripos($title, $this->suffix));
90 if ($this->prefix !== NULL &&
91 $this->prefix == substr($name, 0, strlen($this->prefix))) {
92 $title = substr($title, strlen($this->prefix));
99 * Prettifies the name of a test method.
101 * @param string $name
104 public function prettifyTestMethod($name)
108 if (!is_string($name) || strlen($name) == 0) {
112 $string = preg_replace('#\d+$#', '', $name, -1, $count);
114 if (in_array($string, $this->strings)) {
116 } else if ($count == 0) {
117 $this->strings[] = $string;
120 if (strpos($name, '_') !== FALSE) {
121 return str_replace('_', ' ', $name);
124 $max = strlen($name);
126 if (substr($name, 0, 4) == 'test') {
130 $name[0] = strtoupper($name[0]);
135 for ($i = $offset; $i < $max; $i++) {
137 ord($name[$i]) >= 65 &&
138 ord($name[$i]) <= 90) {
139 $buffer .= ' ' . strtolower($name[$i]);
141 $isNumeric = is_numeric($name[$i]);
143 if (!$wasNumeric && $isNumeric) {
148 if ($wasNumeric && !$isNumeric) {
152 $buffer .= $name[$i];
160 * Sets the prefix of test names.
162 * @param string $prefix
164 public function setPrefix($prefix)
166 $this->prefix = $prefix;
170 * Sets the suffix of test names.
172 * @param string $prefix
174 public function setSuffix($suffix)
176 $this->suffix = $suffix;