Mercurial > hg > isophonics-drupal-site
diff core/lib/Drupal/Component/Utility/Variable.php @ 0:4c8ae668cc8c
Initial import (non-working)
author | Chris Cannam |
---|---|
date | Wed, 29 Nov 2017 16:09:58 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/lib/Drupal/Component/Utility/Variable.php Wed Nov 29 16:09:58 2017 +0000 @@ -0,0 +1,71 @@ +<?php + +namespace Drupal\Component\Utility; + +/** + * Provides helpers for dealing with variables. + * + * @ingroup utility + */ +class Variable { + + /** + * Drupal-friendly var_export(). + * + * @param mixed $var + * The variable to export. + * @param string $prefix + * A prefix that will be added at the beginning of every lines of the output. + * + * @return string + * The variable exported in a way compatible to Drupal's coding standards. + */ + public static function export($var, $prefix = '') { + if (is_array($var)) { + if (empty($var)) { + $output = 'array()'; + } + else { + $output = "array(\n"; + // Don't export keys if the array is non associative. + $export_keys = array_values($var) != $var; + foreach ($var as $key => $value) { + $output .= ' ' . ($export_keys ? static::export($key) . ' => ' : '') . static::export($value, ' ', FALSE) . ",\n"; + } + $output .= ')'; + } + } + elseif (is_bool($var)) { + $output = $var ? 'TRUE' : 'FALSE'; + } + elseif (is_string($var)) { + if (strpos($var, "\n") !== FALSE || strpos($var, "'") !== FALSE) { + // If the string contains a line break or a single quote, use the + // double quote export mode. Encode backslash, dollar symbols, and + // double quotes and transform some common control characters. + $var = str_replace(['\\', '$', '"', "\n", "\r", "\t"], ['\\\\', '\$', '\"', '\n', '\r', '\t'], $var); + $output = '"' . $var . '"'; + } + else { + $output = "'" . $var . "'"; + } + } + elseif (is_object($var) && get_class($var) === 'stdClass') { + // var_export() will export stdClass objects using an undefined + // magic method __set_state() leaving the export broken. This + // workaround avoids this by casting the object as an array for + // export and casting it back to an object when evaluated. + $output = '(object) ' . static::export((array) $var, $prefix); + } + else { + $output = var_export($var, TRUE); + } + + if ($prefix) { + $output = str_replace("\n", "\n$prefix", $output); + } + + return $output; + } + +}