You are here

Home » API reference » Events Log Track 8.2 » OverviewForm.php

class OverviewForm in Events Log Track 8.2

Same name and namespace in other branches
  1. 8 src/OverviewForm.php \Drupal\event_log_track\OverviewForm

Configure user settings for this site.

Hierarchy

Expanded class hierarchy of OverviewForm

File

src/OverviewForm.php, line 18

Namespace

Drupal\event_log_track
View source 
class OverviewForm extends FormBase {

  /**
   * The user storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $userStorage;

  /**
   * Constructs a new OverviewForm.
   *
   * @param \Drupal\Core\Entity\EntityStorageInterface $user_storage
   *   The custom block storage.
   */
  public function __construct(EntityStorageInterface $user_storage) {
    $this->userStorage = $user_storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $entity_type_manager = $container
      ->get('entity_type.manager');
    return new static($entity_type_manager
      ->getStorage('user'));
  }

  /**
   * Return user link.
   */
  private function getUserData($uid) {
    if (empty($uid)) {
      return Markup::create('<em>' . $this
        ->t('Anonymous') . '</em>');
    }
    $account = $this->userStorage
      ->load($uid);
    if (empty($account)) {
      return Markup::create('<em>' . $this
        ->t('@uid (deleted)', [
        '@uid' => $uid,
      ]) . '<em>');
    }
    return Link::fromTextAndUrl($account
      ->getUsername(), Url::fromUri('internal:/user/' . $account
      ->id()));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['filters'] = [
      '#prefix' => '<div class="container-inline">',
      '#type' => 'details',
      '#title' => $this
        ->t('Filter'),
      '#open' => TRUE,
    ];
    $form['#attached']['library'][] = 'event_log_track/log_filter_form';
    $handlers = event_log_track_get_event_handlers();
    $options = [];
    foreach ($handlers as $type => $handler) {
      $options[$type] = $handler['title'];
    }
    $form['filters']['type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Event Type'),
      '#options' => [
        '' => $this
          ->t('Select a type'),
      ] + $options,
      '#ajax' => [
        'callback' => '::formGetAjaxOperation',
        'event' => 'change',
      ],
    ];
    $form['filters']['operation'] = EventLogStorage::formGetOperations(empty($form_state
      ->getUserInput()['type']) ? '' : $form_state
      ->getUserInput()['type']);
    $form['filters']['user'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'user',
      '#selection_settings' => [
        'include_anonymous' => FALSE,
      ],
      '#title' => $this
        ->t('User'),
      '#placeholder' => $this
        ->t('User who triggered this event.'),
      '#size' => 30,
      '#maxlength' => 60,
    ];
    $form['filters']['id'] = [
      '#type' => 'textfield',
      '#size' => 30,
      '#title' => $this
        ->t('ID'),
      '#placeholder' => $this
        ->t('Id of the events (numeric).'),
    ];
    $form['filters']['ip'] = [
      '#type' => 'textfield',
      '#size' => 30,
      '#title' => $this
        ->t('IP'),
      '#placeholder' => $this
        ->t('IP address of the visitor.'),
    ];
    $form['filters']['name'] = [
      '#type' => 'textfield',
      '#size' => 30,
      '#title' => $this
        ->t('Name'),
      '#placeholder' => $this
        ->t('Name or machine name.'),
    ];
    $form['filters']['path'] = [
      '#type' => 'textfield',
      '#size' => 30,
      '#title' => $this
        ->t('Path'),
      '#placeholder' => $this
        ->t('keyword in the path.'),
    ];
    $form['filters']['keyword'] = [
      '#type' => 'textfield',
      '#size' => 30,
      '#title' => $this
        ->t('Description'),
      '#placeholder' => $this
        ->t('Keyword in the description.'),
      '#suffix' => '</div>',
    ];
    $form['filters']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Filter'),
    ];
    if (!empty($form_state
      ->getUserInput())) {
      $form['filters']['reset'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Reset'),
        '#limit_validation_errors' => [],
        '#submit' => [
          '::resetForm',
        ],
      ];
    }
    $header = [
      [
        'data' => $this
          ->t('Updated'),
        'field' => 'created',
        'sort' => 'desc',
      ],
      [
        'data' => $this
          ->t('Type'),
        'field' => 'type',
      ],
      [
        'data' => $this
          ->t('Operation'),
        'field' => 'operation',
      ],
      [
        'data' => $this
          ->t('Path'),
        'field' => 'path',
      ],
      [
        'data' => $this
          ->t('Description'),
        'field' => 'description',
      ],
      [
        'data' => $this
          ->t('User'),
        'field' => 'uid',
      ],
      [
        'data' => $this
          ->t('IP'),
        'field' => 'ip',
      ],
      [
        'data' => $this
          ->t('ID'),
        'field' => 'ref_numeric',
      ],
      [
        'data' => $this
          ->t('Name'),
        'field' => 'ref_char',
      ],
    ];
    $formData = !empty($form_state
      ->getUserInput()) ? $form_state
      ->getUserInput() : [];
    $limit = 20;
    $result = EventLogStorage::getSearchData($formData, $header, $limit);
    $rows = [];
    foreach ($result as $record) {
      $userLink = $this
        ->getUserData($record->uid);
      $rows[] = [
        [
          'data' => date("Y-m-d H:i:s", $record->created),
        ],
        [
          'data' => $record->type,
        ],
        [
          'data' => $record->operation,
        ],
        [
          'data' => $record->path,
        ],
        [
          'data' => strip_tags($record->description),
        ],
        [
          'data' => $userLink,
        ],
        [
          'data' => $record->ip,
        ],
        [
          'data' => $record->ref_numeric,
        ],
        [
          'data' => $record->ref_char,
        ],
      ];
    }

    // Generate the table.
    $build['config_table'] = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No events found.'),
    ];

    // Finally add the pager.
    $build['pager'] = [
      '#type' => 'pager',
    ];
    $form['results'] = $build;
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->disableRedirect();
    $form_state
      ->setRebuild();
  }

  /**
   * Resets all the states of the form.
   *
   * This method is called when the "Reset" button is triggered. Clears
   * user inputs and the form state.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function resetForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setRedirect('<current>');
    $form_state
      ->setValues([]);
  }

  /**
   * Ajax callback for the operations options.
   */
  public function formGetAjaxOperation(array &$form, FormStateInterface $form_state) {
    $ajax_response = new AjaxResponse();
    $element = EventLogStorage::formGetOperations($form_state
      ->getValue('type'));
    $ajax_response
      ->addCommand(new HtmlCommand('#operation-dropdown-replace', $element));
    return $ajax_response;
  }

}

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.
OverviewForm::$userStorage protected property The user storage.
OverviewForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
OverviewForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
OverviewForm::formGetAjaxOperation public function Ajax callback for the operations options.
OverviewForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
OverviewForm::getUserData private function Return user link.
OverviewForm::resetForm public function Resets all the states of the form.
OverviewForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
OverviewForm::__construct public function Constructs a new OverviewForm.
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.