Skip to content
This repository
tree: 761a27a483
Fetching contributors…

Cannot retrieve contributors at this time

file 980 lines (858 sloc) 26.704 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
<?php
/**
* PHPUnit
*
* Copyright (c) 2002-2008, Sebastian Bergmann <sb@sebastian-bergmann.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.
*
* @category Testing
* @package PHPUnit
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
* @copyright 2002-2008 Sebastian Bergmann <sb@sebastian-bergmann.de>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version SVN: $Id$
* @link http://www.phpunit.de/
* @since File available since Release 2.0.0
*/

require_once 'PHPUnit/Framework.php';
require_once 'PHPUnit/Framework/MockObject/Mock.php';
require_once 'PHPUnit/Framework/MockObject/Matcher/InvokedAtLeastOnce.php';
require_once 'PHPUnit/Framework/MockObject/Matcher/InvokedAtIndex.php';
require_once 'PHPUnit/Framework/MockObject/Matcher/InvokedCount.php';
require_once 'PHPUnit/Framework/MockObject/Stub.php';
require_once 'PHPUnit/Runner/BaseTestRunner.php';
require_once 'PHPUnit/Util/Filter.php';

PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');

if (!class_exists('PHPUnit_Framework_TestCase', FALSE)) {

/**
* A TestCase defines the fixture to run multiple tests.
*
* To define a TestCase
*
* 1) Implement a subclass of PHPUnit_Framework_TestCase.
* 2) Define instance variables that store the state of the fixture.
* 3) Initialize the fixture state by overriding setUp().
* 4) Clean-up after a test by overriding tearDown().
*
* Each test runs in its own fixture so there can be no side effects
* among test runs.
*
* Here is an example:
*
* <code>
* <?php
* require_once 'PHPUnit/Framework/TestCase.php';
*
* class MathTest extends PHPUnit_Framework_TestCase
* {
* public $value1;
* public $value2;
*
* protected function setUp()
* {
* $this->value1 = 2;
* $this->value2 = 3;
* }
* }
* ?>
* </code>
*
* For each test implement a method which interacts with the fixture.
* Verify the expected results with assertions specified by calling
* assert with a boolean.
*
* <code>
* <?php
* public function testPass()
* {
* $this->assertTrue($this->value1 + $this->value2 == 5);
* }
* ?>
* </code>
*
* @category Testing
* @package PHPUnit
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
* @copyright 2002-2008 Sebastian Bergmann <sb@sebastian-bergmann.de>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: @package_version@
* @link http://www.phpunit.de/
* @since Class available since Release 2.0.0
* @abstract
*/
abstract class PHPUnit_Framework_TestCase extends PHPUnit_Framework_Assert implements PHPUnit_Framework_Test, PHPUnit_Framework_SelfDescribing
{
    /**
* Enable or disable the backup and restoration of the $GLOBALS array.
* Overwrite this attribute in a child class of TestCase.
* Setting this attribute in setUp() has no effect!
*
* @var boolean
*/
    protected $backupGlobals = NULL;

    /**
* Enable or disable the cleanup of the $GLOBALS array.
* Overwrite this attribute in a child class of TestCase.
* Setting this attribute in setUp() has no effect!
*
* @var boolean
*/
    protected $cleanupGlobals = NULL;

    /**
* @var array
*/
    protected $data = array();

    /**
* @var string
*/
    protected $dataName = '';

    /**
* The name of the expected Exception.
*
* @var mixed
*/
    protected $expectedException = NULL;

    /**
* The message of the expected Exception.
*
* @var string
*/
    protected $expectedExceptionMessage = '';

    /**
* The code of the expected Exception.
*
* @var integer
*/
    protected $expectedExceptionCode;

    /**
* Fixture that is shared between the tests of a test suite.
*
* @var mixed
*/
    protected $sharedFixture;

    /**
* The name of the test case.
*
* @var string
*/
    protected $name = NULL;

    /**
* @var string
*/
    protected $exceptionMessage = NULL;

    /**
* @var integer
*/
    protected $exceptionCode = 0;

    /**
* @var Array
*/
    protected $iniSettings = array();

    /**
* @var Array
*/
    protected $locale = array();

    /**
* @var Array
*/
    protected $mockObjects = array();

    /**
* @var integer
*/
    protected $status;

    /**
* @var string
*/
    protected $statusMessage = '';

    /**
* @var integer
*/
    protected $numAssertions = 0;

    /**
* Constructs a test case with the given name.
*
* @param string $name
* @param array $data
* @param string $dataName
*/
    public function __construct($name = NULL, array $data = array(), $dataName = '')
    {
        if ($name !== NULL) {
            $this->setName($name);
        }

        $this->data = $data;
        $this->dataName = $dataName;
    }

    /**
* Returns a string representation of the test case.
*
* @return string
*/
    public function toString()
    {
        $class = new ReflectionClass($this);

        $buffer = sprintf(
          '%s(%s)',

          $this->getName(),
          $class->name
        );

        return $buffer . $this->getDataSetAsString();
    }

    /**
* Counts the number of test cases executed by run(TestResult result).
*
* @return integer
*/
    public function count()
    {
        return 1;
    }

    /**
* Gets the name of a TestCase.
*
* @param boolean $withDataSet
* @return string
*/
    public function getName($withDataSet = TRUE)
    {
        if ($withDataSet) {
            return $this->name . $this->getDataSetAsString(FALSE);
        } else {
            return $this->name;
        }
    }

    /**
* @return string
* @since Method available since Release 3.2.0
*/
    public function getExpectedException()
    {
        return $this->expectedException;
    }

    /**
* @param mixed $exceptionName
* @param string $exceptionMessage
* @param integer $exceptionCode
* @since Method available since Release 3.2.0
*/
    public function setExpectedException($exceptionName, $exceptionMessage = '', $exceptionCode = 0)
    {
        $this->expectedException = $exceptionName;
        $this->expectedExceptionMessage = $exceptionMessage;
        $this->expectedExceptionCode = $exceptionCode;
    }

    /**
* Returns the status of this test.
*
* @return integer
* @since Method available since Release 3.1.0
*/
    public function getStatus()
    {
        return $this->status;
    }

    /**
* Returns the status message of this test.
*
* @return string
* @since Method available since Release 3.3.0
*/
    public function getStatusMessage()
    {
        return $this->statusMessage;
    }

    /**
* Returns whether or not this test has failed.
*
* @return boolean
* @since Method available since Release 3.0.0
*/
    public function hasFailed()
    {
        $status = $this->getStatus();

        return $status == PHPUnit_Runner_BaseTestRunner::STATUS_FAILURE ||
               $status == PHPUnit_Runner_BaseTestRunner::STATUS_ERROR;
    }

    /**
* Runs the test case and collects the results in a TestResult object.
* If no TestResult object is passed a new one will be created.
*
* @param PHPUnit_Framework_TestResult $result
* @return PHPUnit_Framework_TestResult
* @throws InvalidArgumentException
*/
    public function run(PHPUnit_Framework_TestResult $result = NULL)
    {
        $this->numAssertions = 0;

        if ($result === NULL) {
            $result = $this->createResult();
        }

        $result->run($this);

        return $result;
    }

    /**
* Runs the bare test sequence.
*
*/
    public function runBare()
    {
        // Backup the $GLOBALS array.
        if ($this->backupGlobals === NULL || $this->backupGlobals === TRUE) {
            $globalsBackup = array();

            foreach ($GLOBALS as $k => $v) {
                if ($k != 'GLOBALS') {
                    $globalsBackup[$k] = serialize($v);
                }
            }
        }

        // Cleanup the $GLOBALS array.
        else if ($this->cleanupGlobals === NULL || $this->cleanupGlobals === TRUE) {
            $this->cleanupGlobals();
        }

        // Set up the fixture.
        $this->setUp();

        // Run the test.
        try {
            // Assert pre-conditions.
            $this->assertPreConditions();

            $this->runTest();

            // Assert post-conditions.
            $this->assertPostConditions();

            // Verify Mock Object conditions.
            foreach ($this->mockObjects as $mockObject) {
                $this->numAssertions++;
                $mockObject->verify();
            }

            $this->status = PHPUnit_Runner_BaseTestRunner::STATUS_PASSED;
        }

        catch (Exception $e) {
            if ($e instanceof PHPUnit_Framework_IncompleteTest) {
                $this->status = PHPUnit_Runner_BaseTestRunner::STATUS_INCOMPLETE;
            }

            if ($e instanceof PHPUnit_Framework_SkippedTest) {
                $this->status = PHPUnit_Runner_BaseTestRunner::STATUS_SKIPPED;
            }

            if ($e instanceof PHPUnit_Framework_AssertionFailedError) {
                $this->status = PHPUnit_Runner_BaseTestRunner::STATUS_FAILURE;
            }

            $this->statusMessage = $e->getMessage();
        }

        $this->mockObjects = array();

        // Tear down the fixture.
        $this->tearDown();

        // Restore the $GLOBALS array.
        if ($this->backupGlobals === NULL || $this->backupGlobals === TRUE) {
            $this->cleanupGlobals();

            foreach ($globalsBackup as $k => $v) {
                $GLOBALS[$k] = unserialize($v);
            }
        }

        // Cleanup the $GLOBALS array.
        else if ($this->cleanupGlobals === NULL || $this->cleanupGlobals === TRUE) {
            $this->cleanupGlobals();
        }

        // Clean up INI settings.
        foreach ($this->iniSettings as $varName => $oldValue) {
            ini_set($varName, $oldValue);
        }

        $this->iniSettings = array();

        // Clean up locale settings.
        foreach ($this->locale as $category => $locale) {
            setlocale($category, $locale);
        }

        // Clean up stat cache.
        clearstatcache();

        // Workaround for missing "finally".
        if (isset($e)) {
            throw $e;
        }
    }

    /**
* Override to run the test and assert its state.
*
* @throws RuntimeException
*/
    protected function runTest()
    {
        if ($this->name === NULL) {
            throw new RuntimeException(
              'PHPUnit_Framework_TestCase::$name must not be NULL.'
            );
        }

        try {
            $class = new ReflectionClass($this);
            $method = $class->getMethod($this->name);
        }

        catch (ReflectionException $e) {
            $this->fail($e->getMessage());
        }

        try {
            if (empty($this->data)) {
                $method->invoke($this);
            } else {
                $method->invokeArgs($this, $this->data);
            }
        }

        catch (Exception $e) {
            if (is_string($this->expectedException) &&
                $e instanceof $this->expectedException) {
                if (is_string($this->expectedExceptionMessage) &&
                    !empty($this->expectedExceptionMessage)) {
                    $this->assertContains(
                      $this->expectedExceptionMessage,
                      $e->getMessage()
                    );
                }

                if (is_int($this->expectedExceptionCode) &&
                    $this->expectedExceptionCode !== 0) {
                    $this->assertEquals(
                      $this->expectedExceptionCode, $e->getCode()
                    );
                }

                $this->incrementAssertionCounter();

                return;
            } else {
                throw $e;
            }
        }

        if ($this->expectedException !== NULL) {
            $this->incrementAssertionCounter();
            $this->fail('Expected exception ' . $this->expectedException);
        }
    }

    /**
* Sets the name of a TestCase.
*
* @param string
*/
    public function setName($name)
    {
        $this->name = $name;
    }

    /**
* Calling this method in setUp() has no effect!
*
* @param boolean $backupGlobals
* @since Method available since Release 3.3.0
*/
    public function setBackupGlobals($backupGlobals)
    {
        if (is_null($this->backupGlobals) && is_bool($backupGlobals)) {
            $this->backupGlobals = $backupGlobals;
        }
    }

    /**
* Calling this method in setUp() has no effect!
*
* @param boolean $cleanupGlobals
* @since Method available since Release 3.3.0
*/
    public function setCleanupGlobals($cleanupGlobals)
    {
        if (is_null($this->cleanupGlobals) && is_bool($cleanupGlobals)) {
            $this->cleanupGlobals = $cleanupGlobals;
        }
    }

    /**
* Sets the shared fixture.
*
* @param mixed $sharedFixture
* @since Method available since Release 3.1.0
*/
    public function setSharedFixture($sharedFixture)
    {
        $this->sharedFixture = $sharedFixture;
    }

    /**
* This method is a wrapper for the ini_set() function that automatically
* resets the modified php.ini setting to its original value after the
* test is run.
*
* @param string $varName
* @param string $newValue
* @throws InvalidArgumentException
* @throws RuntimeException
* @since Method available since Release 3.0.0
*/
    protected function iniSet($varName, $newValue)
    {
        if (!is_string($varName)) {
            throw new InvalidArgumentException;
        }

        $currentValue = ini_set($varName, $newValue);

        if ($currentValue !== FALSE) {
            $this->iniSettings[$varName] = $currentValue;
        } else {
            throw new RuntimeException;
        }
    }

    /**
* This method is a wrapper for the setlocale() function that automatically
* resets the locale to its original value after the test is run.
*
* @param integer $category
* @param string $locale
* @throws InvalidArgumentException
* @throws RuntimeException
* @since Method available since Release 3.1.0
*/
    protected function setLocale()
    {
        $args = func_get_args();

        if (count($args) < 2) {
            throw new InvalidArgumentException;
        }

        $category = $args[0];
        $locale = $args[1];

        if (!in_array($category, array(LC_ALL, LC_COLLATE, LC_CTYPE, LC_MONETARY, LC_NUMERIC, LC_TIME, LC_MESSAGES))) {
            throw new InvalidArgumentException;
        }

        if (!is_array($locale) && !is_string($locale)) {
            throw new InvalidArgumentException;
        }

        $this->locale[$category] = setlocale($category, NULL);

        $result = call_user_func_array( 'setlocale', $args );

        if ($result === FALSE) {
            throw new RuntimeException(
              'The locale functionality is not implemented on your platform, ' .
              'the specified locale does not exist or the category name is ' .
              'invalid.'
            );
        }
    }

    /**
* Returns a mock object for the specified class.
*
* @param string $className
* @param array $methods
* @param array $arguments
* @param string $mockClassName
* @param boolean $callOriginalConstructor
* @param boolean $callOriginalClone
* @param boolean $callAutoload
* @return object
* @since Method available since Release 3.0.0
*/
    protected function getMock($className, array $methods = array(), array $arguments = array(), $mockClassName = '', $callOriginalConstructor = TRUE, $callOriginalClone = TRUE, $callAutoload = TRUE)
    {
        if (!is_string($className) || !is_string($mockClassName)) {
            throw new InvalidArgumentException;
        }

        $mock = PHPUnit_Framework_MockObject_Mock::generate(
          $className,
          $methods,
          $mockClassName,
          $callOriginalConstructor,
          $callOriginalClone,
          $callAutoload
        );

        if (count($arguments) == 0) {
            $mockObject = new $mock->mockClassName;
        } else {
            $mockClass = new ReflectionClass($mock->mockClassName);
            $mockObject = $mockClass->newInstanceArgs($arguments);
        }

        $this->mockObjects[] = $mockObject;

        return $mockObject;
    }

    /**
* Returns the number of assertions performed by this test.
*
* @return integer
* @since Method available since Release 3.3.0
*/
    public function getNumAssertions()
    {
        return $this->numAssertions;
    }

    /**
* Increments the number of assertions performed by this test.
*
* @since Method available since Release 3.3.0
*/
    public function incrementAssertionCounter()
    {
        $this->numAssertions++;
    }

    /**
* Returns a matcher that matches when the method it is evaluated for
* is executed zero or more times.
*
* @return PHPUnit_Framework_MockObject_Matcher_AnyInvokedCount
* @since Method available since Release 3.0.0
*/
    protected function any()
    {
        return new PHPUnit_Framework_MockObject_Matcher_AnyInvokedCount;
    }

    /**
* Returns a matcher that matches when the method it is evaluated for
* is never executed.
*
* @return PHPUnit_Framework_MockObject_Matcher_InvokedCount
* @since Method available since Release 3.0.0
*/
    protected function never()
    {
        return new PHPUnit_Framework_MockObject_Matcher_InvokedCount(0);
    }

    /**
* Returns a matcher that matches when the method it is evaluated for
* is executed at least once.
*
* @return PHPUnit_Framework_MockObject_Matcher_InvokedAtLeastOnce
* @since Method available since Release 3.0.0
*/
    protected function atLeastOnce()
    {
        return new PHPUnit_Framework_MockObject_Matcher_InvokedAtLeastOnce;
    }

    /**
* Returns a matcher that matches when the method it is evaluated for
* is executed exactly once.
*
* @return PHPUnit_Framework_MockObject_Matcher_InvokedCount
* @since Method available since Release 3.0.0
*/
    protected function once()
    {
        return new PHPUnit_Framework_MockObject_Matcher_InvokedCount(1);
    }

    /**
* Returns a matcher that matches when the method it is evaluated for
* is executed exactly $count times.
*
* @param integer $count
* @return PHPUnit_Framework_MockObject_Matcher_InvokedCount
* @since Method available since Release 3.0.0
*/
    protected function exactly($count)
    {
        return new PHPUnit_Framework_MockObject_Matcher_InvokedCount($count);
    }

    /**
* Returns a matcher that matches when the method it is evaluated for
* is invoked at the given $index.
*
* @param integer $index
* @return PHPUnit_Framework_MockObject_Matcher_InvokedAtIndex
* @since Method available since Release 3.0.0
*/
    protected function at($index)
    {
        return new PHPUnit_Framework_MockObject_Matcher_InvokedAtIndex($index);
    }

    /**
*
*
* @param mixed $value
* @return PHPUnit_Framework_MockObject_Stub_Return
* @since Method available since Release 3.0.0
*/
    protected function returnValue($value)
    {
        return new PHPUnit_Framework_MockObject_Stub_Return($value);
    }

    /**
*
*
* @param integer $argumentIndex
* @return PHPUnit_Framework_MockObject_Stub_ReturnArgument
* @since Method available since Release 3.3.0
*/
    protected function returnArgument($argumentIndex)
    {
        return new PHPUnit_Framework_MockObject_Stub_ReturnArgument($argumentIndex);
    }

    /**
*
*
* @param mixed $callback
* @return PHPUnit_Framework_MockObject_Stub_ReturnCallback
* @since Method available since Release 3.3.0
*/
    protected function returnCallback($callback)
    {
        return new PHPUnit_Framework_MockObject_Stub_ReturnCallback($callback);
    }

    /**
*
*
* @param Exception $exception
* @return PHPUnit_Framework_MockObject_Stub_Exception
* @since Method available since Release 3.1.0
*/
    protected function throwException(Exception $exception)
    {
        return new PHPUnit_Framework_MockObject_Stub_Exception($exception);
    }

    /**
*
*
* @param mixed $value, ...
* @return PHPUnit_Framework_MockObject_Stub_ConsecutiveCalls
* @since Method available since Release 3.0.0
*/
    protected function onConsecutiveCalls()
    {
        $args = func_get_args();

        return new PHPUnit_Framework_MockObject_Stub_ConsecutiveCalls($args);
    }

    /**
* @param mixed $data
* @return string
* @since Method available since Release 3.2.1
*/
    protected function dataToString($data)
    {
        $result = array();

        foreach ($data as $_data) {
            if (is_array($_data)) {
                $result[] = 'array(' . $this->dataToString($_data) . ')';
            }

            else if (is_object($_data)) {
                $object = new ReflectionObject($_data);

                if ($object->hasMethod('__toString')) {
                    $result[] = (string)$_data;
                } else {
                    $result[] = get_class($_data);
                }
            }

            else if (is_resource($_data)) {
                $result[] = '<resource>';
            }

            else {
                $result[] = var_export($_data, TRUE);
            }
        }

        return join(', ', $result);
    }

    /**
* Gets the data set description of a TestCase.
*
* @param boolean $includeData
* @return string
* @since Method available since Release 3.3.0
*/
    protected function getDataSetAsString($includeData = TRUE)
    {
        $buffer = '';

        if (!empty($this->data)) {
            if (is_int($this->dataName)) {
                $buffer .= sprintf(' with data set #%d', $this->dataName);
            } else {
                $buffer .= sprintf(' with data set "%s"', $this->dataName);
            }

            if ($includeData) {
                $buffer .= sprintf(
                  $buffer . ' (%s)', $this->dataToString($this->data)
                );
            }
        }

        return $buffer;
    }

    /**
* Creates a default TestResult object.
*
* @return PHPUnit_Framework_TestResult
*/
    protected function createResult()
    {
        return new PHPUnit_Framework_TestResult;
    }

    /**
* Sets up the fixture, for example, open a network connection.
* This method is called before a test is executed.
*
*/
    protected function setUp()
    {
    }

    /**
* Performs assertions shared by all tests of a test case.
*
* This method is called before the execution of a test starts
* and after setUp() is called.
*
* @since Method available since Release 3.2.8
*/
    protected function assertPreConditions()
    {
    }

    /**
* Performs assertions shared by all tests of a test case.
*
* This method is called before the execution of a test ends
* and before tearDown() is called.
*
* @since Method available since Release 3.2.8
*/
    protected function assertPostConditions()
    {
        // assertPostConditions() was named sharedAssertions() in
        // PHPUnit 3.0.0-3.2.7.
        if (method_exists($this, 'sharedAssertions')) {
            $this->sharedAssertions();
        }
    }

    /**
* Tears down the fixture, for example, close a network connection.
* This method is called after a test is executed.
*/
    protected function tearDown()
    {
    }

    /**
* @since Method available since Release 3.3.0
*/
    protected function cleanupGlobals()
    {
        $GLOBALS = array();
        $_ENV = array();
        $HTTP_ENV_VARS = array();
        $argv = array();
        $argc = array();
        $_POST = array();
        $HTTP_POST_VARS = array();
        $_GET = array();
        $HTTP_GET_VARS = array();
        $_COOKIE = array();
        $HTTP_COOKIE_VARS = array();
        $_SERVER = array();
        $HTTP_SERVER_VARS = array();
        $_FILES = array();
        $HTTP_POST_FILES = array();
        $_REQUEST = array();
    }
}

}
?>
Something went wrong with that request. Please try again.