class WeatherDetailedForecastController in Weather 8

Returns responses for Weather routes.

Hierarchy

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

File

src/Controller/WeatherDetailedForecastController.php, line 14

Namespace

Drupal\weather\Controller

class WeatherDetailedForecastController extends ControllerBase {

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

  /**
   * Display Place storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $displayPlaceStorage;

  /**
   * Weather Place storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $weatherPlaceStorage;

  /**
   * The controller constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
    $this->displayPlaceStorage = $this->entityTypeManager
      ->getStorage('weather_display_place');
    $this->weatherPlaceStorage = $this->entityTypeManager
      ->getStorage('weather_place');
  }

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

  /**
   * Builds the response for weather.detailed_forecast route.
   */
  public function detailedForecast(string $country, string $place, string $city, string $destination) {
    $link = $place . '/' . $city;
    $weatherPlace = $this->weatherPlaceStorage
      ->getQuery()
      ->condition('country', $country, 'LIKE')
      ->condition('link', $link, 'LIKE')
      ->execute();
    if ($weatherPlace) {
      $weatherPlace = $this->weatherPlaceStorage
        ->load(reset($weatherPlace));
    }

    // If the last part of the link contains an appended slash
    // and a number, this indicates the display configuration of
    // the system-wide display with the given number.
    $display_type = 'default';
    $display_number = 0;

    // Examine the last element of the link.
    if (preg_match('/^[0-9]+$/', $destination)) {

      // Use the system-wide display with the given number.
      $display_type = 'system-wide';
      $display_number = $destination;
    }
    elseif ($destination == 'u') {

      // Use the user's custom display.
      $display_type = 'user';
      $display_number = $this
        ->currentUser()
        ->id();
    }
    if ($weatherPlace instanceof WeatherPlaceInterface) {

      // Show detailed forecast only if Weather Place
      // was configured for the Display.
      $configured = $this->displayPlaceStorage
        ->getQuery()
        ->condition('geoid', $weatherPlace
        ->id())
        ->condition('display_type', $display_type)
        ->condition('display_number', $display_number)
        ->execute();
      if ($configured) {
        return [
          '#theme' => 'weather_detailed_forecast',
          '#weather_display_place' => $this->displayPlaceStorage
            ->load(reset($configured)),
          '#display_type' => $display_type,
          '#display_number' => $display_number,
        ];
      }
    }
    throw new NotFoundHttpException();
  }

}

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::$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::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.
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.
WeatherDetailedForecastController::$displayPlaceStorage	protected	property	Display Place storage.
WeatherDetailedForecastController::$entityTypeManager	protected	property	The entity type manager. Overrides ControllerBase::$entityTypeManager
WeatherDetailedForecastController::$weatherPlaceStorage	protected	property	Weather Place storage.
WeatherDetailedForecastController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
WeatherDetailedForecastController::detailedForecast	public	function	Builds the response for weather.detailed_forecast route.
WeatherDetailedForecastController::__construct	public	function	The controller constructor.