Newer
Older
sqlmarker / Unit_testing / PHPUnit / Framework / Constraint / IsEqualSC.php
  1. <?php
  2. /**
  3. * PHPUnit
  4. *
  5. * Copyright (c) 2001-2013, 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 Kore Nordmann <kn@ez.no>
  40. * @author Sebastian Bergmann <sebastian@phpunit.de>
  41. * @author Bernhard Schussek <bschussek@2bepublished.at>
  42. * @copyright 2001-2013 Sebastian Bergmann <sebastian@phpunit.de>
  43. * @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License
  44. * @link http://www.phpunit.de/
  45. * @since File available since Release 3.0.0
  46. */
  47.  
  48. /**
  49. * Constraint that checks if one value is equal to another.
  50. *
  51. * Equality is checked with PHP's == operator, the operator is explained in
  52. * detail at {@url http://www.php.net/manual/en/types.comparisons.php}.
  53. * Two values are equal if they have the same value disregarding type.
  54. *
  55. * The expected value is passed in the constructor.
  56. *
  57. * @package PHPUnit
  58. * @subpackage Framework_Constraint
  59. * @author Kore Nordmann <kn@ez.no>
  60. * @author Sebastian Bergmann <sebastian@phpunit.de>
  61. * @author Bernhard Schussek <bschussek@2bepublished.at>
  62. * @copyright 2001-2013 Sebastian Bergmann <sebastian@phpunit.de>
  63. * @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License
  64. * @link http://www.phpunit.de/
  65. * @since Class available since Release 3.0.0
  66. */
  67. class PHPUnit_Framework_Constraint_IsEqualSC extends PHPUnit_Framework_Constraint_IsEqual
  68. {
  69. /**
  70. * Evaluates the constraint for parameter $other
  71. *
  72. * If $returnResult is set to FALSE (the default), an exception is thrown
  73. * in case of a failure. NULL is returned otherwise.
  74. *
  75. * If $returnResult is TRUE, the result of the evaluation is returned as
  76. * a boolean value instead: TRUE in case of success, FALSE in case of a
  77. * failure.
  78. *
  79. * @param mixed $other Value or object to evaluate.
  80. * @param string $description Additional information about the test
  81. * @param bool $returnResult Whether to return a result or throw an exception
  82. * @return mixed
  83. * @throws PHPUnit_Framework_ExpectationFailedException
  84. */
  85. public function evaluate($other, $description = '', $returnResult = FALSE)
  86. {
  87. $comparatorFactory = PHPUnit_Framework_ComparatorFactory::getDefaultInstance();
  88.  
  89. try {
  90. $comparator = $comparatorFactory->getComparatorFor(
  91. $other, $this->value
  92. );
  93.  
  94. $comparator->assertEquals(
  95. $this->value,
  96. $other,
  97. $this->delta,
  98. $this->canonicalize,
  99. $this->ignoreCase
  100. );
  101. }
  102.  
  103. catch (PHPUnit_Framework_ComparisonFailure $f) {
  104. if ($returnResult) {
  105. return FALSE;
  106. }
  107. $this->fail($other, $description);
  108. }
  109.  
  110. return TRUE;
  111. }
  112.  
  113.  
  114. /**
  115. * Returns a string representation of the constraint.
  116. *
  117. * @return string
  118. */
  119. public function toString()
  120. {
  121. return 'is equal to expected value';
  122. }
  123. }