class VarDumper in Devel 8.2

Provides a Symfony VarDumper dumper plugin.

Plugin annotation

@DevelDumper(
  id = "var_dumper",
  label = @Translation("Symfony var-dumper"),
  description = @Translation("Wrapper for <a href='https://github.com/symfony/var-dumper'>Symfony var-dumper</a> debugging tool."),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\devel\DevelDumperBase implements DevelDumperInterface
      • class \Drupal\devel\Plugin\Devel\Dumper\VarDumper

File

src/Plugin/Devel/Dumper/VarDumper.php, line 19

Namespace

Drupal\devel\Plugin\Devel\Dumper

class VarDumper extends DevelDumperBase {

  /**
   * {@inheritdoc}
   */
  public function export($input, $name = NULL) {
    $cloner = new VarCloner();
    $dumper = 'cli' === PHP_SAPI ? new CliDumper() : new HtmlDumper();
    $output = fopen('php://memory', 'r+b');
    $dumper
      ->dump($cloner
      ->cloneVar($input), $output);
    $output = stream_get_contents($output, -1, 0);
    if ($name) {
      $output = $name . ' => ' . $output;
    }
    return $this
      ->setSafeMarkup($output);
  }

  /**
   * {@inheritdoc}
   */
  public static function checkRequirements() {
    return class_exists('Symfony\\Component\\VarDumper\\Cloner\\VarCloner', TRUE);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DevelDumperBase::dump	public	function	Dumps information about a variable. Overrides DevelDumperInterface::dump	4
DevelDumperBase::exportAsRenderable	public	function	Returns a string representation of a variable wrapped in a render array. Overrides DevelDumperInterface::exportAsRenderable	3
DevelDumperBase::setSafeMarkup	protected	function	Wrapper for \Drupal\Core\Render\Markup::create().
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
VarDumper::checkRequirements	public static	function	Checks if requirements for this plugin are satisfied. Overrides DevelDumperInterface::checkRequirements
VarDumper::export	public	function	Returns a string representation of a variable. Overrides DevelDumperInterface::export