class PluginController in Plugin 8

Provides content for dialog tests.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\plugin\Controller\PluginController

Expanded class hierarchy of PluginController

File

src/Controller/pluginController.php, line 21: Contains \Drupal\plugin\PluginController.

Namespace

Drupal\plugin\Controller

View source

class PluginController extends ControllerBase {

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('class_loader'));
  }

  /**
   * Constructs a SystemInfoController object.
   *
   * @param \Drupal\system\SystemManager $systemManager
   *   System manager service.
   */
  public function __construct(ClassLoader $class_loader) {
    $this->classLoader = $class_loader;
  }

  /**
   * Returns example content for dialog testing.
   */
  public function pluginSourceCode($service_id, $plugin_id) {
    try {
      $definitions = \Drupal::service($service_id)
        ->getDefinitions();
    } catch (\Exception $e) {
      throw new NotFoundHttpException();
    }
    if (isset($definitions[$plugin_id])) {
      $definition = $definitions[$plugin_id];
    }
    else {
      throw new NotFoundHttpException();
    }

    // Some classes stats with '\'.
    $class = ltrim($definition['class'], '\\');
    $file = $this->classLoader
      ->findFile($class);

    //drupal_set_title($path);
    $build['#title'] = $class;
    $build['#markup'] = highlight_file($file, TRUE);
    return $build;
  }

  /**
   *
   */
  public function overview() {
    $header = [
      [
        'data' => t('ID'),
        'class' => 'plugin-id',
      ],
      [
        'data' => t('Module'),
        'class' => 'plugin-module',
      ],
      [
        'data' => t('Description'),
        'class' => 'plugin-description',
      ],
      [
        'data' => t('Actions'),
        'class' => 'plugin-actions',
      ],
    ];

    // Is there a better way to find all available plugins?
    foreach (\Drupal::getContainer()
      ->getServiceIds() as $serviceId) {
      if (strpos($serviceId, 'plugin.manager') === 0) {
        $rows = [];
        $definitions = \Drupal::service($serviceId)
          ->getDefinitions();
        foreach ($definitions as $id => $plugin_definition) {
          $description = [];
          $description['wrapper'] = [
            '#type' => 'details',
            '#title' => t('Definition'),
            '#collapsed' => TRUE,
          ];
          $description['wrapper']['definition']['#markup'] = $this
            ->array2ul($plugin_definition);
          list(, $module) = explode('\\', $plugin_definition['class']);
          $attributes = [
            'class' => [
              'use-ajax',
            ],
            'data-accepts' => 'application/vnd.drupal-modal',
            'data-dialog-options' => json_encode([
              'height' => 700,
              'width' => 1000,
            ]),
          ];
          $url = Url::fromRoute('plugin.source_code', [
            'service_id' => $serviceId,
            'plugin_id' => $id,
          ], [
            'attributes' => $attributes,
          ]);
          $action = [
            '#markup' => \Drupal::l(t('View source'), $url, []),
          ];
          $rows[] = [
            $id,
            $module,
            render($description),
            render($action),
          ];
        }
        $build['services'][$serviceId] = [
          '#type' => 'details',
          '#title' => str_replace('plugin.manager.', '', $serviceId) . ' (' . count($definitions) . ')',
          '#collapsed' => TRUE,
          '#attributes' => [
            'class' => [
              'plugins-wrapper',
            ],
          ],
        ];
        $build['services'][$serviceId]['plugins'] = [
          '#theme' => 'table',
          '#header' => $header,
          '#rows' => $rows,
          '#empty' => t('No plugins available.'),
        ];
      }
    }
    $build['#attached']['library'][] = 'core/drupal.ajax';
    $build['#attached']['library'][] = 'plugin/plugin.overview';
    return $build;
  }

  /**
   * Convert a multi-level array to UL list.
   */
  protected function array2ul($array) {
    $output = '<ul>';
    foreach ($array as $key => $value) {
      if (is_object($value)) {
        continue;
      }
      $value = is_array($value) ? $this
        ->array2ul($value) : String::checkPlain($value);
      $output .= "<li><b>{$key}:</b> <em>{$value}</em></li>";
    }
    return $output . '</ul>';
  }

}

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::$entityManager	protected	property	The entity manager.
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::entityManager Deprecated	protected	function	Retrieves the entity manager service.
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. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginController::array2ul	protected	function	Convert a multi-level array to UL list.
PluginController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
PluginController::overview	public	function
PluginController::pluginSourceCode	public	function	Returns example content for dialog testing.
PluginController::__construct	public	function	Constructs a SystemInfoController object.
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.	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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class PluginController in Plugin 8

Hierarchy

File

Namespace

Members

API Navigation