class EntityPager in Entity Pager 8

Same name in this branch

8 src/EntityPager.php \Drupal\entity_pager\EntityPager
8 src/Plugin/views/style/EntityPager.php \Drupal\entity_pager\Plugin\views\style\EntityPager

Same name and namespace in other branches

2.0.x src/Plugin/views/style/EntityPager.php \Drupal\entity_pager\Plugin\views\style\EntityPager

Style plugin to render a view for an Entity Pager.

Plugin annotation


@ViewsStyle(
  id = "entity_pager",
  title = @Translation("Entity Pager"),
  help = @Translation("Displays extra information on a Entity such as Next and Previous links."),
  theme = "entity_pager",
  display_types = { "normal" }
)

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\style\StylePluginBase
    class \Drupal\entity_pager\Plugin\views\style\EntityPager

Expanded class hierarchy of EntityPager

File

src/Plugin/views/style/EntityPager.php, line 23

Namespace

Drupal\entity_pager\Plugin\views\style

View source

class EntityPager extends StylePluginBase {

  /**
   * {@inheritdoc}
   */
  protected $usesRowPlugin = FALSE;

  /**
   * {@inheritdoc}
   */
  protected $usesRowClass = FALSE;

  /**
   * {@inheritdoc}
   */
  protected $usesFields = TRUE;

  /**
   * {@inheritdoc}
   */
  protected $usesOptions = TRUE;

  /**
   * Returns an array of default options for the entity pager.
   *
   * @return array
   *   The default options.
   */
  protected function getDefaultOptions() {
    return [
      'relationship' => NULL,
      'link_next' => 'next >',
      'link_prev' => '< prev',
      'link_all_url' => '<front>',
      'link_all_text' => 'Home',
      'display_all' => TRUE,
      'display_count' => TRUE,
      'show_disabled_links' => TRUE,
      'circular_paging' => FALSE,
      'log_performance' => TRUE,
    ];
  }

  /**
   * Returns a value for an option.
   *
   * @param string $name
   *   The option name.
   *
   * @return mixed
   *   The option value, falling back to the default.
   */
  protected function getOption($name) {
    $defaults = $this
      ->getDefaultOptions();
    return isset($this->options[$name]) ? $this->options[$name] : $defaults[$name];
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $defaults = $this
      ->getDefaultOptions();
    return parent::defineOptions() + [
      'relationship' => [
        'default' => $defaults['relationship'],
      ],
      'link_next' => [
        'default' => $defaults['link_next'],
      ],
      'link_prev' => [
        'default' => $defaults['link_prev'],
      ],
      'link_all_url' => [
        'default' => $defaults['link_all_url'],
      ],
      'link_all_text' => [
        'default' => $defaults['link_all_text'],
      ],
      'display_all' => [
        'default' => $defaults['display_all'],
      ],
      'display_count' => [
        'default' => $defaults['display_count'],
      ],
      'show_disabled_links' => [
        'default' => $defaults['show_disabled_links'],
      ],
      'circular_paging' => [
        'default' => $defaults['circular_paging'],
      ],
      'log_performance' => [
        'default' => $defaults['log_performance'],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $relationship_options = $this
      ->getRelationshipOptions();
    if (!empty($relationship_options)) {
      $form['relationship'] = [
        '#title' => $this
          ->t('Relationship'),
        '#description' => $this
          ->t('Optionally, select a relationship to link to the related entity.'),
        '#type' => 'select',
        '#options' => $relationship_options,
        '#empty_option' => $this
          ->t('None'),
        '#default_value' => $this
          ->getOption('relationship'),
      ];
    }
    $form['link_next'] = [
      '#title' => $this
        ->t('Next label'),
      '#description' => $this
        ->t('The text to display for the Next link. HTML is allowed.'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getOption('link_next'),
      '#maxlength' => NULL,
    ];
    $form['link_prev'] = [
      '#title' => $this
        ->t('Previous label'),
      '#description' => $this
        ->t('The text to display for the Previous link. HTML is allowed.'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getOption('link_prev'),
      '#maxlength' => NULL,
    ];
    $form['display_all'] = [
      '#title' => $this
        ->t('Display All link'),
      '#description' => $this
        ->t('Display a link to the parent page of all results.'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getOption('display_all'),
    ];
    $token_help = NULL;
    try {
      $token_help = Url::fromRoute('help.page.token')
        ->toString();
    } catch (RouteNotFoundException $e) {

      // Noop.
    }
    $example_list = [
      '#theme' => 'item_list',
      '#items' => [
        $this
          ->t('The URL of a Views listing page of the Entities.'),
        $this
          ->t('%front for the homepage', [
          '%front' => '<front>',
        ]),
        $token_help ? $this
          ->t('A <a href=":token_help">token</a> that relates to the Entity. (e.g. [node:edit-url]).', [
          ':token_help' => $token_help,
        ]) : $this
          ->t('A token that relates to the Entity. (e.g. [node:edit-url]).'),
        $this
          ->t('The token can also be an entity reference if the entity has one. (e.g. [node:field_company]).'),
      ],
    ];
    $examples = \Drupal::service('renderer')
      ->renderPlain($example_list);
    $form['link_all_url'] = [
      '#title' => $this
        ->t('All link URL'),
      '#description' => $this
        ->t('The URL of the listing page link. Examples:') . $examples,
      '#type' => 'textfield',
      '#default_value' => $this
        ->getOption('link_all_url'),
      '#maxlength' => NULL,
      '#states' => [
        'visible' => [
          ':input[name="style_options[display_all]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['link_all_text'] = [
      '#title' => $this
        ->t('All link label'),
      '#description' => $this
        ->t('The label text to display for the List All link. When an entity reference is used in the <strong>List All URL</strong> box above, just add the same entity reference in this box and the referenced entity title will automatically be displayed. HTML is allowed.'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getOption('link_all_text'),
      '#maxlength' => NULL,
      '#states' => [
        'visible' => [
          ':input[name="style_options[display_all]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['display_count'] = [
      '#title' => $this
        ->t('Display count'),
      '#description' => $this
        ->t('Display the number of records (e.g. 5 of 8)'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getOption('display_count'),
    ];
    $form['circular_paging'] = [
      '#title' => $this
        ->t('Circular paging'),
      '#description' => $this
        ->t('When the last item is active, link to first item and vice versa.'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getOption('circular_paging'),
    ];
    $form['show_disabled_links'] = [
      '#title' => $this
        ->t('Show disabled links'),
      '#description' => $this
        ->t('Show disabled next/prev links when on the first or last page.'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getOption('show_disabled_links'),
      '#states' => [
        'visible' => [
          ':input[name="style_options[circular_paging]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['log_performance'] = [
      '#title' => $this
        ->t('Log performance suggestions'),
      '#description' => $this
        ->t('Log performance suggestions to Watchdog, see: Reports > Recent log messages.'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getOption('log_performance'),
    ];
  }

  /**
   * Gets any relationships in the view as options.
   *
   * @return string[]
   *   Array of relationships, keyed by ID with the values of their Admin label.
   */
  protected function getRelationshipOptions() {
    $executable = $this->view;
    $relationships = $executable->display_handler
      ->getOption('relationships');
    $options = [];
    if (!empty($relationships)) {
      foreach ($relationships as $relationship) {
        $options[$relationship['id']] = $relationship['admin_label'];
      }
    }
    return $options;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
EntityPager::$usesFields	protected	property	Does the style plugin for itself support to add fields to its output. Overrides StylePluginBase::$usesFields
EntityPager::$usesOptions	protected	property	Denotes whether the plugin has an additional options form. Overrides StylePluginBase::$usesOptions
EntityPager::$usesRowClass	protected	property	Does the style plugin support custom css class for the rows. Overrides StylePluginBase::$usesRowClass
EntityPager::$usesRowPlugin	protected	property	Whether or not this style uses a row plugin. Overrides StylePluginBase::$usesRowPlugin
EntityPager::buildOptionsForm	public	function	Provide a form to edit options for this plugin. Overrides StylePluginBase::buildOptionsForm
EntityPager::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. Overrides StylePluginBase::defineOptions
EntityPager::getDefaultOptions	protected	function	Returns an array of default options for the entity pager.
EntityPager::getOption	protected	function	Returns a value for an option.
EntityPager::getRelationshipOptions	protected	function	Gets any relationships in the view as options.
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::$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::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	62
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
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::submitOptionsForm	public	function	Handle any special handling on the validate form. Overrides ViewsPluginInterface::submitOptionsForm	16
PluginBase::summaryTitle	public	function	Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions	1
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::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.
PluginBase::__construct	public	function	Constructs a PluginBase object. Overrides PluginBase::__construct
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.
StylePluginBase::$defaultFieldLabels	protected	property	Should field labels be enabled by default.	1
StylePluginBase::$groupingTheme	protected	property	The theme function used to render the grouping set.
StylePluginBase::$rendered_fields	protected	property	Stores the rendered field values, keyed by the row index and field name.
StylePluginBase::$rowTokens	protected	property	Store all available tokens row rows.
StylePluginBase::$usesGrouping	protected	property	Does the style plugin support grouping of rows.	3
StylePluginBase::buildSort	public	function	Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.	1
StylePluginBase::buildSortPost	public	function	Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.	1
StylePluginBase::defaultFieldLabels	public	function	Return TRUE if this style enables field labels by default.	1
StylePluginBase::destroy	public	function	Clears a plugin. Overrides PluginBase::destroy
StylePluginBase::elementPreRenderRow	public	function	#pre_render callback for view row field rendering.
StylePluginBase::evenEmpty	public	function	Should the output of the style plugin be rendered even if it's a empty view.	2
StylePluginBase::getField	public	function	Gets a rendered field.
StylePluginBase::getFieldValue	public	function	Get the raw field value.
StylePluginBase::getRowClass	public	function	Return the token replaced row class for the specified row.
StylePluginBase::init	public	function	Overrides \Drupal\views\Plugin\views\PluginBase::init(). Overrides PluginBase::init
StylePluginBase::preRender	public	function	Allow the style to do stuff before each row is rendered.
StylePluginBase::query	public	function	Add anything to the query that we might need to. Overrides PluginBase::query	1
StylePluginBase::render	public	function	Render the display in this style.	7
StylePluginBase::renderFields	protected	function	Renders all of the fields for a given style and store them on the object.
StylePluginBase::renderGrouping	public	function	Group records as needed for rendering.
StylePluginBase::renderGroupingSets	public	function	Render the grouping sets.
StylePluginBase::renderRowGroup	protected	function	Renders a group of rows of the grouped view.
StylePluginBase::tokenizeValue	public	function	Take a value and apply token replacement logic to it.
StylePluginBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
StylePluginBase::usesFields	public	function	Return TRUE if this style also uses fields.	3
StylePluginBase::usesGrouping	public	function	Returns the usesGrouping property.	3
StylePluginBase::usesRowClass	public	function	Returns the usesRowClass property.	3
StylePluginBase::usesRowPlugin	public	function	Returns the usesRowPlugin property.	10
StylePluginBase::usesTokens	public	function	Return TRUE if this style uses tokens.
StylePluginBase::validate	public	function	Validate that the plugin is correct and can be saved. Overrides PluginBase::validate
StylePluginBase::validateOptionsForm	public	function	Validate the options form. Overrides PluginBase::validateOptionsForm
StylePluginBase::wizardForm	public	function	Provide a form in the views wizard if this style is selected.
StylePluginBase::wizardSubmit	public	function	Alter the options of a display before they are added to the view.	1
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 EntityPager in Entity Pager 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation