You are here

Home » API reference » Wunderground weather 8 » WeatherHourlyBlock.php

class WeatherHourlyBlock in Wunderground weather 8

Provides a with an hourly weather forecast.

Plugin annotation


@Block(
 id = "wunderground_weather_hourly_block",
 admin_label = @Translation("Weather hourly block")
)

Hierarchy

Expanded class hierarchy of WeatherHourlyBlock

File

src/Plugin/Block/WeatherHourlyBlock.php, line 24
Contains \Drupal\wunderground_weather\Plugin\Block\WeatherHourlyBlock.

Namespace

Drupal\wunderground_weather\Plugin\Block
View source 
class WeatherHourlyBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * Methods to make an API call and tool to handle the output.
   *
   * @var \Drupal\wunderground_weather\WundergroundWeatherManager
   */
  protected $wundergroundWeatherManager;

  /**
   * WeatherHourlyBlock constructor.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\wunderground_weather\WundergroundWeatherManager $wunderground_weather_manager
   *   Methods to make an API call and tool to handle the output.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, WundergroundWeatherManager $wunderground_weather_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->wundergroundWeatherManager = $wunderground_weather_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /** @var \Drupal\wunderground_weather\WundergroundWeatherManager $wunderground_weather_manager */
    $wunderground_weather_manager = $container
      ->get('wunderground_weather.manager');
    return new static($configuration, $plugin_id, $plugin_definition, $wunderground_weather_manager);
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $config = $this
      ->getConfiguration();
    $form['location'] = [
      '#type' => 'fieldset',
      '#title' => t('Location'),
    ];

    // Autocomplete to get location.
    $form['location']['location'] = [
      '#title' => t('Location path'),
      '#type' => 'textfield',
      '#description' => t('Search for your city to determine the Wunderground location path.'),
      '#maxlength' => 120,
      '#required' => TRUE,
      '#autocomplete_route_name' => 'wunderground_weather.autocomplete',
      '#default_value' => isset($config['location']) ? $config['location'] : '',
    ];
    $form['temperature_scale'] = [
      '#title' => t('Show temperature in'),
      '#type' => 'radios',
      '#options' => [
        'c' => t('Celsius'),
        'f' => t('Fahrenheit'),
      ],
      '#default_value' => empty($this->configuration['temperature_scale']) ? 'c' : $this->configuration['temperature_scale'],
    ];
    $form['windspeed_scale'] = [
      '#title' => t('Show wind speed in'),
      '#type' => 'radios',
      '#options' => [
        'bft' => t('Beaufort'),
        'mph' => t('Miles per hour'),
        'kph' => t('Kilometers per hour'),
      ],
      '#default_value' => isset($config['windspeed_scale']) ? $config['windspeed_scale'] : 'bft',
    ];
    $settings_forecast_defaults = [
      'image' => 'image',
      'conditions' => 'conditions',
      'temperature' => 'temperature',
      'rain' => 'rain',
      'wind' => 'wind',
    ];
    $form['used_fields'] = [
      '#title' => t('Fields'),
      '#type' => 'checkboxes',
      '#options' => $this
        ->getAvailableFields(),
      '#default_value' => isset($config['forecast_fields']) ? $config['forecast_fields'] : $settings_forecast_defaults,
    ];
    $form['number_of_hours'] = [
      '#title' => t('How many hours would you like to display'),
      '#description' => t('You can display up to 36 hours'),
      '#type' => 'number',
      '#default_value' => isset($config['number_of_hours']) ? $config['number_of_hours'] : 3,
      '#size' => 2,
      '#maxlength' => 2,
      '#required' => TRUE,
    ];
    $icons = [];
    foreach (range('a', 'k') as $set) {
      $icons[$set] = $this->wundergroundWeatherManager
        ->getIconSetSample($set);
    }
    $form['icon_set'] = [
      '#titel' => t('Select an icons set'),
      '#type' => 'radios',
      '#options' => $icons,
      '#default_value' => isset($config['icon_set']) ? $config['icon_set'] : 'k',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockValidate($form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue([
      'number_of_hours',
    ]) > 36) {
      $form_state
        ->setErrorByName('number_of_hours', $this
        ->t('You cannot display more than 36 hours'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this
      ->setConfigurationValue('location', $form_state
      ->getValue([
      'location',
      'location',
    ]));
    $this
      ->setConfigurationValue('temperature_scale', $form_state
      ->getValue([
      'temperature_scale',
    ]));
    $this
      ->setConfigurationValue('windspeed_scale', $form_state
      ->getValue([
      'windspeed_scale',
    ]));
    $this
      ->setConfigurationValue('used_fields', $form_state
      ->getValue([
      'used_fields',
    ]));
    $this
      ->setConfigurationValue('number_of_hours', $form_state
      ->getValue([
      'number_of_hours',
    ]));
    $this
      ->setConfigurationValue('icon_set', $form_state
      ->getValue([
      'icon_set',
    ]));
  }

  /**
   * {@inheritdoc}
   */
  public function build() {

    // Get block configuration.
    $config = $this
      ->getConfiguration();
    $location = $config['location'];
    $used_fields = $config['used_fields'];
    $available_fields = $this
      ->getAvailableFields();

    // Get all settings.
    $settings = $this->wundergroundWeatherManager
      ->getSettings();
    preg_match('#\\[(.*?)\\]#', $location, $match);
    $path = $match[1];
    $options = [
      'api' => 'api',
      'key' => $settings
        ->get('api_key'),
      'data_feature' => 'hourly',
      'language' => 'lang:' . strtoupper($settings
        ->get('language')),
      'path' => $path,
    ];
    $data = $this->wundergroundWeatherManager
      ->requestData($options);
    $rows = [];
    $hours = isset($data->hourly_forecast) ? $data->hourly_forecast : [];
    if ($hours) {
      foreach ($hours as $i => $hour) {
        if ($i >= $config['number_of_hours']) {
          break;
        }
        $row['data']['hour'] = $hour->FCTTIME->hour . ':' . $hour->FCTTIME->min;
        foreach ($used_fields as $field) {
          if ($field) {
            $row['data'][$field] = call_user_func([
              $this,
              'get' . ucfirst($field),
            ], $hour);
          }
        }
        $rows[] = $row;
      }
    }
    $header[] = t('Hours');
    foreach ($used_fields as $used_field) {
      if ($used_field) {
        $header[] = $available_fields[$used_field];
      }
    }
    return [
      '#type' => 'table',
      '#header' => $header,
      '#rows' => $rows,
    ];
  }

  /**
   * An array of available fields to display.
   *
   * @return array
   *   An array of available fields.
   */
  protected function getAvailableFields() {
    return [
      'image' => t('Weather icons'),
      'conditions' => t('Weather description'),
      'temperature' => t('Temperature'),
      'rain' => t('Chance of rain'),
      'wind' => t('Wind speed'),
    ];
  }

  /**
   * Render a weather icon image.
   *
   * @param \stdClass $hour
   *   The hour for that holds the icon variable.
   *
   * @return string|null
   *   The rendered element.
   */
  protected function getImage(\stdClass $hour) {
    $config = $this
      ->getConfiguration();
    $icon = [
      '#theme' => 'image',
      '#uri' => $this->wundergroundWeatherManager
        ->getIconUrl($config['icon_set'], $hour->icon),
      '#alt' => $hour->condition,
    ];
    return render($icon);
  }

  /**
   * Get the weather conditions for a specific hour.
   *
   * @param \stdClass $hour
   *   The hour for that holds the condition variable.
   *
   * @return string
   *   A string representing a weather condition.
   */
  protected function getConditions(\stdClass $hour) {
    return $hour->condition;
  }

  /**
   * Get a formatted temperature string.
   *
   * @param \stdClass $hour
   *   The hour for that holds the temperature variable.
   *
   * @return string
   *   A formatted temperature
   */
  protected function getTemperature(\stdClass $hour) {
    $config = $this
      ->getConfiguration();
    $temp = $config['temperature_scale'] === 'c' ? $hour->temp->metric : $hour->temp->english;
    return $temp . '°' . strtoupper($config['temperature_scale']);
  }

  /**
   * Get the change of rain.
   *
   * @param \stdClass $hour
   *   The hour for that holds the pop variable.
   *
   * @return string
   *   The change of rain for a specific hour.
   */
  protected function getRain(\stdClass $hour) {
    return $hour->pop . '%';
  }

  /**
   * Get the wind speed for a specific hour.
   *
   * @param \stdClass $hour
   *   The hour for that holds the wind speed variable.
   *
   * @return string
   *   The windspeed in bft
   *
   */
  protected function getWind(\stdClass $hour) {
    $config = $this
      ->getConfiguration();
    $windspeed_scale = $config['windspeed_scale'];
    switch ($windspeed_scale) {
      case 'mph':
        $windspeed = $hour->wspd->english;
        break;
      case 'kph':
        $windspeed = $hour->wspd->metric;
        break;
      default:
        $wind_kph = $hour->wspd->metric;
        $windspeed = $this->wundergroundWeatherManager
          ->windSpeedToBeaufort($wind_kph, 'kph');
        break;
    }
    return $windspeed . ' ' . $windspeed_scale;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess protected function Indicates whether the block should be shown. 16
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. 2
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::defaultConfiguration public function 19
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). 1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 9
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass public function
PluginWithFormsTrait::hasFormClass public function
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.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2
WeatherHourlyBlock::$wundergroundWeatherManager protected property Methods to make an API call and tool to handle the output.
WeatherHourlyBlock::blockForm public function Overrides BlockPluginTrait::blockForm
WeatherHourlyBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
WeatherHourlyBlock::blockValidate public function Overrides BlockPluginTrait::blockValidate
WeatherHourlyBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
WeatherHourlyBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
WeatherHourlyBlock::getAvailableFields protected function An array of available fields to display.
WeatherHourlyBlock::getConditions protected function Get the weather conditions for a specific hour.
WeatherHourlyBlock::getImage protected function Render a weather icon image.
WeatherHourlyBlock::getRain protected function Get the change of rain.
WeatherHourlyBlock::getTemperature protected function Get a formatted temperature string.
WeatherHourlyBlock::getWind protected function Get the wind speed for a specific hour.
WeatherHourlyBlock::__construct public function WeatherHourlyBlock constructor. Overrides BlockPluginTrait::__construct