You are here

Home » API reference » Copyright Footer 2.x » CopyrightFooter.php

class CopyrightFooter in Copyright Footer 2.x

Same name and namespace in other branches
  1. 8 src/Plugin/Block/CopyrightFooter.php \Drupal\copyright_footer\Plugin\Block\CopyrightFooter

Copyright Footer module for Block.

@Block ( id = "copyright_footer", admin_label =

Plugin annotation


@Translation("Copyright Footer"),
  category = @Translation("Custom")
)

Hierarchy

Expanded class hierarchy of CopyrightFooter

File

src/Plugin/Block/CopyrightFooter.php, line 24
Contains \Drupal\copyright_footer\Plugin\Block\CopyrightFooter.

Namespace

Drupal\copyright_footer\Plugin\Block
View source 
class CopyrightFooter extends BlockBase {

  /**
   * A version.
   *
   * @var string
   */
  public const VERSION = '2.x-dev';

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() : array {
    return [
      'organization_name' => '',
      'organization_url' => '',
      'year_origin' => '',
      'year_to_date' => '',
      'version' => '',
      'version_url' => '',
      'label_display' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) : array {
    $form['organization_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Organization name'),
      '#default_value' => $this->configuration['organization_name'],
    ];
    $form['organization_url'] = [
      '#type' => 'url',
      '#title' => $this
        ->t('Organization URL'),
      '#description' => $this
        ->t('Leave blank if not necessary.'),
      '#default_value' => $this->configuration['organization_url'],
    ];
    $form['year_origin'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Year origin from'),
      '#description' => $this
        ->t('Leave blank if not necessary.'),
      '#default_value' => $this->configuration['year_origin'],
    ];
    $date = new \DateTime();
    $form['year_to_date'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Year to date'),
      '#description' => $this
        ->t('Leave blank then the current year (@year) automatically shows up.', [
        '@year' => $date
          ->format('Y'),
      ]),
      '#default_value' => $this->configuration['year_to_date'],
    ];
    $form['version'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Version'),
      '#description' => $this
        ->t('Leave blank if not necessary.'),
      '#default_value' => $this->configuration['version'],
    ];
    $form['version_url'] = [
      '#type' => 'url',
      '#title' => $this
        ->t('Version URL'),
      '#description' => $this
        ->t('Leave blank if not necessary. It works w/ the version number above.') . $this
        ->t("If you don't input the version number, this field will be simply ignored."),
      '#default_value' => $this->configuration['version_url'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) : void {
    $this->configuration['organization_name'] = $form_state
      ->getValue('organization_name');
    $this->configuration['organization_url'] = $form_state
      ->getValue('organization_url');
    $this->configuration['year_origin'] = $form_state
      ->getValue('year_origin');
    $this->configuration['year_to_date'] = $form_state
      ->getValue('year_to_date');
    $this->configuration['version'] = $form_state
      ->getValue('version');
    $this->configuration['version_url'] = $form_state
      ->getValue('version_url');
  }

  /**
   * {@inheritdoc}
   */
  public function build() : array {
    $date = new \DateTime();

    // From $year_to_date to Present.
    $year_to_date = empty($this->configuration['year_to_date']) ? $date
      ->format('Y') : $this->configuration['year_to_date'];

    // Organization.
    $organization = $this->configuration['organization_name'];

    // Organization w/ URL.
    if (!empty($organization) && !empty($this->configuration['organization_url'])) {
      $url = Url::fromUri($this->configuration['organization_url']);
      $organization = Link::fromTextAndUrl($this->configuration['organization_name'], $url)
        ->toString();
    }

    // Version.
    $version = $this->configuration['version'];
    if (!empty($version)) {

      // Version only.
      $version = $this
        ->t('ver.@version', [
        '@version' => $version,
      ]);

      // Version w/ URL.
      if ($this->configuration['version_url']) {
        $url = Url::fromUri($this->configuration['version_url']);
        $version = $this
          ->t('ver.@version', [
          '@version' => Link::fromTextAndUrl($this->configuration['version'], $url)
            ->toString(),
        ]);
      }
    }
    $year = $date
      ->format('Y');
    return empty($this->configuration['year_origin']) || "{$this->configuration['year_origin']}" === $year ? [
      '#type' => 'markup',
      '#markup' => $this
        ->t('Copyright © @year @organization @version', [
        '@year' => $year,
        '@organization' => $organization,
        '@version' => $version,
      ]),
    ] : [
      '#type' => 'markup',
      '#markup' => $this
        ->t('Copyright © @year_origin-@year_to_date @organization @version', [
        '@year_origin' => $this->configuration['year_origin'],
        '@year_to_date' => $year_to_date,
        '@organization' => $organization,
        '@version' => $version,
      ]),
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
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. Aliased as: traitBuildConfigurationForm
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 24
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract protected function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
CopyrightFooter::blockForm public function Overrides BlockPluginTrait::blockForm
CopyrightFooter::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
CopyrightFooter::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
CopyrightFooter::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration
CopyrightFooter::VERSION public constant A version.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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::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 Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
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.