class 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

Title Modifiers Object type Summary Overriden Title Overrides
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