class OverviewForm in Admin Audit Trail 1.0.x

Configure user settings for this site.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\admin_audit_trail\OverviewForm implements ContainerInjectionInterface

File

src/OverviewForm.php, line 20

Namespace

Drupal\admin_audit_trail

class OverviewForm extends FormBase implements ContainerInjectionInterface {

  /**
   * The request object.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Overview form construct.
   *
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack object.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(RequestStack $request_stack, EntityTypeManagerInterface $entity_type_manager) {
    $this->requestStack = $request_stack;
    $this->entityTypeManager = $entity_type_manager;
  }

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

  /**
   * Filters.
   *
   * @var array
   *  The form filters
   */
  private $filters = [];

  /**
   * Get User data.
   *
   * @param int $uid
   *   The user ID.
   *
   * @return Drupal\Core\Link
   *   The internal link for the user.
   */
  private function getUserData($uid) {
    if (empty($uid)) {
      return Markup::create('<em>' . $this
        ->t('Anonymous') . '</em>');
    }
    $account = $this->entityTypeManager
      ->getStorage('user')
      ->load($uid);
    if (empty($account)) {
      return Markup::create('<em>' . $this
        ->t('@uid (deleted)', [
        '@uid' => $uid,
      ]) . '<em>');
    }
    return Link::fromTextAndUrl($account
      ->getDisplayname(), Url::fromUri('internal:/user/' . $account
      ->id()));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['filters'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Filters'),
      '#description' => $this
        ->t('Filter the events.'),
      '#open' => TRUE,
    ];
    $handlers = admin_audit_trail_get_event_handlers();
    $options = [];
    foreach ($handlers as $type => $handler) {
      $options[$type] = $handler['title'];
    }
    $form['filters']['type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Type'),
      '#description' => $this
        ->t('Event type'),
      '#options' => [
        '' => $this
          ->t('Select a type'),
      ] + $options,
      '#ajax' => [
        'callback' => '::formGetAjaxOperation',
        'event' => 'change',
      ],
    ];
    $form['filters']['operation'] = AdminAuditTrailStorage::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'),
      '#description' => $this
        ->t('The user that triggered this event.'),
      '#size' => 30,
      '#maxlength' => 60,
    ];
    $form['filters']['id'] = [
      '#type' => 'textfield',
      '#size' => 5,
      '#title' => $this
        ->t('ID'),
      '#description' => $this
        ->t('The id of the events (numeric).'),
    ];
    $form['filters']['ip'] = [
      '#type' => 'textfield',
      '#size' => 20,
      '#title' => $this
        ->t('IP'),
      '#description' => $this
        ->t('The ip address of the visitor.'),
    ];
    $form['filters']['name'] = [
      '#type' => 'textfield',
      '#size' => 10,
      '#title' => $this
        ->t('Name'),
      '#description' => $this
        ->t('The name or machine name.'),
    ];
    $form['filters']['path'] = [
      '#type' => 'textfield',
      '#size' => 30,
      '#title' => $this
        ->t('Path'),
      '#description' => $this
        ->t('keyword in the path.'),
    ];
    $form['filters']['keyword'] = [
      '#type' => 'textfield',
      '#size' => 10,
      '#title' => $this
        ->t('Description'),
      '#description' => $this
        ->t('Keyword in the description.'),
    ];
    $form['filters']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    ];
    $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',
      ],
    ];
    $this
      ->getFiltersFromUrl($form);
    $result = AdminAuditTrailStorage::getSearchData($this->filters, $header, 20);
    if (!empty($this->filters)) {
      $form['filters']['reset'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Reset'),
        '#limit_validation_errors' => [],
        '#submit' => [
          '::resetForm',
        ],
      ];
    }
    $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',
      '#parameters' => $this->filters,
    ];
    $form['results'] = $build;
    return $form;
  }

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

  /**
   * 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([]);
    $this->filters = [];
  }

  /**
   * Retrieves form filters from the URL.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   */
  public function getFiltersFromUrl(array &$form) {
    $url_params = $this->requestStack
      ->getCurrentRequest()->query
      ->all();
    if (!empty($url_params)) {
      unset($url_params['page']);
      $this->filters = $url_params;
      foreach ($this->filters as $field => $value) {
        if ($field === "user") {
          $user = $this->entityTypeManager
            ->getStorage('user')
            ->load($value);
          $form['filters'][$field]['#default_value'] = $user;
        }
        else {
          $form['filters'][$field]['#default_value'] = $value;
        }
      }
    }
  }

  /**
   * Stores form filters in the URL.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function setFilters(FormStateInterface $form_state) {
    $this->filters = [];
    $values = $form_state
      ->getValues();
    foreach ($values as $field => $value) {
      if ($field === 'submit') {
        break;
      }
      elseif (isset($value) && $value !== "") {
        $this->filters[$field] = $value;
      }
    }
    $this->requestStack
      ->getCurrentRequest()->query
      ->replace($this->filters);
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
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.	3
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.
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	72
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
OverviewForm::$entityTypeManager	protected	property	The entity type manager.
OverviewForm::$filters	private	property	Filters.
OverviewForm::$requestStack	protected	property	The request object. Overrides FormBase::$requestStack
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::getFiltersFromUrl	public	function	Retrieves form filters from the URL.
OverviewForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
OverviewForm::getUserData	private	function	Get User data.
OverviewForm::resetForm	public	function	Resets all the states of the form.
OverviewForm::setFilters	public	function	Stores form filters in the URL.
OverviewForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
OverviewForm::__construct	public	function	Overview form construct.
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.	4
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.