class LatestRevision in Drupal 10

Filter to show only the latest revision of an entity.

Plugin annotation

@ViewsFilter("latest_revision");

Hierarchy

• class \Drupal\views\Plugin\views\filter\FilterPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements CacheableDependencyInterface
  • class \Drupal\views\Plugin\views\filter\LatestRevision implements ContainerFactoryPluginInterface

Related topics

Views filter handler plugins

Plugins that handle views filtering.

File

core/modules/views/src/Plugin/views/filter/LatestRevision.php, line 18

Namespace

Drupal\views\Plugin\views\filter

class LatestRevision extends FilterPluginBase implements ContainerFactoryPluginInterface {

  /**
   * Entity Type Manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Views Handler Plugin Manager.
   *
   * @var \Drupal\views\Plugin\ViewsHandlerManager
   */
  protected $joinHandler;

  /**
   * Constructs a new LatestRevision.
   *
   * @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\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   Entity Type Manager Service.
   * @param \Drupal\views\Plugin\ViewsHandlerManager $join_handler
   *   Views Handler Plugin Manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, ViewsHandlerManager $join_handler) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
    $this->joinHandler = $join_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('plugin.manager.views.join'));
  }

  /**
   * {@inheritdoc}
   */
  public function adminSummary() {
  }

  /**
   * {@inheritdoc}
   */
  protected function operatorForm(&$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function canExpose() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function query() {

    /** @var \Drupal\views\Plugin\views\query\Sql $query */
    $query = $this->query;
    $query_base_table = $this->relationship ?: $this->view->storage
      ->get('base_table');
    $entity_type = $this->entityTypeManager
      ->getDefinition($this
      ->getEntityType());
    $keys = $entity_type
      ->getKeys();
    $definition = [
      'table' => $query_base_table,
      'type' => 'LEFT',
      'field' => $keys['id'],
      'left_table' => $query_base_table,
      'left_field' => $keys['id'],
      'extra' => [
        [
          'left_field' => $keys['revision'],
          'field' => $keys['revision'],
          'operator' => '>',
        ],
      ],
    ];
    $join = $this->joinHandler
      ->createInstance('standard', $definition);
    $join_table_alias = $query
      ->addTable($query_base_table, $this->relationship, $join);
    $query
      ->addWhere($this->options['group'], "{$join_table_alias}.{$keys['id']}", NULL, 'IS NULL');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FilterPluginBase::$alwaysMultiple	protected	property	Disable the possibility to force a single value.	4
FilterPluginBase::$always_required	public	property	Disable the possibility to allow an exposed input to be optional.
FilterPluginBase::$group_info	public	property	Contains the information of the selected item in a grouped filter.
FilterPluginBase::$no_operator	public	property	Disable the possibility to use operators.	1
FilterPluginBase::$operator	public	property	Contains the operator which is used on the query.
FilterPluginBase::$value	public	property	Contains the actual value of the field,either configured in the views ui or entered in the exposed filters.
FilterPluginBase::acceptExposedInput	public	function	Determines if the input from a filter should change the generated query.	2
FilterPluginBase::addGroupForm	public	function	Add a new group to the exposed filter groups.
FilterPluginBase::arrayFilterZero	protected static	function	Filter by no empty values, though allow the use of (string) "0".
FilterPluginBase::buildExposedFiltersGroupForm	protected	function	Build the form to let users create the group of exposed filters.
FilterPluginBase::buildExposedForm	public	function	Render our chunk of the exposed filter form when selecting.
FilterPluginBase::buildExposeForm	public	function	Options form subform for exposed filter options.	4
FilterPluginBase::buildGroupForm	public	function	Displays the Build Group form.
FilterPluginBase::buildGroupOptions	protected	function	Provide default options for exposed filters.
FilterPluginBase::buildGroupSubmit	protected	function	Save new group items, re-enumerates and remove groups marked to delete.
FilterPluginBase::buildGroupValidate	protected	function	Validate the build group options form.
FilterPluginBase::buildOptionsForm	public	function	Provide the basic form which calls through to subforms.	2
FilterPluginBase::buildValueWrapper	protected	function	Builds wrapper for value and operator forms.
FilterPluginBase::canBuildGroup	protected	function	Determine if a filter can be converted into a group.
FilterPluginBase::canGroup	public	function	Can this filter be used in OR groups?	1
FilterPluginBase::convertExposedInput	public	function	Transform the input from a grouped filter into a standard filter.
FilterPluginBase::defaultExposeOptions	public	function	Provide default options for exposed filters.	3
FilterPluginBase::defineOptions	protected	function		4
FilterPluginBase::exposedInfo	public	function	Tell the renderer about our exposed form. This only needs to be overridden for particularly complex forms. And maybe not even then.
FilterPluginBase::exposedTranslate	protected	function	Make some translations to a form item to make it more suitable to exposing.
FilterPluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	6
FilterPluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
FilterPluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	1
FilterPluginBase::groupForm	public	function	Build a form containing a group of operator | values to apply as a single filter.
FilterPluginBase::groupMultipleExposedInput	public	function	Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected.
FilterPluginBase::hasValidGroupedValue	protected	function	Determines if the given grouped filter entry has a valid value.	1
FilterPluginBase::init	public	function	Overrides \Drupal\views\Plugin\views\HandlerBase::init().	2
FilterPluginBase::isAGroup	public	function	Returns TRUE if the exposed filter works like a grouped filter.
FilterPluginBase::multipleExposedInput	public	function	Returns TRUE if users can select multiple groups items of a grouped exposed filter.
FilterPluginBase::operatorOptions	public	function	Provide a list of options for the default operator form.	4
FilterPluginBase::operatorSubmit	public	function	Perform any necessary changes to the form values prior to storage.
FilterPluginBase::operatorValidate	protected	function	Validate the operator form.
FilterPluginBase::prepareFilterSelectOptions	protected	function	Sanitizes the HTML select element's options.
FilterPluginBase::showBuildGroupButton	protected	function	Shortcut to display the build_group/hide button.
FilterPluginBase::showBuildGroupForm	public	function	Shortcut to display the exposed options form.
FilterPluginBase::showExposeButton	public	function	Shortcut to display the expose/hide button.
FilterPluginBase::showOperatorForm	public	function	Shortcut to display the operator form.
FilterPluginBase::showValueForm	protected	function	Shortcut to display the value form.
FilterPluginBase::storeExposedInput	public	function
FilterPluginBase::storeGroupInput	public	function	If set to remember exposed input in the session, store it there.
FilterPluginBase::submitOptionsForm	public	function	Simple submit handler.
FilterPluginBase::trustedCallbacks	public static	function
FilterPluginBase::validate	public	function		2
FilterPluginBase::validateExposeForm	public	function	Validate the options form.
FilterPluginBase::validateIdentifier	protected	function	Validates a filter identifier.
FilterPluginBase::validateOptionsForm	public	function	Simple validate handler.	1
FilterPluginBase::valueForm	protected	function	Options form subform for setting options.	5
FilterPluginBase::valueSubmit	protected	function	Perform any necessary changes to the form values prior to storage.	1
FilterPluginBase::valueValidate	protected	function	Validate the options form.	2
LatestRevision::$entityTypeManager	protected	property	Entity Type Manager service.
LatestRevision::$joinHandler	protected	property	Views Handler Plugin Manager.
LatestRevision::adminSummary	public	function	Display the filter on the administrative summary. Overrides FilterPluginBase::adminSummary
LatestRevision::canExpose	public	function	Determine if a filter can be exposed. Overrides FilterPluginBase::canExpose
LatestRevision::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LatestRevision::operatorForm	protected	function	Options form subform for setting the operator. Overrides FilterPluginBase::operatorForm
LatestRevision::query	public	function	Add this filter to the query. Overrides FilterPluginBase::query
LatestRevision::__construct	public	function	Constructs a new LatestRevision.