class DevelDumperBase
Same name and namespace in other branches
- 4.x src/DevelDumperBase.php \Drupal\devel\DevelDumperBase
Defines a base devel dumper implementation.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\devel\DevelDumperBase implements \Drupal\devel\DevelDumperInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of DevelDumperBase
See also
\Drupal\devel\Annotation\DevelDumper
\Drupal\devel\DevelDumperInterface
\Drupal\devel\DevelDumperPluginManager
3 files declare their use of DevelDumperBase
- AvailableTestDumper.php in tests/
modules/ devel_dumper_test/ src/ Plugin/ Devel/ Dumper/ AvailableTestDumper.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 18
Namespace
Drupal\develView source
abstract class DevelDumperBase extends PluginBase implements DevelDumperInterface {
/**
* {@inheritdoc}
*/
public function dump($input, ?string $name = NULL) : void {
echo (string) $this->export($input, $name);
}
/**
* {@inheritdoc}
*/
public function exportAsRenderable($input, ?string $name = NULL) : array {
return [
'#markup' => $this->export($input, $name),
];
}
/**
* Wrapper for \Drupal\Core\Render\Markup::create().
*
* @param mixed $input
* The input to mark as a safe string.
*
* @return \Drupal\Component\Render\MarkupInterface|string
* The unaltered input value.
*/
protected function setSafeMarkup(mixed $input) : MarkupInterface|string {
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() : array {
$class_name = static::class;
$manager_class_name = DevelDumperManager::class;
return [
[
$class_name,
'dump',
],
[
$class_name,
'export',
],
[
$manager_class_name,
'dump',
],
[
$manager_class_name,
'export',
],
[
$manager_class_name,
'exportAsRenderable',
],
[
$manager_class_name,
'message',
],
[
Debug::class,
'dump',
],
'devel_export',
'devel_message',
'devel_debug',
'dpm',
'dvm',
'dsm',
'dpr',
'dvr',
'kpr',
'dargs',
'dcp',
'dfb',
'dfbt',
'dpq',
'ddebug_backtrace',
'kdevel_print_object',
'backtrace_error_handler',
];
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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 | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 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 | 1 |
| DevelDumperBase::getInternalFunctions | protected | function | Returns a list of internal functions. | ||
| DevelDumperBase::setSafeMarkup | protected | function | Wrapper for \Drupal\Core\Render\Markup::create(). | ||
| DevelDumperInterface::checkRequirements | public static | function | Checks if requirements for this plugin are satisfied. | 3 | |
| DevelDumperInterface::export | public | function | Returns a string representation of a variable. | 3 | |
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | |
| 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. | 86 | |
| 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. |