You are here

Home » API reference » Object Log 8 » ObjectLogController.php

class ObjectLogController in Object Log 8

Contains callbacks for Object Log routes.

Hierarchy

Expanded class hierarchy of ObjectLogController

File

src/Controller/ObjectLogController.php, line 22
Contains \Drupal\object_log\Controller\ObjectLogController.

Namespace

Drupal\object_log\Controller
View source 
class ObjectLogController extends ControllerBase {

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

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

  /**
   * The form builder service.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

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

  /**
   * ObjectLogController constructor.
   *
   * @param Connection $database
   *   The database connection service.
   * @param DateFormatter $date_formatter
   *   The date service.
   * @param FormBuilderInterface $form_builder
   *   The form builder service.
   */
  public function __construct(Connection $database, DateFormatter $date_formatter, FormBuilderInterface $form_builder) {
    $this->database = $database;
    $this->dateFormatter = $date_formatter;
    $this->formBuilder = $form_builder;
  }

  /**
   * Prepares a table listing of stored objects.
   * .
   * @return array
   *   A Drupal render array.
   */
  public function listing() {
    $rows = array();
    $header = array(
      array(
        'data' => $this
          ->t('Label'),
        'field' => 'ol.label',
      ),
      array(
        'data' => $this
          ->t('Date'),
        'field' => 'ol.created',
        'sort' => 'desc',
      ),
    );
    $query = $this->database
      ->select('object_log', 'ol')
      ->extend('\\Drupal\\Core\\Database\\Query\\PagerSelectExtender')
      ->extend('\\Drupal\\Core\\Database\\Query\\TableSortExtender');
    $query
      ->fields('ol', array(
      'label',
      'created',
    ));
    $result = $query
      ->limit(25)
      ->orderByHeader($header)
      ->execute();
    foreach ($result as $item) {
      $rows[] = array(
        Link::fromTextAndUrl($item->label, Url::fromRoute('object_log.object', array(
          'label' => $item->label,
        ))),
        $this->dateFormatter
          ->format($item->created, 'short'),
      );
    }
    $build = array(
      'object_log' => array(
        '#theme' => 'table',
        '#header' => $header,
        '#rows' => $rows,
        '#attributes' => array(
          'id' => 'object_log',
        ),
        '#empty' => t('No variables stored.'),
      ),
      'object_log_pager' => array(
        '#type' => 'pager',
      ),
      'clear_form' => $this->formBuilder
        ->getForm('\\Drupal\\object_log\\Form\\ObjectLogClearLogForm'),
    );
    return $build;
  }

  /**
   * Display a stored object.
   *
   * @param string $label
   *   The name associated with the stored object.
   *
   * @return array
   *   A Drupal render array.
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   */
  public function objectDetails($label) {
    $log = object_log_retrieve($label);
    if (!$log) {
      throw new NotFoundHttpException();
    }
    $object = $log->data;
    $build = array(
      '#type' => 'container',
      '#attributes' => array(
        'class' => array(
          'object_wrapper',
        ),
      ),
    );
    $build['title'] = array(
      '#plain_text' => $label,
      '#prefix' => '<h4 class="object-label">',
      '#suffix' => '</h4>',
    );
    $build['object'] = array(
      '#type' => 'markup',
      '#markup' => kpr($object, TRUE, NULL),
      '#prefix' => '<div class="object">',
      '#suffix' => '</div>',
    );
    $build['listing'] = $this
      ->listing();
    return $build;
  }

}

Members

Namesort descending 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::$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.
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.
ObjectLogController::$database protected property The database connection service.
ObjectLogController::$dateFormatter protected property The date service.
ObjectLogController::$formBuilder protected property The form builder service. Overrides ControllerBase::$formBuilder
ObjectLogController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ObjectLogController::listing public function Prepares a table listing of stored objects. .
ObjectLogController::objectDetails public function Display a stored object.
ObjectLogController::__construct public function ObjectLogController constructor.
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.