You are here

Home » API reference » Views (for Drupal 7) 8.3 » ManyToOne.php

class ManyToOne in Views (for Drupal 7) 8.3

Same name in this branch
  1. 8.3 lib/Drupal/views/Plugin/views/filter/ManyToOne.php \Drupal\views\Plugin\views\filter\ManyToOne
  2. 8.3 lib/Drupal/views/Plugin/views/argument/ManyToOne.php \Drupal\views\Plugin\views\argument\ManyToOne

An argument handler for use in fields that have a many to one relationship with the table(s) to the left. This adds a bunch of options that are reasonably common with this type of relationship. Definition terms:

  • numeric: If true, the field will be considered numeric. Probably should always be set TRUE as views_handler_argument_string has many to one capabilities.
  • zero is null: If true, a 0 will be handled as empty, so for example a default argument can be provided or a summary can be shown.

Plugin annotation


@Plugin(
  id = "many_to_one"
)

Hierarchy

Expanded class hierarchy of ManyToOne

Related topics

Views argument handlers
Handlers to tell Views how to contextually filter queries.
2 files declare their use of ManyToOne
IndexTid.php in lib/Views/taxonomy/Plugin/views/argument/IndexTid.php
Definition of Views\taxonomy\Plugin\views\argument\IndexTid.
RolesRid.php in lib/Views/user/Plugin/views/argument/RolesRid.php
Definition of views_handler_argument_users_roles_rid.

File

lib/Drupal/views/Plugin/views/argument/ManyToOne.php, line 31
Definition of Drupal\views\Plugin\views\argument\ManyToOne.

Namespace

Drupal\views\Plugin\views\argument
View source 
class ManyToOne extends ArgumentPluginBase {
  public function init(ViewExecutable $view, &$options) {
    parent::init($view, $options);
    $this->helper = new ManyToOneHelper($this);

    // Ensure defaults for these, during summaries and stuff:
    $this->operator = 'or';
    $this->value = array();
  }
  protected function defineOptions() {
    $options = parent::defineOptions();
    if (!empty($this->definition['numeric'])) {
      $options['break_phrase'] = array(
        'default' => FALSE,
        'bool' => TRUE,
      );
    }
    $options['add_table'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    $options['require_value'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    if (isset($this->helper)) {
      $this->helper
        ->defineOptions($options);
    }
    else {
      $helper = new ManyToOneHelper($this);
      $helper
        ->defineOptions($options);
    }
    return $options;
  }
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);

    // allow + for or, , for and
    $form['break_phrase'] = array(
      '#type' => 'checkbox',
      '#title' => t('Allow multiple values'),
      '#description' => t('If selected, users can enter multiple values in the form of 1+2+3 (for OR) or 1,2,3 (for AND).'),
      '#default_value' => !empty($this->options['break_phrase']),
      '#fieldset' => 'more',
    );
    $form['add_table'] = array(
      '#type' => 'checkbox',
      '#title' => t('Allow multiple filter values to work together'),
      '#description' => t('If selected, multiple instances of this filter can work together, as though multiple values were supplied to the same filter. This setting is not compatible with the "Reduce duplicates" setting.'),
      '#default_value' => !empty($this->options['add_table']),
      '#fieldset' => 'more',
    );
    $form['require_value'] = array(
      '#type' => 'checkbox',
      '#title' => t('Do not display items with no value in summary'),
      '#default_value' => !empty($this->options['require_value']),
      '#fieldset' => 'more',
    );
    $this->helper
      ->buildOptionsForm($form, $form_state);
  }

  /**
   * Override ensureMyTable so we can control how this joins in.
   * The operator actually has influence over joining.
   */
  public function ensureMyTable() {
    $this->helper
      ->ensureMyTable();
  }
  public function query($group_by = FALSE) {
    $empty = FALSE;
    if (isset($this->definition['zero is null']) && $this->definition['zero is null']) {
      if (empty($this->argument)) {
        $empty = TRUE;
      }
    }
    else {
      if (!isset($this->argument)) {
        $empty = TRUE;
      }
    }
    if ($empty) {
      parent::ensureMyTable();
      $this->query
        ->add_where(0, "{$this->tableAlias}.{$this->realField}", NULL, 'IS NULL');
      return;
    }
    if (!empty($this->options['break_phrase'])) {
      if (!empty($this->definition['numeric'])) {
        $this
          ->breakPhrase($this->argument, $this);
      }
      else {
        $this
          ->breakPhraseString($this->argument, $this);
      }
    }
    else {
      $this->value = array(
        $this->argument,
      );
      $this->operator = 'or';
    }
    $this->helper
      ->add_filter();
  }
  function title() {
    if (!$this->argument) {
      return !empty($this->definition['empty field name']) ? $this->definition['empty field name'] : t('Uncategorized');
    }
    if (!empty($this->options['break_phrase'])) {
      $this
        ->breakPhrase($this->argument, $this);
    }
    else {
      $this->value = array(
        $this->argument,
      );
      $this->operator = 'or';
    }

    // @todo -- both of these should check definition for alternate keywords.
    if (empty($this->value)) {
      return !empty($this->definition['empty field name']) ? $this->definition['empty field name'] : t('Uncategorized');
    }
    if ($this->value === array(
      -1,
    )) {
      return !empty($this->definition['invalid input']) ? $this->definition['invalid input'] : t('Invalid input');
    }
    return implode($this->operator == 'or' ? ' + ' : ', ', $this
      ->title_query());
  }
  function summary_query() {
    $field = $this->table . '.' . $this->field;
    $join = $this
      ->getJoin();
    if (!empty($this->options['require_value'])) {
      $join->type = 'INNER';
    }
    if (empty($this->options['add_table']) || empty($this->view->many_to_one_tables[$field])) {
      $this->tableAlias = $this->query
        ->ensure_table($this->table, $this->relationship, $join);
    }
    else {
      $this->tableAlias = $this->helper
        ->summary_join();
    }

    // Add the field.
    $this->base_alias = $this->query
      ->add_field($this->tableAlias, $this->realField);
    $this
      ->summary_name_field();
    return $this
      ->summary_basics();
  }
  function summary_argument($data) {
    $value = $data->{$this->base_alias};
    if (empty($value)) {
      $value = 0;
    }
    return $value;
  }

  /**
   * Override for specific title lookups.
   */
  function title_query() {
    return $this->value;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ArgumentPluginBase::$argument property
ArgumentPluginBase::$name_field property The field to use for the name to use in the summary, which is the displayed output. For example, for the node: nid argument, the argument itself is the nid, but node.title is displayed.
ArgumentPluginBase::$name_table property The table to use for the name, should it not be in the same table as the argument.
ArgumentPluginBase::$validator property
ArgumentPluginBase::$value property 1
ArgumentPluginBase::default_access_denied function Default action: access denied.
ArgumentPluginBase::default_action function Handle the default action, which means our argument wasn't present.
ArgumentPluginBase::default_actions function Provide a list of default behaviors for this argument if the argument is not present. 3
ArgumentPluginBase::default_argument_form function Provide a form for selecting the default argument when the default action is set to provide default argument. 1
ArgumentPluginBase::default_default function This just returns true. The view argument builder will know where to find the argument from.
ArgumentPluginBase::default_empty function Default action: empty
ArgumentPluginBase::default_ignore function Default action: ignore.
ArgumentPluginBase::default_not_found function Default action: not found.
ArgumentPluginBase::default_summary function Default action: summary.
ArgumentPluginBase::default_summary_form function Provide a form for selecting further summary options when the default action is set to display one.
ArgumentPluginBase::exception_title function
ArgumentPluginBase::get_default_argument function Get a default argument, if available. 1
ArgumentPluginBase::get_plugin function Get the display or row plugin, if it exists.
ArgumentPluginBase::get_sort_name function Return a description of how the argument would normally be sorted. 5
ArgumentPluginBase::get_title function Called by the view object to get the title. This may be set by a validator so we don't necessarily call through to title().
ArgumentPluginBase::get_value function Get the value of this argument.
ArgumentPluginBase::has_default_argument function Determine if the argument is set to provide a default argument.
ArgumentPluginBase::is_exception function
ArgumentPluginBase::needsStylePlugin public function Determine if the argument needs a style plugin.
ArgumentPluginBase::processContainerRadios public static function Custom form radios process function.
ArgumentPluginBase::process_summary_arguments function Process the summary arguments for display.
ArgumentPluginBase::set_argument function Set the input for this argument
ArgumentPluginBase::set_breadcrumb function Give an argument the opportunity to modify the breadcrumb, if it wants. This only gets called on displays where a breadcrumb is actually used. 2
ArgumentPluginBase::submitOptionsForm 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. Overrides HandlerBase::submitOptionsForm
ArgumentPluginBase::summary_basics function Some basic summary behavior that doesn't need to be repeated as much as code that goes into summary_query()
ArgumentPluginBase::summary_name function Provides the name to use for the summary. By default this is just the name field. 8
ArgumentPluginBase::summary_name_field function Add the name field, which is the field displayed in summary queries. This is often used when the argument is numeric.
ArgumentPluginBase::summary_sort function Sorts the summary based upon the user's selection. The base variant of this is usually adequte.
ArgumentPluginBase::uses_breadcrumb function Determine if the argument can generate a breadcrumb
ArgumentPluginBase::validateArgument public function Validate that this argument works. By default, all arguments are valid.
ArgumentPluginBase::validateFail public function How to act if validation failes
ArgumentPluginBase::validateOptionsForm public function Validate the options form. Overrides HandlerBase::validateOptionsForm
ArgumentPluginBase::validate_argument function Called by the menu system to validate an argument.
HandlerBase::$actualField public property When a field has been moved this property is set.
HandlerBase::$actualTable public property When a table has been moved this property is set.
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$query public property Where the $query object will reside: 1
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::acceptExposedInput public function Take input from exposed handlers and assign to this handler, if necessary. 1
HandlerBase::access public function Check whether current user has access to this handler. 7
HandlerBase::adminLabel public function Return a string representing this handler's name in the UI. 9
HandlerBase::adminSummary public function Provide text for the administrative summary 4
HandlerBase::breakPhrase public static function Breaks x,y,z and x+y+z into an array. Numeric only.
HandlerBase::breakPhraseString public static function Breaks x,y,z and x+y+z into an array. Works for strings.
HandlerBase::broken public function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. 6
HandlerBase::buildExposedForm public function Render our chunk of the exposed handler form when selecting 1
HandlerBase::buildExposeForm public function Form for exposed handler options. 2
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::canExpose public function Determine if a handler can be exposed. 2
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defaultExposeOptions public function Set new exposed option defaults when exposed setting is flipped on. 2
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::exposedInfo public function Get information about the exposed form for the form renderer. 1
HandlerBase::getField public function Shortcut to get a handler's raw field value.
HandlerBase::getJoin public function Get the join object that should be used for this handler.
HandlerBase::getSQLDateField public function Creates cross-database SQL dates.
HandlerBase::getSQLFormat public function Creates cross-database SQL date formatting.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache.
HandlerBase::getTimezone public static function Figure out what timezone we're in; needed for some date manipulations.
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::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.
HandlerBase::preQuery public function Run before the view is built. 1
HandlerBase::sanitizeValue protected function Sanitize the value for output.
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
HandlerBase::showExposeButton public function Shortcut to display the expose/hide button. 2
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. 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::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::usesGroupBy public function Provides the handler some groupby. 2
HandlerBase::validate public function Validates the handler against the complete View. Overrides PluginBase::validate 1
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.
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct
ManyToOne::buildOptionsForm public function Build the options form. Overrides ArgumentPluginBase::buildOptionsForm 1
ManyToOne::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides ArgumentPluginBase::defineOptions
ManyToOne::ensureMyTable public function Override ensureMyTable so we can control how this joins in. The operator actually has influence over joining. Overrides HandlerBase::ensureMyTable
ManyToOne::init public function Overrides Drupal\views\Plugin\views\HandlerBase:init(). Overrides ArgumentPluginBase::init
ManyToOne::query public function Set up the query for this argument. Overrides ArgumentPluginBase::query
ManyToOne::summary_argument function Provide the argument to use to link from the summary to the next level; this will be called once per row of a summary, and used as part of $view->getUrl(). Overrides ArgumentPluginBase::summary_argument
ManyToOne::summary_query function Build the info for the summary query. Overrides ArgumentPluginBase::summary_query
ManyToOne::title function Get the title this argument will assign the view, given the argument. Overrides ArgumentPluginBase::title
ManyToOne::title_query function Override for specific title lookups. 2
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::$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::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
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. 2
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::isConfigurable public function Determines if the plugin is configurable.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8