class PagererStyle in Pagerer 8

Defines a Plugin annotation object for the Pagerer style plugin.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\pagerer\Plugin\Annotation\PagererStyle

See also

\Drupal\pagerer\Plugin\PagererStyleManager

8 classes are annotated with PagererStyle

Adaptive in src/Plugin/pagerer/Adaptive.php

Pager style with links to pages following an adaptive logic.

Basic in src/Plugin/pagerer/Basic.php

Basic pager style similar to Views' 'mini' pager.

Mini in src/Plugin/pagerer/Mini.php

Pager style to display current page/item in a direct entry textbox.

Multipane in src/Plugin/pagerer/Multipane.php

A multi-pane (left, center, and right) pager style.

Progressive in src/Plugin/pagerer/Progressive.php

Pager style with links to pages progressively more distant from current.

... See full list

File

src/Plugin/Annotation/PagererStyle.php, line 14

Namespace

Drupal\pagerer\Plugin\Annotation

class PagererStyle extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The title of the Pagerer style.
   *
   * The string should be wrapped in a @Translation().
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title;

  /**
   * The short title of the Pagerer style.
   *
   * The string should be wrapped in a @Translation().
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $short_title;

  /**
   * A informative description of the Pagerer style.
   *
   * The string should be wrapped in a @Translation().
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $help;

  /**
   * The style type.
   *
   * Can be 'base' for a base pager style, or 'composite' for special
   * style combinations like e.g. the Pagerer multi-pane pager.
   *
   * @var string
   */
  public $style_type;

}

Members

Name	Modifiers	Type	Description	Overrides
PagererStyle::$help	public	property	A informative description of the Pagerer style.
PagererStyle::$id	public	property	The plugin ID.
PagererStyle::$short_title	public	property	The short title of the Pagerer style.
PagererStyle::$style_type	public	property	The style type.
PagererStyle::$title	public	property	The title of the Pagerer style.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2