class LogController in TacJS 8.5

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\tacjs\Controller\LogController

File

src/Controller/LogController.php, line 9

Namespace

Drupal\tacjs\Controller

class LogController extends ControllerBase {

  /**
   * The database connection object.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * Constructs a DbLog object.
   *
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection object.
   */
  public function __construct(Connection $connection) {
    $this->connection = $connection;
  }

  /**
   * Store proof of consent.
   *
   * @param int $service_key
   *   Unique ID of the service.
   *
   * @return array
   *   Empty Array.
   *
   * @throws \Exception
   */
  public function log($service_key) {
    try {
      $this->connection
        ->insert('tacjslog')
        ->fields([
        'timestamp' => \Drupal::time()
          ->getCurrentTime(),
        'ip_address' => \Drupal::request()
          ->getClientIp(),
        'services_allowed' => $service_key,
      ])
        ->execute();
    } catch (\Exception $e) {
      throw $e;
    }
    return new JsonResponse([
      'timestamp' => \Drupal::time()
        ->getCurrentTime(),
      'ip_address' => \Drupal::request()
        ->getClientIp(),
      'services_allowed' => $service_key,
    ]);
  }

  /**
   * Displays a listing of database logs.
   *
   * @return array
   *   A render array as expected by
   *   \Drupal\Core\Render\RendererInterface::render().
   *
   * @throws \Exception
   */
  public function overview() {
    $rows = [];
    $header = [
      [
        'data' => $this
          ->t('Timestamp'),
        'field' => 'log.timestamp',
        'sort' => 'desc',
      ],
      [
        'data' => $this
          ->t('IP address'),
        'field' => 'log.ip_address',
      ],
      [
        'data' => $this
          ->t('Services allowed'),
        'field' => 'log.services_allowed',
      ],
    ];
    try {
      $sth = $this->connection
        ->select('tacjslog', 'log')
        ->extend('\\Drupal\\Core\\Database\\Query\\PagerSelectExtender')
        ->extend('\\Drupal\\Core\\Database\\Query\\TableSortExtender')
        ->fields('log', [
        'timestamp',
        'ip_address',
        'services_allowed',
      ]);

      // Execute the statement
      $data = $sth
        ->limit(50)
        ->orderByHeader($header)
        ->execute();

      // Get all the results
      $results = $data
        ->fetchAll(\PDO::FETCH_OBJ);
    } catch (\Exception $e) {
      throw $e;
    }
    foreach ($results as $result) {
      $rows[] = [
        'data' => [
          \Drupal::service('date.formatter')
            ->format($result->timestamp, 'short'),
          $result->ip_address,
          $result->services_allowed,
        ],
      ];
    }
    $build['tacjslog_table'] = [
      '#type' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No log available.'),
    ];
    $build['tacjslog_pager'] = [
      '#type' => 'pager',
    ];
    return $build;
  }

}

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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	40
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.
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.
LogController::$connection	protected	property	The database connection object.
LogController::log	public	function	Store proof of consent.
LogController::overview	public	function	Displays a listing of database logs.
LogController::__construct	public	function	Constructs a DbLog object.
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.