class DateItemProcessor in Facets 8

Provides a processor for dates.

Plugin annotation


@FacetsProcessor(
  id = "date_item",
  label = @Translation("Date item processor"),
  description = @Translation("Display dates with granularity options for date fields."),
  stages = {
    "build" = 35
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\facets\Processor\ProcessorPluginBase implements ProcessorInterface uses DependencyTrait
    class \Drupal\facets\Plugin\facets\processor\DateItemProcessor implements BuildProcessorInterface

Expanded class hierarchy of DateItemProcessor

File

src/Plugin/facets/processor/DateItemProcessor.php, line 23

Namespace

Drupal\facets\Plugin\facets\processor

View source

class DateItemProcessor extends ProcessorPluginBase implements BuildProcessorInterface {

  /**
   * {@inheritdoc}
   */
  public function build(FacetInterface $facet, array $results) {
    return $results;
  }

  /**
   * Human readable array of granularity options.
   *
   * @return array
   *   An array of granularity options.
   */
  private function granularityOptions() {
    return [
      SearchApiDate::FACETAPI_DATE_YEAR => $this
        ->t('Year'),
      SearchApiDate::FACETAPI_DATE_MONTH => $this
        ->t('Month'),
      SearchApiDate::FACETAPI_DATE_DAY => $this
        ->t('Day'),
      SearchApiDate::FACETAPI_DATE_HOUR => $this
        ->t('Hour'),
      SearchApiDate::FACETAPI_DATE_MINUTE => $this
        ->t('Minute'),
      SearchApiDate::FACETAPI_DATE_SECOND => $this
        ->t('Second', [], [
        'context' => 'timeperiod',
      ]),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state, FacetInterface $facet) {
    $this
      ->getConfiguration();
    $build['date_display'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Date display'),
      '#default_value' => $this
        ->getConfiguration()['date_display'],
      '#options' => [
        'actual_date' => $this
          ->t('Actual date with granularity'),
        'relative_date' => $this
          ->t('Relative date'),
      ],
    ];
    $build['granularity'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Granularity'),
      '#default_value' => $this
        ->getConfiguration()['granularity'],
      '#options' => $this
        ->granularityOptions(),
    ];
    $build['date_format'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Date format'),
      '#default_value' => $this
        ->getConfiguration()['date_format'],
      '#description' => $this
        ->t('Override default date format used for the displayed filter format. See the <a href="http://php.net/manual/function.date.php">PHP manual</a> for available options.'),
      '#states' => [
        'visible' => [
          ':input[name="facet_settings[date_item][settings][date_display]"]' => [
            'value' => 'actual_date',
          ],
        ],
      ],
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function getQueryType() {
    return 'date';
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'date_display' => 'actual_date',
      'granularity' => SearchApiDate::FACETAPI_DATE_MONTH,
      'date_format' => '',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DateItemProcessor::build	public	function	Runs before the renderable array is created. Overrides BuildProcessorInterface::build
DateItemProcessor::buildConfigurationForm	public	function	Adds a configuration form for this processor. Overrides ProcessorPluginBase::buildConfigurationForm
DateItemProcessor::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ProcessorPluginBase::defaultConfiguration
DateItemProcessor::getQueryType	public	function	Picks the preferred query type for this widget. Overrides ProcessorPluginBase::getQueryType
DateItemProcessor::granularityOptions	private	function	Human readable array of granularity options.
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
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
ProcessorInterface::STAGE_BUILD		constant	Processing stage: build.
ProcessorInterface::STAGE_POST_QUERY		constant	Processing stage: post_query.
ProcessorInterface::STAGE_PRE_QUERY		constant	Processing stage: pre_query.
ProcessorInterface::STAGE_SORT		constant	Processing stage: sort.
ProcessorPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ProcessorPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ProcessorPluginBase::getDefaultWeight	public	function	Returns the default weight for a specific processing stage. Overrides ProcessorInterface::getDefaultWeight
ProcessorPluginBase::getDescription	public	function	Retrieves the processor description. Overrides ProcessorInterface::getDescription
ProcessorPluginBase::isHidden	public	function	Determines whether this processor should be hidden from the user. Overrides ProcessorInterface::isHidden
ProcessorPluginBase::isLocked	public	function	Determines whether this processor should always be enabled. Overrides ProcessorInterface::isLocked
ProcessorPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ProcessorPluginBase::submitConfigurationForm	public	function
ProcessorPluginBase::supportsFacet	public	function	Checks if the facet is supported by this widget. Overrides ProcessorInterface::supportsFacet	6
ProcessorPluginBase::supportsStage	public	function	Checks whether this processor implements a particular stage. Overrides ProcessorInterface::supportsStage
ProcessorPluginBase::validateConfigurationForm	public	function	Validates a configuration form for this processor. Overrides ProcessorInterface::validateConfigurationForm	2
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

class DateItemProcessor in Facets 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation