class DbtngExampleController in Examples for Developers 3.x

Controller for DBTNG Example.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\dbtng_example\Controller\DbtngExampleController

Related topics

Example: Database (DBTNG)

Database examples, including DBTNG.

File

modules/dbtng_example/src/Controller/DbtngExampleController.php, line 14

Namespace

Drupal\dbtng_example\Controller

class DbtngExampleController extends ControllerBase {

  /**
   * The repository for our specialized queries.
   *
   * @var \Drupal\dbtng_example\DbtngExampleRepository
   */
  protected $repository;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $controller = new static($container
      ->get('dbtng_example.repository'));
    $controller
      ->setStringTranslation($container
      ->get('string_translation'));
    return $controller;
  }

  /**
   * Construct a new controller.
   *
   * @param \Drupal\dbtng_example\DbtngExampleRepository $repository
   *   The repository service.
   */
  public function __construct(DbtngExampleRepository $repository) {
    $this->repository = $repository;
  }

  /**
   * Render a list of entries in the database.
   */
  public function entryList() {
    $content = [];
    $content['message'] = [
      '#markup' => $this
        ->t('Generate a list of all entries in the database. There is no filter in the query.'),
    ];
    $rows = [];
    $headers = [
      $this
        ->t('Id'),
      $this
        ->t('uid'),
      $this
        ->t('Name'),
      $this
        ->t('Surname'),
      $this
        ->t('Age'),
    ];
    $entries = $this->repository
      ->load();
    foreach ($entries as $entry) {

      // Sanitize each entry.
      $rows[] = array_map('Drupal\\Component\\Utility\\Html::escape', (array) $entry);
    }
    $content['table'] = [
      '#type' => 'table',
      '#header' => $headers,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No entries available.'),
    ];

    // Don't cache this page.
    $content['#cache']['max-age'] = 0;
    return $content;
  }

  /**
   * Render a filtered list of entries in the database.
   */
  public function entryAdvancedList() {
    $content = [];
    $content['message'] = [
      '#markup' => $this
        ->t('A more complex list of entries in the database. Only the entries with name = "John" and age older than 18 years are shown, the username of the person who created the entry is also shown.'),
    ];
    $headers = [
      $this
        ->t('Id'),
      $this
        ->t('Created by'),
      $this
        ->t('Name'),
      $this
        ->t('Surname'),
      $this
        ->t('Age'),
    ];
    $rows = [];
    $entries = $this->repository
      ->advancedLoad();
    foreach ($entries as $entry) {

      // Sanitize each entry.
      $rows[] = array_map('Drupal\\Component\\Utility\\Html::escape', $entry);
    }
    $content['table'] = [
      '#type' => 'table',
      '#header' => $headers,
      '#rows' => $rows,
      '#attributes' => [
        'id' => 'dbtng-example-advanced-list',
      ],
      '#empty' => $this
        ->t('No entries available.'),
    ];

    // Don't cache this page.
    $content['#cache']['max-age'] = 0;
    return $content;
  }

}

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::$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::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.
ControllerBase::state	protected	function	Returns the state storage service.
DbtngExampleController::$repository	protected	property	The repository for our specialized queries.
DbtngExampleController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
DbtngExampleController::entryAdvancedList	public	function	Render a filtered list of entries in the database.
DbtngExampleController::entryList	public	function	Render a list of entries in the database.
DbtngExampleController::__construct	public	function	Construct a new controller.
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.
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.