class DevelController in Devel 4.x

Returns responses for devel module routes.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\devel\Controller\DevelController

File

src/Controller/DevelController.php, line 19

Namespace

Drupal\devel\Controller

class DevelController extends ControllerBase {

  /**
   * The dumper service.
   *
   * @var \Drupal\devel\DevelDumperManagerInterface
   */
  protected $dumper;

  /**
   * The entity type bundle info service.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * The field type plugin manager service.
   *
   * @var \Drupal\Core\Field\FieldTypePluginManagerInterface
   */
  protected $fieldTypeManager;

  /**
   * The field formatter plugin manager.
   *
   * @var \Drupal\Core\Field\FormatterPluginManager
   */
  protected $formatterPluginManager;

  /**
   * The field widget plugin manager.
   *
   * @var \Drupal\Core\Field\WidgetPluginManager
   */
  protected $widgetPluginManager;

  /**
   * EntityDebugController constructor.
   *
   * @param \Drupal\devel\DevelDumperManagerInterface $dumper
   *   The dumper service.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
   *   The entity type bundle info service.
   * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager
   *   The field type manager service.
   * @param \Drupal\Core\Field\FormatterPluginManager $formatter_plugin_manager
   *   The field formatter plugin manager.
   * @param \Drupal\Core\Field\WidgetPluginManager $widget_plugin_manager
   *   The field widget plugin manager.
   */
  public function __construct(DevelDumperManagerInterface $dumper, EntityTypeBundleInfoInterface $entity_type_bundle_info, FieldTypePluginManagerInterface $field_type_manager, FormatterPluginManager $formatter_plugin_manager, WidgetPluginManager $widget_plugin_manager) {
    $this->dumper = $dumper;
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
    $this->fieldTypeManager = $field_type_manager;
    $this->formatterPluginManager = $formatter_plugin_manager;
    $this->widgetPluginManager = $widget_plugin_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('devel.dumper'), $container
      ->get('entity_type.bundle.info'), $container
      ->get('plugin.manager.field.field_type'), $container
      ->get('plugin.manager.field.formatter'), $container
      ->get('plugin.manager.field.widget'));
  }

  /**
   * Clears all caches, then redirects to the previous page.
   */
  public function cacheClear() {
    drupal_flush_all_caches();
    $this
      ->messenger()
      ->addMessage($this
      ->t('Cache cleared.'));
    return $this
      ->redirect('<front>');
  }

  /**
   * Theme registry.
   *
   * @return array
   *   The complete theme registry as renderable.
   */
  public function themeRegistry() {
    $hooks = theme_get_registry();
    ksort($hooks);
    return $this->dumper
      ->exportAsRenderable($hooks);
  }

  /**
   * Builds the fields info overview page.
   *
   * @return array
   *   Array of page elements to render.
   */
  public function fieldInfoPage() {
    $fields = FieldStorageConfig::loadMultiple();
    ksort($fields);
    $output['fields'] = $this->dumper
      ->exportAsRenderable($fields, $this
      ->t('Fields'));
    $field_instances = FieldConfig::loadMultiple();
    ksort($field_instances);
    $output['instances'] = $this->dumper
      ->exportAsRenderable($field_instances, $this
      ->t('Instances'));
    $bundles = $this->entityTypeBundleInfo
      ->getAllBundleInfo();
    ksort($bundles);
    $output['bundles'] = $this->dumper
      ->exportAsRenderable($bundles, $this
      ->t('Bundles'));
    $field_types = $this->fieldTypeManager
      ->getUiDefinitions();
    ksort($field_types);
    $output['field_types'] = $this->dumper
      ->exportAsRenderable($field_types, $this
      ->t('Field types'));
    $formatter_types = $this->formatterPluginManager
      ->getDefinitions();
    ksort($formatter_types);
    $output['formatter_types'] = $this->dumper
      ->exportAsRenderable($formatter_types, $this
      ->t('Formatter types'));
    $widget_types = $this->widgetPluginManager
      ->getDefinitions();
    ksort($widget_types);
    $output['widget_types'] = $this->dumper
      ->exportAsRenderable($widget_types, $this
      ->t('Widget types'));
    return $output;
  }

  /**
   * Builds the state variable overview page.
   *
   * @return array
   *   Array of page elements to render.
   */
  public function stateSystemPage() {
    $can_edit = $this
      ->currentUser()
      ->hasPermission('administer site configuration');
    $header = [
      'name' => $this
        ->t('Name'),
      'value' => $this
        ->t('Value'),
    ];
    if ($can_edit) {
      $header['edit'] = $this
        ->t('Operations');
    }
    $rows = [];

    // State class doesn't have getAll method so we get all states from the
    // KeyValueStorage.
    foreach ($this
      ->keyValue('state')
      ->getAll() as $state_name => $state) {
      $rows[$state_name] = [
        'name' => [
          'data' => $state_name,
          'class' => 'table-filter-text-source',
        ],
        'value' => [
          'data' => $this->dumper
            ->export($state),
        ],
      ];
      if ($can_edit) {
        $operations['edit'] = [
          'title' => $this
            ->t('Edit'),
          'url' => Url::fromRoute('devel.system_state_edit', [
            'state_name' => $state_name,
          ]),
        ];
        $rows[$state_name]['edit'] = [
          'data' => [
            '#type' => 'operations',
            '#links' => $operations,
          ],
        ];
      }
    }
    $output['states'] = [
      '#type' => 'devel_table_filter',
      '#filter_label' => $this
        ->t('Search'),
      '#filter_placeholder' => $this
        ->t('Enter state name'),
      '#filter_title' => $this
        ->t('Enter a part of the state name to filter by.'),
      '#header' => $header,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No state variables found.'),
      '#attributes' => [
        'class' => [
          'devel-state-list',
        ],
      ],
    ];
    return $output;
  }

  /**
   * Builds the session overview page.
   *
   * @return array
   *   Array of page elements to render.
   */
  public function session() {
    $output['description'] = [
      '#markup' => '<p>' . $this
        ->t('Here are the contents of your $_SESSION variable.') . '</p>',
    ];
    $output['session'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Session name'),
        $this
          ->t('Session ID'),
      ],
      '#rows' => [
        [
          session_name(),
          session_id(),
        ],
      ],
      '#empty' => $this
        ->t('No session available.'),
    ];
    $output['data'] = $this->dumper
      ->exportAsRenderable($_SESSION);
    return $output;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route.
ControllerBase::state	protected	function	Returns the state storage service.
DevelController::$dumper	protected	property	The dumper service.
DevelController::$entityTypeBundleInfo	protected	property	The entity type bundle info service.
DevelController::$fieldTypeManager	protected	property	The field type plugin manager service.
DevelController::$formatterPluginManager	protected	property	The field formatter plugin manager.
DevelController::$widgetPluginManager	protected	property	The field widget plugin manager.
DevelController::cacheClear	public	function	Clears all caches, then redirects to the previous page.
DevelController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
DevelController::fieldInfoPage	public	function	Builds the fields info overview page.
DevelController::session	public	function	Builds the session overview page.
DevelController::stateSystemPage	public	function	Builds the state variable overview page.
DevelController::themeRegistry	public	function	Theme registry.
DevelController::__construct	public	function	EntityDebugController constructor.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.