class InviteList in Invite 8

Active user list controller.

Hierarchy

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

Expanded class hierarchy of InviteList

File

src/Controller/InviteList.php, line 14

Namespace

Drupal\invite\Controller

View source

class InviteList extends ControllerBase {

  /**
   * Drupal\Core\Database\Driver\mysql\Connection definition.
   *
   * @var \Drupal\Core\Database\Driver\mysql\Connection
   */
  protected $database;

  /**
   * An array that contains invite status and related user readable name.
   *
   * @var array
   */
  public $inviteStatus;

  /**
   * Constructs a new InviteList object.
   *
   * @param \Drupal\Core\Database\Connection $database
   *   Connection database.
   */
  public function __construct(Connection $database) {
    $this->database = $database;
    $this->inviteStatus = [
      InviteConstants::INVITE_VALID => $this
        ->t('Active'),
      InviteConstants::INVITE_WITHDRAWN => $this
        ->t('Withdrawn'),
      InviteConstants::INVITE_USED => $this
        ->t('Used'),
      InviteConstants::INVITE_EXPIRED => $this
        ->t('Expired'),
    ];
  }

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

  /**
   * Returns the active user list output.
   *
   * @return array
   *   A renderable array.
   */
  public function view() {
    $header = [
      [
        'data' => $this
          ->t('Status'),
      ],
      [
        'data' => $this
          ->t('Sender'),
      ],
      [
        'data' => $this
          ->t('E-mail'),
      ],
      [
        'data' => $this
          ->t('Operations'),
      ],
    ];
    $query = $this->database
      ->select('invite', 'i');
    $query
      ->fields('ufd', [
      'mail',
    ]);
    $query
      ->fields('i', [
      'id',
      'status',
    ]);
    $query
      ->fields('ie', [
      'field_invite_email_address_value',
    ]);
    $query
      ->leftJoin('users', 'u', 'i.user_id = u.uid');
    $query
      ->leftJoin('users_field_data', 'ufd', 'u.uid = ufd.uid');
    $query
      ->leftJoin('invite__field_invite_email_address', 'ie', 'i.id = ie.entity_id');
    $query
      ->orderBy('i.id', 'desc');
    $query = $query
      ->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender');
    $query
      ->limit(20);
    $result = $query
      ->execute();
    $rows = [];
    foreach ($result as $row) {
      $operations = [
        '#type' => 'operations',
        '#links' => $this
          ->getOperations($row->id),
        '#attributes' => [],
      ];
      $rows[] = [
        'data' => [
          'status' => $this->inviteStatus[$row->status],
          'mail' => $row->mail,
          'field_invite_email_address_value' => $row->field_invite_email_address_value,
          'operations' => render($operations),
        ],
      ];
    }
    $output['table'] = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
    ];
    $output['pager'] = [
      '#type' => 'pager',
    ];
    return $output;
  }

  /**
   * Get operations links like withdraw and resend invitation.
   *
   * @param int $invitation_id
   *   Invite entity id (invite id).
   *
   * @return array
   *   Array of withdraw and resend links.
   */
  public function getOperations($invitation_id) {
    $links[] = [
      'title' => $this
        ->t('Withdraw'),
      'url' => Url::fromRoute('invite.invite_withdraw_form', [
        'invite' => $invitation_id,
      ]),
    ];
    $links[] = [
      'title' => $this
        ->t('Resend'),
      'url' => Url::fromRoute('invite.invite_resend_form', [
        'invite' => $invitation_id,
      ]),
    ];
    return $links;
  }

}

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.
InviteList::$database	protected	property	Drupal\Core\Database\Driver\mysql\Connection definition.
InviteList::$inviteStatus	public	property	An array that contains invite status and related user readable name.
InviteList::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
InviteList::getOperations	public	function	Get operations links like withdraw and resend invitation.
InviteList::view	public	function	Returns the active user list output.
InviteList::__construct	public	function	Constructs a new InviteList object.
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.
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 InviteList in Invite 8

Hierarchy

File

Namespace

Members

API Navigation