You are here

Home » API reference » OAuth2 Client 8.3 » Oauth2ClientPluginList.php

class Oauth2ClientPluginList in OAuth2 Client 8.3

Provides a OAuth2 Client form.

Hierarchy

Expanded class hierarchy of Oauth2ClientPluginList

1 string reference to 'Oauth2ClientPluginList'
oauth2_client.routing.yml in ./oauth2_client.routing.yml
oauth2_client.routing.yml

File

src/Form/Oauth2ClientPluginList.php, line 14

Namespace

Drupal\oauth2_client\Form
View source 
class Oauth2ClientPluginList extends FormBase {

  /**
   * The Drupal state api.
   *
   * @var \Drupal\oauth2_client\PluginManager\Oauth2ClientPluginManager
   */
  protected $pluginManager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->pluginManager = $container
      ->get('oauth2_client.plugin_manager');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'oauth2_client_oauth2_client_plugin_list';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $header = [
      [
        'data' => $this
          ->t('Name'),
        'field' => 'name',
        'sort' => 'desc',
      ],
      [
        'data' => $this
          ->t('Grant Type'),
        'field' => 'grant_type',
        'class' => [
          RESPONSIVE_PRIORITY_MEDIUM,
        ],
      ],
      [
        'data' => $this
          ->t('Operations'),
      ],
    ];
    $definitions = $this->pluginManager
      ->getDefinitions();
    $rows = [];
    foreach ($definitions as $definition) {
      $url = Url::fromRoute('oauth2_client.oauth2_client_plugin_config', [
        'plugin' => $definition['id'],
      ]);
      $link = Link::fromTextAndUrl($this
        ->t('Configure'), $url);
      $rows[] = [
        'data' => [
          [
            'data' => $definition['name'],
          ],
          [
            'data' => $definition['grant_type'],
          ],
          [
            'data' => $link
              ->toRenderable() + [
              '#attributes' => [
                'class' => [
                  'button',
                ],
              ],
            ],
          ],
        ],
      ];
    }
    $form['oauth2_clients'] = [
      '#type' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No clients available.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // This method is never called and is here for interface compatibility.
    $this
      ->messenger()
      ->addStatus($this
      ->t('To configure a client, click the "Configure" button.'));
  }

}

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
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
Oauth2ClientPluginList::$pluginManager protected property The Drupal state api.
Oauth2ClientPluginList::buildForm public function Form constructor. Overrides FormInterface::buildForm
Oauth2ClientPluginList::create public static function Instantiates a new instance of this class. Overrides FormBase::create
Oauth2ClientPluginList::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
Oauth2ClientPluginList::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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.