You are here

class DrupalVariable in Devel 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/Devel/Dumper/DrupalVariable.php \Drupal\devel\Plugin\Devel\Dumper\DrupalVariable

Provides a DrupalVariable dumper plugin.

Plugin annotation


@DevelDumper(
  id = "drupal_variable",
  label = @Translation("Drupal variable."),
  description = @Translation("Wrapper for <a href='https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Component%21Utility%21Variable.php/class/Variable/8'>Drupal Variable</a> class.")
)

Hierarchy

Expanded class hierarchy of DrupalVariable

File

src/Plugin/Devel/Dumper/DrupalVariable.php, line 18

Namespace

Drupal\devel\Plugin\Devel\Dumper
View source
class DrupalVariable extends DevelDumperBase {

  /**
   * {@inheritdoc}
   */
  public function export($input, $name = NULL) {
    $name = $name ? $name . ' => ' : '';
    $dump = Variable::export($input);

    // Run Xss::filterAdmin on the resulting string to prevent
    // cross-site-scripting (XSS) vulnerabilities.
    $dump = Xss::filterAdmin($dump);
    $dump = '<pre>' . $name . $dump . '</pre>';
    return $this
      ->setSafeMarkup($dump);
  }

  /**
   * {@inheritdoc}
   */
  public function exportAsRenderable($input, $name = NULL) {
    $output['container'] = [
      '#type' => 'details',
      '#title' => $name ?: $this
        ->t('Variable'),
      '#attached' => [
        'library' => [
          'devel/devel',
        ],
      ],
      '#attributes' => [
        'class' => [
          'container-inline',
          'devel-dumper',
          'devel-selectable',
        ],
      ],
      'export' => [
        '#markup' => $this
          ->export($input),
      ],
    ];
    return $output;
  }

  /**
   * {@inheritdoc}
   */
  public static function checkRequirements() {
    return TRUE;
  }

}

Members

Namesort descending Modifiers Type Description 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 1
DependencySerializationTrait::__wakeup public function 2
DevelDumperBase::dump public function Dumps information about a variable. Overrides DevelDumperInterface::dump 4
DevelDumperBase::setSafeMarkup protected function Wrapper for \Drupal\Core\Render\Markup::create().
DrupalVariable::checkRequirements public static function Checks if requirements for this plugin are satisfied. Overrides DevelDumperInterface::checkRequirements
DrupalVariable::export public function Returns a string representation of a variable. Overrides DevelDumperInterface::export
DrupalVariable::exportAsRenderable public function Returns a string representation of a variable wrapped in a render array. Overrides DevelDumperBase::exportAsRenderable
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 3
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. 92
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.