You are here

Home » API reference » Weather 2.0.x » WeatherUserConfiguredDisplayController.php

class WeatherUserConfiguredDisplayController in Weather 2.0.x

Same name and namespace in other branches
  1. 8 src/Controller/WeatherUserConfiguredDisplayController.php \Drupal\weather\Controller\WeatherUserConfiguredDisplayController

Returns responses for Weather routes.

Hierarchy

Expanded class hierarchy of WeatherUserConfiguredDisplayController

File

src/Controller/WeatherUserConfiguredDisplayController.php, line 20

Namespace

Drupal\weather\Controller
View source 
class WeatherUserConfiguredDisplayController extends ControllerBase {

  /**
   * The weather.helper service.
   *
   * @var \Drupal\weather\Service\HelperService
   */
  protected $weatherHelper;

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

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The controller constructor.
   *
   * @param \Drupal\weather\Service\HelperService $weather_helper
   *   The weather.helper service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity.type_manager service.
   * @param \Drupal\Core\Render\Renderer $renderer
   *   The renderer service.
   */
  public function __construct(HelperService $weather_helper, EntityTypeManagerInterface $entity_type_manager, Renderer $renderer) {
    $this->weatherHelper = $weather_helper;
    $this->entityTypeManager = $entity_type_manager;
    $this->renderer = $renderer;
  }

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

  /**
   * Builds the response.
   */
  public function content(UserInterface $user) {
    $output = [];
    $weatherDisplayPlaceStorage = $this->entityTypeManager
      ->getStorage('weather_display_place');
    $header = [
      $this
        ->t('Displayed name'),
      $this
        ->t('Weight'),
    ];
    $rows = [];
    $result = $weatherDisplayPlaceStorage
      ->getQuery()
      ->condition('display_type', WeatherDisplayInterface::USER_TYPE)
      ->condition('display_number', $user
      ->id())
      ->sort('weight', 'ASC')
      ->sort('displayed_name', 'ASC')
      ->execute();
    if ($result) {
      foreach ($weatherDisplayPlaceStorage
        ->loadMultiple($result) as $location) {
        $rows[] = [
          Link::createFromRoute($location->displayed_name->value, 'weather.user.weather_display_place.edit_form', [
            'user' => $user
              ->id(),
            'weather_display_place' => $location
              ->id(),
          ]),
          $location->weight->value,
        ];
        $this->renderer
          ->addCacheableDependency($output, $location);
      }
    }
    $output["#cache"]["tags"][] = 'weather_display:' . $user
      ->id();

    // Insert link for adding locations into the table as last row.
    $rows[] = [
      [
        'data' => Link::createFromRoute($this
          ->t('Add location to this display'), 'weather.user.weather_display_place.add_form', [
          'user' => $user
            ->id(),
        ]),
        'colspan' => 2,
      ],
    ];
    $output['table'] = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
    ];

    // Generate link to Add or Edit user's weather display.
    $url = Url::fromRoute('weather.user.weather_display.add_form', [
      'user' => $user
        ->id(),
    ]);
    $output['edit_display'] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Edit configuration of display'),
      '#url' => $url,
    ];
    return $output;
  }

  /**
   * Checks access for a specific request.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Run access checks for this account.
   * @param \Drupal\user\UserInterface $user
   *   The user.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   */
  public function access(AccountInterface $account, UserInterface $user) {
    return AccessResult::allowedIf($user
      ->id() == $account
      ->id() && $account
      ->hasPermission('administer custom weather block'));
  }

}

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::$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.
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.
WeatherUserConfiguredDisplayController::$entityTypeManager protected property The entity.type_manager service. Overrides ControllerBase::$entityTypeManager
WeatherUserConfiguredDisplayController::$renderer protected property The renderer service.
WeatherUserConfiguredDisplayController::$weatherHelper protected property The weather.helper service.
WeatherUserConfiguredDisplayController::access public function Checks access for a specific request.
WeatherUserConfiguredDisplayController::content public function Builds the response.
WeatherUserConfiguredDisplayController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
WeatherUserConfiguredDisplayController::__construct public function The controller constructor.