class CalendarPager in Calendar 8.2

Same name and namespace in other branches

8 src/Plugin/views/pager/CalendarPager.php \Drupal\calendar\Plugin\views\pager\CalendarPager

The plugin to handle calendar pager.

Plugin annotation


@ViewsPager(
  id = "calendar",
  title = @Translation("Calendar Pager"),
  short_title = @Translation("Calendar"),
  help = @Translation("Calendar Pager"),
  theme = "calendar_pager",
  register_theme = FALSE
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
    class \Drupal\views\Plugin\views\pager\PagerPluginBase
    class \Drupal\calendar\Plugin\views\pager\CalendarPager implements ContainerFactoryPluginInterface

Expanded class hierarchy of CalendarPager

File

src/Plugin/views/pager/CalendarPager.php, line 31

Namespace

Drupal\calendar\Plugin\views\pager

View source

class CalendarPager extends PagerPluginBase implements ContainerFactoryPluginInterface {
  const NEXT = '+';
  const PREVIOUS = '-';

  /**
   * Calendar argument.
   *
   * @var string
   */
  protected $argument;

  /**
   * The style info for this calendar.
   *
   * @var \Drupal\Calendar\CalendarStyleInfo
   *   The calendar style info object.
   */
  protected $styleInfo;

  /**
   * DI CalendarHelper class.
   *
   * @var \Drupal\Calendar\CalendarHelper
   */
  protected $calendarHelper;

  /**
   * Extends the Date instance with CalendarHelper.
   *
   * @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\Calendar\CalendarHelper $calendarHelper
   *   Calendar helper service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, $calendarHelper) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->calendarHelper = $calendarHelper;
  }

  /**
   * Create function for Date query
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The service container.
   * @param array $configuration
   *   The configuration.
   * @param string $plugin_id
   *   The plugin.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @return static
   *
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('calendar.helper'));
  }

  /**
   * {@inheritdoc}
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);
    $this->styleInfo =& $this->view->styleInfo;
  }

  /**
   * {@inheritdoc}
   */
  public function render($input) {
    $calendar_arguments = CalendarHelper::getCalendarArguments($this->view);
    foreach ($calendar_arguments as $date_argument) {
      if ($date_argument['argument']) {
        $items['previous'] = [
          'url' => $this
            ->getPagerUrl($date_argument, self::PREVIOUS, $input),
        ];
        $items['next'] = [
          'url' => $this
            ->getPagerUrl($date_argument, self::NEXT, $input),
        ];
      }
    }
    return [
      '#theme' => $this
        ->themeFunctions(),
      '#items' => $items,
      '#exclude' => $this->options['exclude_display'],
    ];
  }

  /**
   * Get the href value for the pager link.
   *
   * @param string $date_argument
   *   The string used as the contextual filter.
   * @param string $mode
   *   Either '-' or '+' to determine which direction.
   * @param array $input
   *   Any extra GET parameters that should be retained, such as exposed
   *   input.
   * @TODO fix this
   *
   * @throws \Exception
   *
   * @return string
   *   An url containing a link.
   */
  protected function getPagerUrl($date_argument, $mode, array $input) {

    // @TODO add format to $date_argument array?
    $format = reset($this->view->argument)
      ->getArgFormat();
    if ($format == 'YW') {
      $new = new \DateTime();
      $year = (int) substr($date_argument['argument'], 0, 4);
      $month = (int) substr($date_argument['argument'], 4, 2);
      $new
        ->setISODate($year, $month);
    }
    else {
      $new = \DateTime::createFromFormat($format, $date_argument['argument']);
    }
    $new
      ->modify($mode . '1 ' . $this->styleInfo
      ->getGranularity());
    $value = $new
      ->format($format);
    $current_position = 0;
    $arg_vals = [];

    /**
     * @var \Drupal\views\Plugin\views\argument\ArgumentPluginBase $handler
     */
    foreach ($this->view->argument as $name => $argument) {
      if (!$argument instanceof Date) {
        $arg_vals["arg_{$current_position}"] = $argument
          ->getValue();
      }
      else {
        $arg_vals["arg_{$current_position}"] = $value;
      }
      $current_position++;
    }
    return $this->view
      ->getUrl($arg_vals, $this->view->current_display);
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['exclude_display'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Exclude from Display'),
      '#default_value' => $this->options['exclude_display'],
      '#description' => $this
        ->t('Use this option if you only want to display the pager in Calendar Header area.'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['exclude_display'] = [
      'default' => FALSE,
    ];
    return $options;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CalendarPager::$argument	protected	property	Calendar argument.
CalendarPager::$calendarHelper	protected	property	DI CalendarHelper class.
CalendarPager::$styleInfo	protected	property	The style info for this calendar.
CalendarPager::buildOptionsForm	public	function	Provide a form to edit options for this plugin. Overrides PluginBase::buildOptionsForm
CalendarPager::create	public static	function	Create function for Date query Overrides PluginBase::create
CalendarPager::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. Overrides PluginBase::defineOptions
CalendarPager::getPagerUrl	protected	function	Get the href value for the pager link.
CalendarPager::init	public	function	Initialize the plugin. Overrides PluginBase::init
CalendarPager::NEXT		constant
CalendarPager::PREVIOUS		constant
CalendarPager::render	public	function	Return the renderable array of the pager. Overrides PagerPluginBase::render
CalendarPager::__construct	public	function	Extends the Date instance with CalendarHelper. Overrides PluginBase::__construct
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.
PagerPluginBase::$current_page	public	property
PagerPluginBase::$total_items	public	property
PagerPluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
PagerPluginBase::executeCountQuery	public	function	Execute the count query, which will be done just prior to the query itself being executed.	1
PagerPluginBase::exposedFormAlter	public	function		1
PagerPluginBase::exposedFormSubmit	public	function
PagerPluginBase::exposedFormValidate	public	function		1
PagerPluginBase::getCurrentPage	public	function	Get the current page.
PagerPluginBase::getItemsPerPage	public	function	Get how many items per page this pager will display.	1
PagerPluginBase::getOffset	public	function	Get the page offset, or how many items to skip.
PagerPluginBase::getPagerId	public	function	Get the pager id, if it exists
PagerPluginBase::getTotalItems	public	function	Get the total number of items.
PagerPluginBase::hasMoreRecords	public	function	Determine if there are more records available.
PagerPluginBase::isOffsetExposed	protected	function		1
PagerPluginBase::itemsPerPageExposed	protected	function		1
PagerPluginBase::postExecute	public	function	Perform any needed actions just after the query executing.	2
PagerPluginBase::preExecute	public	function	Perform any needed actions just prior to the query executing.
PagerPluginBase::preRender	public	function	Perform any needed actions just before rendering.
PagerPluginBase::query	public	function	Modify the query for paging Overrides PluginBase::query	3
PagerPluginBase::setCurrentPage	public	function	Set the current page.	1
PagerPluginBase::setItemsPerPage	public	function	Set how many items per page this pager will display.
PagerPluginBase::setOffset	public	function	Set the page offset, or how many items to skip.
PagerPluginBase::submitOptionsForm	public	function	Provide the default form form for submitting options Overrides PluginBase::submitOptionsForm
PagerPluginBase::summaryTitle	public	function	Return a string to display as the clickable title for the pager plugin. Overrides PluginBase::summaryTitle	4
PagerPluginBase::updatePageInfo	public	function	If there are pagers that need global values set, this method can be used to set them. It will be called after the query is run.	1
PagerPluginBase::useCountQuery	public	function	Determine if a pager needs a count query.	3
PagerPluginBase::usePager	public	function	Determine if this pager actually uses a pager.	2
PagerPluginBase::usesExposed	public	function		1
PagerPluginBase::validateOptionsForm	public	function	Provide the default form form for validating options Overrides PluginBase::validateOptionsForm	1
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$definition	public	property	Plugins's definition
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$renderer	protected	property	Stores the render API renderer.	3
PluginBase::$view	public	property	The top object of a view.	1
PluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	14
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy	public	function	Clears a plugin. Overrides ViewsPluginInterface::destroy	2
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function	Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getProvider	public	function	Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer	protected	function	Returns the render API renderer.	1
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY		constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED		constant	Include negotiated languages when listing languages.
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function	Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup	public static	function	Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData	public static	function	Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions	public static	function	Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions	1
PluginBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks	6
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions	public	function	Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions	8
PluginBase::validate	public	function	Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate	6
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.	1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
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.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.

You are here

class CalendarPager in Calendar 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation