class Score

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

Sort handler for sorting by search score.

Plugin annotation

@ViewsSort("search_score");

Hierarchy

Expanded class hierarchy of Score

Related topics

4 string references to 'Score'
NodeViewsData::getViewsData in core/modules/node/src/NodeViewsData.php
Search::query in core/modules/search/src/Plugin/views/argument/Search.php
Search::query in core/modules/search/src/Plugin/views/filter/Search.php
views.view.test_search.yml in core/modules/views/tests/modules/views_test_config/test_views/views.view.test_search.yml
core/modules/views/tests/modules/views_test_config/test_views/views.view.test_search.yml

File

core/modules/search/src/Plugin/views/sort/Score.php, line 14

Namespace

Drupal\search\Plugin\views\sort
View source
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.
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title 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
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange]
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$moduleHandler protected property The module handler. 1
HandlerBase::$moduleHandler protected property The module handler. 1
HandlerBase::$moduleHandler protected property The module handler. 1
HandlerBase::$query public property Where the $query object will reside.
HandlerBase::$realField public property The real field.
HandlerBase::$relationship public property The relationship used for this field.
HandlerBase::$table public property The table this handler is attached to.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
HandlerBase::$viewsData protected property The views data service.
HandlerBase::acceptExposedInput public function Take input from exposed handlers and assign to this handler, if necessary.
HandlerBase::access public function
HandlerBase::adminLabel public function
HandlerBase::breakString public static function
HandlerBase::broken public function
HandlerBase::buildExposedForm public function Render our chunk of the exposed handler form when selecting.
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options.
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings.
HandlerBase::calculateDependencies public function 1
HandlerBase::calculateDependencies public function 1
HandlerBase::calculateDependencies public function 1
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::displayExposedForm public function Displays the Expose form.
HandlerBase::ensureMyTable public function
HandlerBase::exposedInfo public function Get information about the exposed form for the form renderer.
HandlerBase::getDateField public function Creates cross-database SQL dates.
HandlerBase::getDateFormat public function Creates cross-database SQL date formatting.
HandlerBase::getEntityType public function
HandlerBase::getField public function
HandlerBase::getJoin public function
HandlerBase::getModuleHandler protected function Gets the module handler.
HandlerBase::getTableJoin public static function
HandlerBase::getViewsData protected function Gets views data service.
HandlerBase::hasExtraOptions public function Determines if the handler has extra options.
HandlerBase::init public function
HandlerBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter.
HandlerBase::isExposed public function Determine if this item is 'exposed'.
HandlerBase::multipleExposedInput public function Define if the exposed input has to be submitted multiple times.
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::postExecute public function
HandlerBase::preQuery public function
HandlerBase::sanitizeValue public function
HandlerBase::setModuleHandler public function Sets the module handler.
HandlerBase::setRelationship public function
HandlerBase::setViewsData public function
HandlerBase::showExposeForm public function Shortcut to display the exposed options form.
HandlerBase::storeExposedInput public function If set to remember exposed input in the session, store it there.
HandlerBase::submitExposed public function Submit the exposed handler form.
HandlerBase::submitExposeForm public function Perform any necessary changes to the form exposes prior to storage.
HandlerBase::submitExtraOptionsForm public function Perform any necessary changes to the form values prior to storage.
HandlerBase::submitFormCalculateOptions public function Calculates options stored on the handler.
HandlerBase::submitGroupByForm public function Perform any necessary changes to the form values prior to storage.
HandlerBase::submitTemporaryForm public function Submits a temporary form.
HandlerBase::usesGroupBy public function Provides the handler some groupby. 2
HandlerBase::usesGroupBy public function Provides the handler some groupby. 2
HandlerBase::usesGroupBy public function Provides the handler some groupby. 2
HandlerBase::validate public function
HandlerBase::validateExposed public function Validate the exposed handler form.
HandlerBase::validateExtraOptionsForm public function Validate the options form.
HandlerBase::__construct public function Constructs a Handler object. 2
HandlerBase::__construct public function Constructs a Handler object. 2
HandlerBase::__construct public function Constructs a Handler object. 2
MessengerTrait::$messenger protected property The messenger.
MessengerTrait::messenger public function Gets the messenger.
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins' 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.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 1
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 1
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 1
PluginBase::$view public property The top object of a view.
PluginBase::create public static function 4
PluginBase::create public static function 4
PluginBase::create public static function 4
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function
PluginBase::getAvailableGlobalTokens public function
PluginBase::getBaseId public function
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function
PluginBase::getPluginId public function
PluginBase::getProvider public function
PluginBase::getRenderer protected function Returns the render API renderer.
PluginBase::globalTokenForm public function
PluginBase::globalTokenReplace public function
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
PluginBase::preRenderAddFieldsetMarkup public static function
PluginBase::preRenderFlattenData public static function
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::summaryTitle public function
PluginBase::themeFunctions public function
PluginBase::unpackOptions public function
PluginBase::usesOptions public function 1
PluginBase::usesOptions public function 1
PluginBase::usesOptions public function 1
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string.
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
Score::query public function Called to add the sort to a query. Overrides SortPluginBase::query
SortPluginBase::adminSummary public function Display whether or not the sort order is ascending or descending.
SortPluginBase::buildExposeForm public function
SortPluginBase::buildOptionsForm public function Basic options for all sort criteria.
SortPluginBase::canExpose public function Determine if a sort can be exposed.
SortPluginBase::defaultExposeOptions public function Provide default options for exposed sorts.
SortPluginBase::defineOptions protected function
SortPluginBase::getCacheContexts public function
SortPluginBase::getCacheMaxAge public function
SortPluginBase::getCacheTags public function
SortPluginBase::showExposeButton public function Shortcut to display the expose/hide button.
SortPluginBase::showSortForm protected function Shortcut to display the value form.
SortPluginBase::sortOptions protected function Provide a list of options for the default sort form.
SortPluginBase::sortSubmit public function
SortPluginBase::sortValidate protected function
SortPluginBase::submitOptionsForm public function Simple submit handler.
SortPluginBase::trustedCallbacks public static function
SortPluginBase::validateExposeForm public function Validate the options form.
SortPluginBase::validateOptionsForm public function Simple validate handler.
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
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::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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
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.

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