class DevelDumperManager
Same name in other branches
- 8.x-1.x src/DevelDumperManager.php \Drupal\devel\DevelDumperManager
- 5.x src/DevelDumperManager.php \Drupal\devel\DevelDumperManager
Class DevelDumperManager.
Hierarchy
- class \Drupal\devel\DevelDumperManager implements \Drupal\devel\DevelDumperManagerInterface uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of DevelDumperManager
1 string reference to 'DevelDumperManager'
1 service uses DevelDumperManager
File
-
src/
DevelDumperManager.php, line 14
Namespace
Drupal\develView source
class DevelDumperManager implements DevelDumperManagerInterface {
use StringTranslationTrait;
use MessengerTrait;
/**
* The devel config.
*
* @var \Drupal\Core\Config\ImmutableConfig
*/
protected $config;
/**
* The current account.
*
* @var \Drupal\Core\Session\AccountProxyInterface
*/
protected $account;
/**
* The devel dumper plugin manager.
*
* @var \Drupal\devel\DevelDumperPluginManagerInterface
*/
protected $dumperManager;
/**
* Constructs a DevelDumperPluginManager object.
*
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory service.
* @param \Drupal\Core\Session\AccountProxyInterface $account
* The current account.
* @param \Drupal\devel\DevelDumperPluginManagerInterface $dumper_manager
* The devel dumper plugin manager.
*/
public function __construct(ConfigFactoryInterface $config_factory, AccountProxyInterface $account, DevelDumperPluginManagerInterface $dumper_manager) {
$this->config = $config_factory->get('devel.settings');
$this->account = $account;
$this->dumperManager = $dumper_manager;
}
/**
* Instances a new dumper plugin.
*
* @param string $plugin_id
* (optional) The plugin ID, defaults to NULL.
*
* @return \Drupal\devel\DevelDumperInterface
* Returns the devel dumper plugin instance.
*/
protected function createInstance($plugin_id = NULL) {
if (!$plugin_id || !$this->dumperManager
->isPluginSupported($plugin_id)) {
$plugin_id = $this->config
->get('devel_dumper');
}
return $this->dumperManager
->createInstance($plugin_id);
}
/**
* {@inheritdoc}
*/
public function dump($input, $name = NULL, $plugin_id = NULL) {
if ($this->hasAccessToDevelInformation()) {
$this->createInstance($plugin_id)
->dump($input, $name);
}
}
/**
* {@inheritdoc}
*/
public function export($input, $name = NULL, $plugin_id = NULL) {
if ($this->hasAccessToDevelInformation()) {
return $this->createInstance($plugin_id)
->export($input, $name);
}
return NULL;
}
/**
* {@inheritdoc}
*/
public function message($input, $name = NULL, $type = MessengerInterface::TYPE_STATUS, $plugin_id = NULL) {
if ($this->hasAccessToDevelInformation()) {
$output = $this->export($input, $name, $plugin_id);
$this->messenger()
->addMessage($output, $type, TRUE);
}
}
/**
* {@inheritdoc}
*/
public function debug($input, $name = NULL, $plugin_id = NULL) {
$output = $this->createInstance($plugin_id)
->export($input, $name) . "\n";
// The temp directory does vary across multiple simpletest instances.
$file = $this->config
->get('debug_logfile');
if (file_put_contents($file, $output, FILE_APPEND) === FALSE && $this->hasAccessToDevelInformation()) {
$this->messenger()
->addError($this->t('Devel was unable to write to %file.', [
'%file' => $file,
]));
return FALSE;
}
}
/**
* {@inheritdoc}
*/
public function dumpOrExport($input, $name = NULL, $export = TRUE, $plugin_id = NULL) {
if ($this->hasAccessToDevelInformation()) {
$dumper = $this->createInstance($plugin_id);
if ($export) {
return $dumper->export($input, $name);
}
$dumper->dump($input, $name);
}
return NULL;
}
/**
* {@inheritdoc}
*/
public function exportAsRenderable($input, $name = NULL, $plugin_id = NULL) {
if ($this->hasAccessToDevelInformation()) {
return $this->createInstance($plugin_id)
->exportAsRenderable($input, $name);
}
return [];
}
/**
* Checks whether a user has access to devel information.
*
* @return bool
* TRUE if the user has the permission, FALSE otherwise.
*/
protected function hasAccessToDevelInformation() {
return $this->account && $this->account
->hasPermission('access devel information');
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DevelDumperManager::$account | protected | property | The current account. | ||
DevelDumperManager::$config | protected | property | The devel config. | ||
DevelDumperManager::$dumperManager | protected | property | The devel dumper plugin manager. | ||
DevelDumperManager::createInstance | protected | function | Instances a new dumper plugin. | ||
DevelDumperManager::debug | public | function | Logs a variable to a drupal_debug.txt in the site's temp directory. | Overrides DevelDumperManagerInterface::debug | |
DevelDumperManager::dump | public | function | Dumps information about a variable. | Overrides DevelDumperManagerInterface::dump | |
DevelDumperManager::dumpOrExport | public | function | Wrapper for ::dump() and ::export(). | Overrides DevelDumperManagerInterface::dumpOrExport | |
DevelDumperManager::export | public | function | Returns a string representation of a variable. | Overrides DevelDumperManagerInterface::export | |
DevelDumperManager::exportAsRenderable | public | function | Returns a render array representation of a variable. | Overrides DevelDumperManagerInterface::exportAsRenderable | |
DevelDumperManager::hasAccessToDevelInformation | protected | function | Checks whether a user has access to devel information. | ||
DevelDumperManager::message | public | function | Sets a message with a string representation of a variable. | Overrides DevelDumperManagerInterface::message | |
DevelDumperManager::__construct | public | function | Constructs a DevelDumperPluginManager object. | ||
MessengerTrait::$messenger | protected | property | The messenger. | 17 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
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. |