Debug.php 4.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. <?php
  2. /*
  3. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  4. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  5. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  6. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  7. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  8. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  9. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. *
  15. * This software consists of voluntary contributions made by many individuals
  16. * and is licensed under the MIT license. For more information, see
  17. * <http://www.doctrine-project.org>.
  18. */
  19. namespace Doctrine\Common\Util;
  20. /**
  21. * Static class containing most used debug methods.
  22. *
  23. * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
  24. * @link www.doctrine-project.org
  25. * @since 2.0
  26. * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
  27. * @author Jonathan Wage <jonwage@gmail.com>
  28. * @author Roman Borschel <roman@code-factory.org>
  29. * @author Giorgio Sironi <piccoloprincipeazzurro@gmail.com>
  30. */
  31. final class Debug
  32. {
  33. /**
  34. * Private constructor (prevents from instantiation)
  35. *
  36. */
  37. private function __construct() {}
  38. /**
  39. * Prints a dump of the public, protected and private properties of $var.
  40. *
  41. * @link http://xdebug.org/
  42. * @param mixed $var
  43. * @param integer $maxDepth Maximum nesting level for object properties
  44. * @param boolean $stripTags Flag that indicate if output should strip HTML tags
  45. */
  46. public static function dump($var, $maxDepth = 2, $stripTags = true)
  47. {
  48. ini_set('html_errors', 'On');
  49. if (extension_loaded('xdebug')) {
  50. ini_set('xdebug.var_display_max_depth', $maxDepth);
  51. }
  52. $var = self::export($var, $maxDepth++);
  53. ob_start();
  54. var_dump($var);
  55. $dump = ob_get_contents();
  56. ob_end_clean();
  57. echo ($stripTags ? strip_tags(html_entity_decode($dump)) : $dump);
  58. ini_set('html_errors', 'Off');
  59. }
  60. /**
  61. * Export
  62. *
  63. * @param mixed $var
  64. * @param int $maxDepth
  65. * @return mixed
  66. */
  67. public static function export($var, $maxDepth)
  68. {
  69. $return = null;
  70. $isObj = is_object($var);
  71. if ($isObj && in_array('Doctrine\Common\Collections\Collection', class_implements($var))) {
  72. $var = $var->toArray();
  73. }
  74. if ($maxDepth) {
  75. if (is_array($var)) {
  76. $return = array();
  77. foreach ($var as $k => $v) {
  78. $return[$k] = self::export($v, $maxDepth - 1);
  79. }
  80. } else if ($isObj) {
  81. $return = new \stdclass();
  82. if ($var instanceof \DateTime) {
  83. $return->__CLASS__ = "DateTime";
  84. $return->date = $var->format('c');
  85. $return->timezone = $var->getTimeZone()->getName();
  86. } else {
  87. $reflClass = ClassUtils::newReflectionObject($var);
  88. $return->__CLASS__ = ClassUtils::getClass($var);
  89. if ($var instanceof \Doctrine\Common\Persistence\Proxy) {
  90. $return->__IS_PROXY__ = true;
  91. $return->__PROXY_INITIALIZED__ = $var->__isInitialized();
  92. }
  93. foreach ($reflClass->getProperties() as $reflProperty) {
  94. $name = $reflProperty->getName();
  95. $reflProperty->setAccessible(true);
  96. $return->$name = self::export($reflProperty->getValue($var), $maxDepth - 1);
  97. }
  98. }
  99. } else {
  100. $return = $var;
  101. }
  102. } else {
  103. $return = is_object($var) ? get_class($var)
  104. : (is_array($var) ? 'Array(' . count($var) . ')' : $var);
  105. }
  106. return $return;
  107. }
  108. /**
  109. * Convert to string
  110. *
  111. * @param object $obj
  112. * @return string
  113. */
  114. public static function toString($obj)
  115. {
  116. return method_exists('__toString', $obj) ? (string) $obj : get_class($obj) . '@' . spl_object_hash($obj);
  117. }
  118. }