You are here

class RoleExpirationForm in Ubercart 8.4

Menu callback for viewing expirations.

Hierarchy

Expanded class hierarchy of RoleExpirationForm

1 string reference to 'RoleExpirationForm'
uc_role.routing.yml in uc_role/uc_role.routing.yml
uc_role/uc_role.routing.yml

File

uc_role/src/Form/RoleExpirationForm.php, line 15

Namespace

Drupal\uc_role\Form
View source
class RoleExpirationForm extends FormBase {

  /**
   * The date.formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * Form constructor.
   *
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date.formatter service.
   */
  public function __construct(DateFormatterInterface $date_formatter) {
    $this->dateFormatter = $date_formatter;
  }

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

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [];
  }

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

    // Create the header for the pager.
    $header = [
      [
        'data' => $this
          ->t('Username'),
        'field' => 'u.name',
      ],
      [
        'data' => $this
          ->t('Role'),
        'field' => 'e.rid',
      ],
      [
        'data' => $this
          ->t('Expiration date'),
        'field' => 'e.expiration',
        'sort' => 'asc',
      ],
      [
        'data' => $this
          ->t('Operations'),
        'colspan' => 2,
      ],
    ];

    // Grab all the info to build the pager.
    $query = \Drupal::database()
      ->select('uc_roles_expirations', 'e')
      ->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender')
      ->extend('Drupal\\Core\\Database\\Query\\TableSortExtender')
      ->fields('e')
      ->limit(50)
      ->orderByHeader($header);
    $query
      ->join('users', 'u', 'e.uid = u.uid');
    $query
      ->fields('u');
    $results = $query
      ->execute();

    // Stick the expirations into the form.
    $rows = [];
    foreach ($results as $result) {
      $account = User::load($result
        ->id());

      // Each row has username, role, expiration, and edit/delete operations.
      $row = [
        'username' => $account
          ->getUsername(),
        'role' => _uc_role_get_name($result->rid),
        'expiration' => $this->dateFormatter
          ->format($result->expiration, 'short'),
      ];
      $ops = [];
      $ops['edit'] = [
        'title' => $this
          ->t('Edit'),
        'url' => Url::fromRoute('entity.user.edit_form', [
          'user' => $result
            ->id(),
        ], [
          'fragment' => 'role-expiration-' . $result->rid,
          'query' => [
            'destination' => 'admin/people/expiration',
          ],
        ]),
      ];
      $ops['delete'] = [
        'title' => $this
          ->t('Delete'),
        'url' => Url::fromRoute('uc_role.expiration', [
          'user' => $result
            ->id(),
          'role' => $result->rid,
        ]),
      ];
      $row['ops'] = [
        'data' => [
          '#type' => 'operations',
          '#links' => $ops,
        ],
      ];
      $rows[] = $row;
    }
    $form['roles_table'] = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No expirations set to occur'),
    ];
    return $form;
  }

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

}

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.
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.
RoleExpirationForm::$dateFormatter protected property The date.formatter service.
RoleExpirationForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
RoleExpirationForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
RoleExpirationForm::getEditableConfigNames protected function
RoleExpirationForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RoleExpirationForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
RoleExpirationForm::__construct public function Form constructor.
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.