You are here

Home » API reference » Views random seed 8 » ViewsRandomSeedRandom.php

class ViewsRandomSeedRandom in Views random seed 8

Handle a random sort with seed.

Plugin annotation

@ViewsSort("views_random_seed_random");

Hierarchy

Expanded class hierarchy of ViewsRandomSeedRandom

File

src/Plugin/views/sort/ViewsRandomSeedRandom.php, line 17

Namespace

Drupal\views_random_seed\Plugin\views\sort
View source 
class ViewsRandomSeedRandom extends SortPluginBase {

  /** @var \Drupal\views\Plugin\views\query\Sql */
  public $query;

  /**
   * The seed calculator.
   *
   * @var \Drupal\views_random_seed\SeedCalculator
   */
  protected $seedCalculator;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, SeedCalculator $seedCalculator) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->seedCalculator = $seedCalculator;
  }

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

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['reuse_seed'] = [
      'default' => '',
    ];
    $options['user_seed_type'] = [
      'default' => 'same_per_user',
    ];
    $options['anonymous_session'] = [
      'default' => FALSE,
    ];
    $options['reset_seed_int'] = [
      'default' => '3600',
    ];
    $options['reset_seed_custom'] = [
      'default' => '300',
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function adminSummary() {
    return "";
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['order']['#access'] = FALSE;
    $reuseSeedArray = [
      '' => $this
        ->t('None'),
    ];
    $viewList = Views::getAllViews();
    foreach ($viewList as $view) {
      foreach ($view
        ->get('display') as $display) {
        $reuseSeedArray[$view
          ->id() . '-' . $display['id']] = $view
          ->label() . ': ' . $display['display_title'];
      }
    }

    // Reuse seed from another view.
    $form['reuse_seed'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Reuse seed from another view display'),
      '#options' => $reuseSeedArray,
      '#description' => $this
        ->t('With this option enabled, you can sync results between views.'),
      '#default_value' => $this->options['reuse_seed'] ?? '',
    ];

    // User seed type.
    $form['user_seed_type'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('User seed type'),
      '#options' => [
        'same_per_user' => $this
          ->t('Use the same seed for every user'),
        'diff_per_user' => $this
          ->t('Use a different seed per user'),
      ],
      '#default_value' => $this->options['user_seed_type'] ?? 'same_per_user',
    ];

    // User seed anonymous.
    $form['anonymous_session'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Anonymous sessions'),
      '#default_value' => $this->options['anonymous_session'] ?? FALSE,
      '#description' => $this
        ->t('Start sessions for anonymous users, which impacts performance.<br />If left unchecked, the seed will be the same for all anonymous users.'),
      '#states' => [
        'visible' => [
          ':input[name="options[user_seed_type]"]' => [
            'value' => 'diff_per_user',
          ],
        ],
      ],
    ];

    // User seed type.
    $form['reset_seed_int'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Reset seed'),
      '#options' => [
        -1 => $this
          ->t('Never'),
        0 => $this
          ->t('Custom'),
        3600 => $this
          ->t('Every hour'),
        28800 => $this
          ->t('Every eight hours'),
        86400 => $this
          ->t('Every day'),
      ],
      '#default_value' => $this->options['reset_seed_int'] ?? '3600',
    ];

    // Custom time.
    $form['reset_seed_custom'] = [
      '#type' => 'number',
      '#min' => 0,
      '#size' => 10,
      '#title' => $this
        ->t('Custom reset seed'),
      '#required' => TRUE,
      '#default_value' => $this->options['reset_seed_custom'] ?? '300',
      '#description' => $this
        ->t('Define your own custom reset time in seconds.'),
      '#states' => [
        'visible' => [
          ':input[name="options[reset_seed_int]"]' => [
            'value' => '0',
          ],
        ],
      ],
    ];
  }

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

  /**
   * {@inheritdoc}
   */
  public function query() {
    $db_type = \Drupal::database()
      ->driver();
    $seed = $this->seedCalculator
      ->calculateSeed($this->options, $this->view
      ->id(), $this->view->current_display, $db_type);
    switch ($db_type) {
      case 'mysql':
      case 'mysqli':
        $formula = 'RAND(' . $seed . ')';
        break;
      case 'pgsql':

        // For PgSQL we'll run an extra query with a integer between
        // 0 and 1 which will be used by the RANDOM() function.
        \Drupal::database()
          ->query('select setseed(' . $seed . ')');
        \Drupal::database()
          ->query("select random()");
        $formula = 'RANDOM()';
        break;
    }
    if (!empty($formula)) {

      // Use SearchAPI random sorting with seed if the query object is an
      // instance of SearchApiViewsQuery (or a subclass of it). Pass along the
      // seed and the built formula as options for the SearchApiQuery class.
      // See: https://www.drupal.org/node/1197538#comment-10190520
      if ($this->view->query instanceof SearchApiQuery) {
        $this->query
          ->addOrderBy('rand', NULL, NULL, '', [
          'seed' => $seed,
          'formula' => $formula,
        ]);
      }
      else {
        $this->query
          ->addOrderBy(NULL, $formula, $this->options['order'], '_' . $this->field);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    $contexts = parent::getCacheContexts();
    if ($this->options['user_seed_type'] === 'diff_per_user') {
      $contexts[] = 'user';
    }
    return $contexts;
  }

}

Members

Namesort descending Modifiers Type Description 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 1
DependencySerializationTrait::__wakeup public function 2
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. 3
HandlerBase::$realField public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
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. 1
HandlerBase::access public function Check whether given user has access to this handler. Overrides ViewsHandlerInterface::access 4
HandlerBase::adminLabel public function Return a string representing this handler's name in the UI. Overrides ViewsHandlerInterface::adminLabel 4
HandlerBase::breakString public static function Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface::breakString
HandlerBase::broken public function Determines if the handler is considered 'broken', meaning it's a placeholder used when a handler can't be found. Overrides ViewsHandlerInterface::broken
HandlerBase::buildExposedForm public function Render our chunk of the exposed handler form when selecting 1
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies 10
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 Ensure the main table for this handler is in the query. This is used a lot. Overrides ViewsHandlerInterface::ensureMyTable 2
HandlerBase::exposedInfo public function Get information about the exposed form for the form renderer. 1
HandlerBase::getDateField public function Creates cross-database SQL dates. 2
HandlerBase::getDateFormat public function Creates cross-database SQL date formatting. 2
HandlerBase::getEntityType public function Determines the entity type used by this handler. Overrides ViewsHandlerInterface::getEntityType
HandlerBase::getField public function Shortcut to get a handler's raw field value. Overrides ViewsHandlerInterface::getField
HandlerBase::getJoin public function Get the join object that should be used for this handler. Overrides ViewsHandlerInterface::getJoin
HandlerBase::getModuleHandler protected function Gets the module handler.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface::getTableJoin
HandlerBase::getViewsData protected function Gets views data service.
HandlerBase::hasExtraOptions public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
HandlerBase::init public function Initialize the plugin. Overrides PluginBase::init 6
HandlerBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. 1
HandlerBase::isExposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
HandlerBase::multipleExposedInput public function Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. 1
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::postExecute public function Run after the view is executed, before the result is cached. Overrides ViewsHandlerInterface::postExecute
HandlerBase::preQuery public function Run before the view is built. Overrides ViewsHandlerInterface::preQuery 2
HandlerBase::sanitizeValue public function Sanitize the value for output. Overrides ViewsHandlerInterface::sanitizeValue
HandlerBase::setModuleHandler public function Sets the module handler.
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs. Overrides ViewsHandlerInterface::setRelationship
HandlerBase::setViewsData public function
HandlerBase::showExposeForm public function Shortcut to display the exposed options form. Overrides ViewsHandlerInterface::showExposeForm
HandlerBase::storeExposedInput public function If set to remember exposed input in the session, store it there. 1
HandlerBase::submitExposed public function Submit the exposed handler form
HandlerBase::submitExposeForm public function Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitExtraOptionsForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitFormCalculateOptions public function Calculates options stored on the handler 1
HandlerBase::submitGroupByForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. 1
HandlerBase::submitTemporaryForm public function A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests.
HandlerBase::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate 2
HandlerBase::validateExposed public function Validate the exposed handler form 4
HandlerBase::validateExposeForm public function Validate the options form. 1
HandlerBase::validateExtraOptionsForm public function Validate the options form.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's 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. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
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 Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
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 Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
SortPluginBase::buildExposeForm public function Form for exposed handler options. Overrides HandlerBase::buildExposeForm
SortPluginBase::canExpose public function Determine if a sort can be exposed. Overrides HandlerBase::canExpose
SortPluginBase::defaultExposeOptions public function Provide default options for exposed sorts. Overrides HandlerBase::defaultExposeOptions
SortPluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
SortPluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
SortPluginBase::showExposeButton public function Shortcut to display the expose/hide button. Overrides HandlerBase::showExposeButton
SortPluginBase::showSortForm protected function Shortcut to display the value form.
SortPluginBase::sortOptions protected function Provide a list of options for the default sort form. Should be overridden by classes that don't override sort_form
SortPluginBase::sortSubmit public function
SortPluginBase::sortValidate protected function
SortPluginBase::submitOptionsForm public function Simple submit handler Overrides PluginBase::submitOptionsForm
SortPluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
SortPluginBase::validateOptionsForm public function Simple validate handler Overrides PluginBase::validateOptionsForm
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
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.
ViewsRandomSeedRandom::$query public property @var \Drupal\views\Plugin\views\query\Sql Overrides HandlerBase::$query
ViewsRandomSeedRandom::$seedCalculator protected property The seed calculator.
ViewsRandomSeedRandom::adminSummary public function Display whether or not the sort order is ascending or descending Overrides SortPluginBase::adminSummary
ViewsRandomSeedRandom::buildOptionsForm public function Basic options for all sort criteria Overrides SortPluginBase::buildOptionsForm
ViewsRandomSeedRandom::create public static function Creates an instance of the plugin. Overrides PluginBase::create
ViewsRandomSeedRandom::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides SortPluginBase::defineOptions
ViewsRandomSeedRandom::getCacheContexts public function The cache contexts associated with this object. Overrides SortPluginBase::getCacheContexts
ViewsRandomSeedRandom::query public function Called to add the sort to a query. Overrides SortPluginBase::query
ViewsRandomSeedRandom::usesGroupBy public function Provides the handler some groupby. Overrides HandlerBase::usesGroupBy
ViewsRandomSeedRandom::__construct public function Constructs a Handler object. Overrides HandlerBase::__construct