class DoctrineDebug

Same name in other branches
  1. 4.x src/Plugin/Devel/Dumper/DoctrineDebug.php \Drupal\devel\Plugin\Devel\Dumper\DoctrineDebug

Provides a DoctrineDebug dumper plugin.

Plugin annotation


@DevelDumper(
  id = "default",
  label = @Translation("Default"),
  description = @Translation("Wrapper for <a href='https://www.doctrine-project.org/api/common/latest/Doctrine/Common/Util/Debug.html'>Doctrine</a> debugging tool.")
)

Hierarchy

Expanded class hierarchy of DoctrineDebug

File

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

Namespace

Drupal\devel\Plugin\Devel\Dumper
View source 
class DoctrineDebug extends DevelDumperBase {
    
    /**
     * {@inheritdoc}
     */
    public function export($input, $name = NULL) {
        $name = $name ? $name . ' => ' : '';
        $variable = Debug::export($input, 6);
        ob_start();
        print_r($variable);
        $dump = ob_get_contents();
        ob_end_clean();
        // Run Xss::filterAdmin on the resulting string to prevent
        // cross-site-scripting (XSS) vulnerabilities.
        $dump = Xss::filterAdmin($dump);
        $config = \Drupal::config('devel.settings');
        $debug_pre = $config->get('debug_pre');
        $dump = ($debug_pre ? '<pre>' : '') . $name . $dump . ($debug_pre ? '</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 2
DevelDumperBase::getInternalFunctions protected function Returns a list of internal functions. 1
DevelDumperBase::setSafeMarkup protected function Wrapper for \Drupal\Core\Render\Markup::create().
DoctrineDebug::checkRequirements public static function Checks if requirements for this plugin are satisfied. Overrides DevelDumperInterface::checkRequirements
DoctrineDebug::export public function Returns a string representation of a variable. Overrides DevelDumperInterface::export
DoctrineDebug::exportAsRenderable public function Returns a string representation of a variable wrapped in a render array. Overrides DevelDumperBase::exportAsRenderable