class DevelDumperBase
Same name 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 extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\devel\DevelDumperBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\devel\DevelDumperInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of DevelDumperBase
See also
\Drupal\devel\Annotation\DevelDumper
\Drupal\devel\DevelDumperInterface
\Drupal\devel\DevelDumperPluginManager
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 18
Namespace
Drupal\develView source
abstract class DevelDumperBase extends PluginBase implements DevelDumperInterface {
/**
* {@inheritdoc}
*/
public function dump($input, $name = NULL) : void {
echo (string) $this->export($input, $name);
}
/**
* {@inheritdoc}
*/
public function exportAsRenderable($input, $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',
],
'dpm',
'dvm',
'dsm',
'dpr',
'dvr',
'kpr',
'dargs',
'dcp',
'dfb',
'dfbt',
'dpq',
'kint',
'ksm',
'ddebug_backtrace',
'kdevel_print_object',
'backtrace_error_handler',
];
}
}
Members
Title Sort descending | 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(). | ||
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 |