class DatexBlock in Datex 8

Provides a block to show a localized current/relative date.

@Block ( id = "datex_block", admin_label=

Plugin annotation


@Translation("Datex Block"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
    class \Drupal\datex\Plugin\Block\DatexBlock

Expanded class hierarchy of DatexBlock

File

src/Plugin/Block/DatexBlock.php, line 16

Namespace

Drupal\datex\Plugin\Block

View source

class DatexBlock extends BlockBase {
  public function defaultConfiguration() {
    return [
      'cal' => 'persian',
      'fmt' => 'Y/m/d H:i:s',
      'tz' => 'user',
      'text' => '{}',
    ];
  }
  public function blockForm($form, FormStateInterface $form_state) {
    $f = parent::blockForm($form, $form_state);

    // Retrieve existing configuration for this block.
    $cfg = $this
      ->getConfiguration();
    $cfg = [
      'cal' => isset($cfg['cal']) ? $cfg['cal'] : 'persian',
      'fmt' => isset($cfg['fmt']) ? $cfg['fmt'] : 'Y/m/d H:i:s',
      'tz' => isset($cfg['tz']) ? $cfg['tz'] : 'user',
      'text' => isset($cfg['text']) ? $cfg['text'] : '{}',
      'cache' => isset($cfg['cache']) ? $cfg['cache'] : 3600,
    ];
    $f['datex_calendar'] = [
      '#title' => t('Calendar'),
      '#type' => 'select',
      '#options' => _datex_available_calendars(),
      '#default_value' => $cfg['cal'],
    ];
    $f['datex_format'] = [
      '#title' => t('Date/Time format'),
      '#type' => 'textfield',
      '#description' => 'TODO add medium short and ... See php.net/manual/en/function.date.php for date formats',
      '#default_value' => $cfg['fmt'],
    ];
    $f['datex_timezone'] = [
      '#title' => t('Timezone'),
      '#type' => 'select',
      '#options' => [
        'site' => t("Use site's timezone"),
        'user' => t("Use user's timezone"),
      ] + system_time_zones(),
      '#default_value' => $cfg['tz'],
    ];
    $f['datex_text'] = [
      '#title' => t('Content'),
      '#type' => 'textfield',
      '#description' => t('The blocks content. {} is replaced with the actual date. If unsure, leave this field empty or set it to {}'),
      '#default_value' => $cfg['text'],
    ];
    $f['datex_cache'] = [
      '#title' => t('Cache lifetime'),
      '#type' => 'textfield',
      '#description' => t('How long the block should be cached, in seconds'),
      '#default_value' => $cfg['cache'],
    ];
    return $f;
  }
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this
      ->setConfigurationValue('fmt', $form_state
      ->getValue('datex_fmt'));
    $this
      ->setConfigurationValue('cal', $form_state
      ->getValue('datex_calendar'));
    $this
      ->setConfigurationValue('tz', $form_state
      ->getValue('datex_tz'));
    if (strpos($form_state
      ->getValue('datex_text'), '{}') < 0) {
      drupal_set_message(t('Invalid content, content set to {}'), 'warning');
      $this
        ->setConfigurationValue('text', '{}');
    }
    else {
      $this
        ->setConfigurationValue('text', $form_state
        ->getValue('datex_text'));
    }
    $c = $form_state
      ->getValue('datex_cache');
    if ($c !== '' && is_numeric($c) && $c >= 0) {
      $this
        ->setConfigurationValue('cache', $form_state
        ->getValue('datex_cache'));
    }
    else {
      drupal_set_message('block cache time set to one hour');
      $this
        ->setConfigurationValue('cache', 3600);
    }
  }
  public function getCacheMaxAge() {
    $config = $this
      ->getConfiguration();
    return isset($config['cache']) ? $config['cache'] : 3600;
  }
  public function build() {
    $cfg = $this
      ->getConfiguration();
    $cfg = [
      'cal' => isset($cfg['cal']) ? $cfg['cal'] : 'persian',
      'fmt' => isset($cfg['fmt']) ? $cfg['fmt'] : 'Y/m/d H:i:s',
      'tz' => isset($cfg['tz']) ? $cfg['tz'] : 'user',
      'text' => isset($cfg['text']) ? $cfg['text'] : '{}',
    ];
    switch ($cfg['tz']) {
      case 'site':
        $config = \Drupal::config('system.date');
        $config_data_default_timezone = $config
          ->get('timezone.default');
        $tz = !empty($config_data_default_timezone) ? $config_data_default_timezone : @date_default_timezone_get();
        break;
      case 'user':
        $tz = \drupal_get_user_timezone();
        break;
      default:
        $tz = $cfg['tz'];
    }
    $calendar = datex_factory($tz, NULL, $cfg['cal']);
    $content = str_replace('{}', $calendar
      ->format($cfg['fmt']), $cfg['text']);
    return [
      '#markup' => $content,
    ];
  }

}

Members

Name	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::blockValidate	public	function		3
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::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
BlockPluginTrait::__construct	public	function		22
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::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.
DatexBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
DatexBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
DatexBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
DatexBlock::defaultConfiguration	public	function	Overrides BlockPluginTrait::defaultConfiguration
DatexBlock::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides ContextAwarePluginBase::getCacheMaxAge
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

You are here

class DatexBlock in Datex 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation