abstract class RecurringPeriodBase in Recurring Time Period 8

Base class for recurring period plugins.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\recurring_period\Plugin\RecurringPeriod\RecurringPeriodBase implements ContainerFactoryPluginInterface, RecurringPeriodInterface uses StringTranslationTrait

Expanded class hierarchy of RecurringPeriodBase

File

src/Plugin/RecurringPeriod/RecurringPeriodBase.php, line 17

Namespace

Drupal\recurring_period\Plugin\RecurringPeriod

View source

abstract class RecurringPeriodBase extends PluginBase implements ContainerFactoryPluginInterface, RecurringPeriodInterface {
  use StringTranslationTrait;

  /**
   * The Interval Plugin Manager service.
   *
   * @var \Drupal\interval\IntervalPluginManagerInterface
   */
  protected $pluginManagerIntervals;

  /**
   * Constructs a new plugin instance.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The pluginId for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\interval\IntervalPluginManagerInterface $plugin_manager_interval_intervals
   *   The Interval Plugin Manager service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, IntervalPluginManagerInterface $plugin_manager_interval_intervals) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this
      ->setConfiguration($configuration);
    $this->pluginManagerIntervals = $plugin_manager_interval_intervals;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.interval.intervals'));
  }

  /**
   * {@inheritdoc}
   */
  public function getLabel() {
    return $this->pluginDefinition['label'];
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->pluginDefinition['description'];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return $this->configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = NestedArray::mergeDeep($this
      ->defaultConfiguration(), $configuration);
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function calculateStart(\DateTimeImmutable $date) {
    return $date;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateEnd(\DateTimeImmutable $start) {

    // Call the deprecated method in the plugin class.
    // TODO: reverse this, so we implement the deprecated method.
    return $this
      ->calculateDate($start);
  }

  /**
   * {@inheritdoc}
   */
  public function getPeriodLabel(\DateTimeImmutable $start, \DateTimeImmutable $end) {
    return '';
  }

  /**
   * {@inheritdoc}
   */
  public function getPeriodFromDate(\DateTimeImmutable $start) {
    $end_date = $this
      ->calculateDate($start);
    $label = $this
      ->getPeriodLabel($start, $end_date);
    return new Period($start, $end_date, $label);
  }

  /**
   * {@inheritdoc}
   */
  public function getPeriodContainingDate(\DateTimeImmutable $date) {
    $start_date = $this
      ->calculateStart($date);
    $end_date = $this
      ->calculateDate($date);
    $label = $this
      ->getPeriodLabel($start_date, $end_date);
    return new Period($start_date, $end_date, $label);
  }

  /**
   * {@inheritdoc}
   */
  public function getNextPeriod(Period $period) {
    $end_date = $period
      ->getEndDate();
    return $this
      ->getPeriodFromDate($end_date);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
RecurringPeriodBase::$pluginManagerIntervals	protected	property	The Interval Plugin Manager service.
RecurringPeriodBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	3
RecurringPeriodBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
RecurringPeriodBase::calculateEnd	public	function	Calculates the end date and time for the period. Overrides RecurringPeriodInterface::calculateEnd	3
RecurringPeriodBase::calculateStart	public	function	Calculates the end of the previous period. Overrides RecurringPeriodInterface::calculateStart	3
RecurringPeriodBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RecurringPeriodBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	2
RecurringPeriodBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
RecurringPeriodBase::getDescription	public	function	Gets the plugin description. Overrides RecurringPeriodInterface::getDescription
RecurringPeriodBase::getLabel	public	function	Gets the plugin label. Overrides RecurringPeriodInterface::getLabel
RecurringPeriodBase::getNextPeriod	public	function	Calculates the period after the given period. Overrides RecurringPeriodInterface::getNextPeriod
RecurringPeriodBase::getPeriodContainingDate	public	function	Gets a period object that contains the given date. Overrides RecurringPeriodInterface::getPeriodContainingDate
RecurringPeriodBase::getPeriodFromDate	public	function	Gets a period object that begins on a given date. Overrides RecurringPeriodInterface::getPeriodFromDate
RecurringPeriodBase::getPeriodLabel	public	function	Gets a label for the period starting from the given date. Overrides RecurringPeriodInterface::getPeriodLabel	1
RecurringPeriodBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
RecurringPeriodBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	2
RecurringPeriodBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
RecurringPeriodBase::__construct	public	function	Constructs a new plugin instance. Overrides PluginBase::__construct
RecurringPeriodInterface::calculateDate Deprecated	public	function	Calculates the end date and time for the period.	3
RecurringPeriodInterface::UNLIMITED		constant	Represents an unlimited end time.
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.

You are here

abstract class RecurringPeriodBase in Recurring Time Period 8

Hierarchy

File

Namespace

Members

API Navigation