class VarDumper

Same name and namespace in other branches
  1. 8.x-1.x src/Plugin/Devel/Dumper/VarDumper.php \Drupal\devel\Plugin\Devel\Dumper\VarDumper
  2. 4.x src/Plugin/Devel/Dumper/VarDumper.php \Drupal\devel\Plugin\Devel\Dumper\VarDumper

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

Expanded class hierarchy of VarDumper

1 file declares its use of VarDumper
devel.install in ./devel.install
Install, update and uninstall functions for the devel module.

File

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

Namespace

Drupal\devel\Plugin\Devel\Dumper
View source 
class VarDumper extends DevelDumperBase {
  
  /**
   * {@inheritdoc}
   */
  public function export(mixed $input, ?string $name = NULL) : MarkupInterface|string {
    $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 !== NULL && $name !== '') {
      $output = $name . ' => ' . $output;
    }
    return $this->setSafeMarkup($output);
  }
  
  /**
   * {@inheritdoc}
   */
  public static function checkRequirements() : bool {
    return class_exists(VarCloner::class, TRUE);
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DevelDumperBase::dump public function Dumps information about a variable. Overrides DevelDumperInterface::dump 2
DevelDumperBase::exportAsRenderable public function Returns a string representation of a variable wrapped in a render array. Overrides DevelDumperInterface::exportAsRenderable 2
DevelDumperBase::getInternalFunctions protected function Returns a list of internal functions. 1
DevelDumperBase::setSafeMarkup protected function Wrapper for \Drupal\Core\Render\Markup::create().
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
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
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. 6
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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