class VarDumper

Same name in other branches
  1. 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
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().
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