Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Component\Utility;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides helpers for dealing with variables.
Chris@0:  *
Chris@0:  * @ingroup utility
Chris@0:  */
Chris@0: class Variable {
Chris@0: 
Chris@0:   /**
Chris@0:    * Drupal-friendly var_export().
Chris@0:    *
Chris@0:    * @param mixed $var
Chris@0:    *   The variable to export.
Chris@0:    * @param string $prefix
Chris@0:    *   A prefix that will be added at the beginning of every lines of the output.
Chris@0:    *
Chris@0:    * @return string
Chris@0:    *   The variable exported in a way compatible to Drupal's coding standards.
Chris@0:    */
Chris@0:   public static function export($var, $prefix = '') {
Chris@0:     if (is_array($var)) {
Chris@0:       if (empty($var)) {
Chris@0:         $output = 'array()';
Chris@0:       }
Chris@0:       else {
Chris@0:         $output = "array(\n";
Chris@0:         // Don't export keys if the array is non associative.
Chris@0:         $export_keys = array_values($var) != $var;
Chris@0:         foreach ($var as $key => $value) {
Chris@0:           $output .= '  ' . ($export_keys ? static::export($key) . ' => ' : '') . static::export($value, '  ', FALSE) . ",\n";
Chris@0:         }
Chris@0:         $output .= ')';
Chris@0:       }
Chris@0:     }
Chris@0:     elseif (is_bool($var)) {
Chris@0:       $output = $var ? 'TRUE' : 'FALSE';
Chris@0:     }
Chris@0:     elseif (is_string($var)) {
Chris@0:       if (strpos($var, "\n") !== FALSE || strpos($var, "'") !== FALSE) {
Chris@0:         // If the string contains a line break or a single quote, use the
Chris@0:         // double quote export mode. Encode backslash, dollar symbols, and
Chris@0:         // double quotes and transform some common control characters.
Chris@0:         $var = str_replace(['\\', '$', '"', "\n", "\r", "\t"], ['\\\\', '\$', '\"', '\n', '\r', '\t'], $var);
Chris@0:         $output = '"' . $var . '"';
Chris@0:       }
Chris@0:       else {
Chris@0:         $output = "'" . $var . "'";
Chris@0:       }
Chris@0:     }
Chris@0:     elseif (is_object($var) && get_class($var) === 'stdClass') {
Chris@0:       // var_export() will export stdClass objects using an undefined
Chris@0:       // magic method __set_state() leaving the export broken. This
Chris@0:       // workaround avoids this by casting the object as an array for
Chris@0:       // export and casting it back to an object when evaluated.
Chris@0:       $output = '(object) ' . static::export((array) $var, $prefix);
Chris@0:     }
Chris@0:     else {
Chris@0:       $output = var_export($var, TRUE);
Chris@0:     }
Chris@0: 
Chris@0:     if ($prefix) {
Chris@0:       $output = str_replace("\n", "\n$prefix", $output);
Chris@0:     }
Chris@0: 
Chris@0:     return $output;
Chris@0:   }
Chris@0: 
Chris@0: }