Score.php

Same filename in this branch
  1. 11.x core/modules/search/src/Plugin/views/field/Score.php
Same filename in other branches
  1. 9 core/modules/search/src/Plugin/views/sort/Score.php
  2. 9 core/modules/search/src/Plugin/views/field/Score.php
  3. 8.9.x core/modules/search/src/Plugin/views/sort/Score.php
  4. 8.9.x core/modules/search/src/Plugin/views/field/Score.php
  5. 10 core/modules/search/src/Plugin/views/sort/Score.php
  6. 10 core/modules/search/src/Plugin/views/field/Score.php

Namespace

Drupal\search\Plugin\views\sort

File

core/modules/search/src/Plugin/views/sort/Score.php

View source
<?php

namespace Drupal\search\Plugin\views\sort;

use Drupal\views\Attribute\ViewsSort;
use Drupal\views\Plugin\views\sort\SortPluginBase;

/**
 * Sort handler for sorting by search score.
 *
 * @ingroup views_sort_handlers
 */
class Score extends SortPluginBase {
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        // Check to see if the search filter/argument added 'score' to the table.
        // Our filter stores it as $handler->search_score -- and we also
        // need to check its relationship to make sure that we're using the same
        // one or obviously this won't work.
        foreach ([
            'filter',
            'argument',
        ] as $type) {
            foreach ($this->view->{$type} as $handler) {
                if (isset($handler->search_score) && $handler->relationship == $this->relationship) {
                    $this->query
                        ->addOrderBy(NULL, NULL, $this->options['order'], $handler->search_score);
                    $this->tableAlias = $handler->tableAlias;
                    return;
                }
            }
        }
        // Do nothing if there is no filter/argument in place. There is no way
        // to sort on scores.
    }

}

Classes

Title Deprecated Summary
Score Sort handler for sorting by search score.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.