abstract class DevelDumperBase in Devel 4.x

Defines a base devel dumper implementation.

Hierarchy

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

See also

\Drupal\devel\Annotation\DevelDumper

\Drupal\devel\DevelDumperInterface

\Drupal\devel\DevelDumperPluginManager

Plugin API

5 files declare their use of DevelDumperBase

AvailableTestDumper.php in tests/modules/devel_dumper_test/src/Plugin/Devel/Dumper/AvailableTestDumper.php

DoctrineDebug.php in src/Plugin/Devel/Dumper/DoctrineDebug.php

Kint.php in src/Plugin/Devel/Dumper/Kint.php

NotAvailableTestDumper.php in tests/modules/devel_dumper_test/src/Plugin/Devel/Dumper/NotAvailableTestDumper.php

VarDumper.php in src/Plugin/Devel/Dumper/VarDumper.php

File

src/DevelDumperBase.php, line 16

Namespace

Drupal\devel

abstract class DevelDumperBase extends PluginBase implements DevelDumperInterface {

  /**
   * {@inheritdoc}
   */
  public function dump($input, $name = NULL) {
    echo (string) $this
      ->export($input, $name);
  }

  /**
   * {@inheritdoc}
   */
  public function exportAsRenderable($input, $name = NULL) {
    return [
      '#markup' => $this
        ->export($input, $name),
    ];
  }

  /**
   * Wrapper for \Drupal\Core\Render\Markup::create().
   *
   * @param string $input
   *   The input string to mark as safe.
   *
   * @return string
   *   The unaltered input value.
   */
  protected function setSafeMarkup($input) {
    return FilteredMarkup::create($input);
  }

  /**
   * Returns a list of internal functions.
   *
   * The list returned from this method can be used to exclude internal
   * functions from the backtrace output.
   *
   * @return array
   *   An array of internal functions.
   */
  protected function getInternalFunctions() {
    $class_name = get_class($this);
    $manager_class_name = DevelDumperManager::class;
    $aliases = [
      [
        $class_name,
        'dump',
      ],
      [
        $class_name,
        'export',
      ],
      [
        $manager_class_name,
        'dump',
      ],
      [
        $manager_class_name,
        'export',
      ],
      [
        $manager_class_name,
        'exportAsRenderable',
      ],
      [
        $manager_class_name,
        'message',
      ],
      [
        \Drupal\devel\Twig\Extension\Debug::class,
        'dump',
      ],
      'dpm',
      'dvm',
      'dsm',
      'dpr',
      'dvr',
      'kpr',
      'dargs',
      'dcp',
      'dfb',
      'dfbt',
      'dpq',
      'kint',
      'ksm',
      'ddebug_backtrace',
      'kdevel_print_object',
      'backtrace_error_handler',
    ];
    return $aliases;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
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().
DevelDumperInterface::checkRequirements	public static	function	Checks if requirements for this plugin are satisfied.	5
DevelDumperInterface::export	public	function	Returns a string representation of a variable.	5
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.	98
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.