interface EntityPagerInterface in Entity Pager 8

Defines an interface for an entity pager.

Hierarchy

• interface \Drupal\entity_pager\EntityPagerInterface

4 files declare their use of EntityPagerInterface

EntityAnalyzerSubscriberTest.php in tests/src/Unit/EntityAnalyzerSubscriberTest.php

EntityPagerAnalyzeEvent.php in src/Event/EntityPagerAnalyzeEvent.php

EntityPagerAnalyzeEventTest.php in tests/src/Unit/EntityPagerAnalyzeEventTest.php

EntityPagerAnalyzerTest.php in tests/src/Unit/EntityPagerAnalyzerTest.php

File

src/EntityPagerInterface.php, line 8

Namespace

Drupal\entity_pager

interface EntityPagerInterface {

  /**
   * Gets the view for the entity pager.
   *
   * @return \Drupal\views\ViewExecutable
   *   The view object.
   */
  public function getView();

  /**
   * Gets an array of entity pager link render arrays.
   *
   * @return array[]
   *   The link render arrays.
   */
  public function getLinks();

  /**
   * Get result count word.
   *
   * Get the word associated with the count of results.
   * i.e. one, many
   * The number in the result converted to a summary word for privacy.
   *
   * @return string
   *   Get a text representation the number of records e.g. none, one or many.
   */
  public function getCountWord();

  /**
   * Gets the entity object this entity pager is for.
   *
   * @return \Drupal\Core\Entity\EntityInterface|null
   *   The entity object or NULL if no entity found.
   */
  public function getEntity();

  /**
   * Returns the options this entity pager was created with.
   *
   * @return array
   *   The options array.
   */
  public function getOptions();

}

Members

Name	Modifiers	Type	Description	Overrides
EntityPagerInterface::getCountWord	public	function	Get result count word.	1
EntityPagerInterface::getEntity	public	function	Gets the entity object this entity pager is for.	1
EntityPagerInterface::getLinks	public	function	Gets an array of entity pager link render arrays.	1
EntityPagerInterface::getOptions	public	function	Returns the options this entity pager was created with.	1
EntityPagerInterface::getView	public	function	Gets the view for the entity pager.	1