class Bundle

Same name in this branch
  1. 8.x drupal/core/vendor/symfony/http-kernel/Symfony/Component/HttpKernel/Bundle/Bundle.php \Symfony\Component\HttpKernel\Bundle\Bundle
  2. 8.x drupal/core/modules/views/lib/Drupal/views/Plugin/views/filter/Bundle.php \Drupal\views\Plugin\views\filter\Bundle

Filter class which allows filtering by entity bundles.

Plugin annotation

@PluginID("bundle");

Hierarchy

Expanded class hierarchy of Bundle

Related topics

Views filter handlers
Handlers to tell Views how to filter queries.
2 string references to 'Bundle'
BundleTest::getInfo in drupal/core/modules/system/lib/Drupal/system/Tests/Bundle/BundleTest.php
field.schema.yml in drupal/core/modules/field/config/schema/field.schema.yml
drupal/core/modules/field/config/schema/field.schema.yml

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/filter/Bundle.php, line 21
Definition of \Drupal\views\Plugin\views\filter\Bundle.

Namespace

Drupal\views\Plugin\views\filter
View source
class Bundle extends InOperator {

  /**
   * The entity type for the filter.
   *
   * @var string
   */
  protected $entityType;

  /**
   * The entity info for the entity type.
   *
   * @var array
   */
  protected $entityInfo;

  /**
   * Overrides \Drupal\views\Plugin\views\filter\InOperator::init().
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);
    $this->entityType = $this
      ->getEntityType();
    $this->entityInfo = entity_get_info($this->entityType);
    $this->real_field = $this->entityInfo['entity_keys']['bundle'];
  }

  /**
   * Overrides \Drupal\views\Plugin\views\filter\InOperator::getValueOptions().
   */
  public function getValueOptions() {
    if (!isset($this->value_options)) {
      $types = entity_get_bundles($this->entityType);
      $this->value_title = t('@entity types', array(
        '@entity' => $this->entityInfo['label'],
      ));
      $options = array();
      foreach ($types as $type => $info) {
        $options[$type] = $info['label'];
      }
      asort($options);
      $this->value_options = $options;
    }
    return $this->value_options;
  }

  /**
   * Overrides \Drupal\views\Plugin\views\filter\InOperator::query().
   */
  public function query() {

    // Make sure that the entity base table is in the query.
    $this
      ->ensureMyTable();
    parent::query();
  }

}

Members

Name Modifiers Type Descriptionsort descending Overrides
InOperator::operatorValues protected function
InOperator::opSimple protected function
InOperator::opEmpty protected function
FilterPluginBase::convertExposedInput public function
InOperator::$value_form_type property 1
HandlerBase::submitTemporaryForm public function A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests.
FilterPluginBase::addGroupForm public function Add a new group to the exposed filter groups.
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
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.
FilterPluginBase::groupForm public function Build a form containing a group of operator | values to apply as a single filter.
InOperator::operatorOptions public function Build strings from the operators() for 'select' options Overrides FilterPluginBase::operatorOptions 1
FilterPluginBase::buildExposedFiltersGroupForm protected function Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group'
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
FilterPluginBase::canGroup public function Can this filter be used in OR groups? 1
InOperator::acceptExposedInput public function Check to see if input from the exposed filters should change the behavior of this filter. Overrides FilterPluginBase::acceptExposedInput 2
HandlerBase::access public function Check whether current user has access to this handler. 6
PluginBase::destroy public function Clears a plugin. 2
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct 3
FilterPluginBase::$value property Contains the actual value of the field,either configured in the views ui or entered in the exposed filters.
FilterPluginBase::$group_info property Contains the information of the selected item in a gruped filter.
FilterPluginBase::$operator property Contains the operator which is used on the query.
ContainerFactoryPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
HandlerBase::getDateFormat public function Creates cross-database SQL date formatting.
HandlerBase::getDateField public function Creates cross-database SQL dates.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
FilterPluginBase::canBuildGroup protected function Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups.
FilterPluginBase::canExpose public function Determine if a filter can be exposed. Overrides HandlerBase::canExpose 2
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::isExposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
HandlerBase::getEntityType public function Determines the entity type used by this handler.
FilterPluginBase::$always_required property Disable the possibility to allow a exposed input to be optional.
FilterPluginBase::$always_multiple property Disable the possibility to force a single value. 6
FilterPluginBase::$no_operator property Disable the possibility to use operators. 2
InOperator::adminSummary public function Display the filter on the administrative summary Overrides FilterPluginBase::adminSummary 2
FilterPluginBase::buildGroupForm public function Displays the Build Group form.
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. 8
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
FilterPluginBase::arrayFilterZero protected static function Filter by no empty values, though allow to use "0".
HandlerBase::getJoin public function Get the join object that should be used for this handler.
HandlerBase::hasExtraOptions public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
FilterPluginBase::storeGroupInput public function If set to remember exposed input in the session, store it there. This function is similar to storeExposedInput but modified to work properly when the filter is a group.
FilterPluginBase::storeExposedInput public function If set to remember exposed input in the session, store it there. Overrides HandlerBase::storeExposedInput
InOperator::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides FilterPluginBase::defineOptions 1
FilterPluginBase::exposedTranslate protected function Make some translations to a form item to make it more suitable to exposing.
PluginBase::$options public property Options for this plugin will be held here.
InOperator::buildExposeForm public function Options form subform for exposed filter options. Overrides FilterPluginBase::buildExposeForm 1
InOperator::valueForm protected function Options form subform for setting options. Overrides FilterPluginBase::valueForm 2
FilterPluginBase::operatorForm protected function Options form subform for setting the operator. 4
Bundle::getValueOptions public function Overrides \Drupal\views\Plugin\views\filter\InOperator::getValueOptions(). Overrides InOperator::getValueOptions
Bundle::init public function Overrides \Drupal\views\Plugin\views\filter\InOperator::init(). Overrides InOperator::init
Bundle::query public function Overrides \Drupal\views\Plugin\views\filter\InOperator::query(). Overrides InOperator::query
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.
InOperator::valueSubmit protected 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 FilterPluginBase::valueSubmit 2
FilterPluginBase::operatorSubmit 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::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.
PluginBase::$definition public property Plugins's definition
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
InOperator::defaultExposeOptions public function Provide default options for exposed filters. Overrides FilterPluginBase::defaultExposeOptions
FilterPluginBase::buildGroupOptions protected function Provide default options for exposed filters.
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
FilterPluginBase::buildOptionsForm public function Provide the basic form which calls through to subforms. If overridden, it is best to call through to the parent, or to at least make sure all of the functions in this form are called. Overrides HandlerBase::buildOptionsForm 3
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::usesGroupBy public function Provides the handler some groupby. 2
FilterPluginBase::buildExposedForm public function Render our chunk of the exposed filter form when selecting Overrides HandlerBase::buildExposedForm
HandlerBase::adminLabel public function Return a string representing this handler's name in the UI. 9
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
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.
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::usesOptions public function Returns the usesOptions property. 8
FilterPluginBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase::isAGroup
FilterPluginBase::multipleExposedInput public function Returns TRUE if users can select multiple groups items of a grouped exposed filter. Overrides HandlerBase::multipleExposedInput
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 public function Sanitize the value for output.
FilterPluginBase::prepareFilterSelectOptions protected function Sanitizes the HTML select element's options.
FilterPluginBase::buildGroupSubmit protected function Save new group items, re-enumerates and remove groups marked to delete.
FilterPluginBase::showBuildGroupButton protected function Shortcut to display the build_group/hide button.
FilterPluginBase::showExposeButton public function Shortcut to display the expose/hide button. Overrides HandlerBase::showExposeButton
FilterPluginBase::showBuildGroupForm public function Shortcut to display the exposed options form.
HandlerBase::showExposeForm public function Shortcut to display the exposed options form.
FilterPluginBase::showOperatorForm public function Shortcut to display the operator form.
FilterPluginBase::showValueForm protected function Shortcut to display the value form.
HandlerBase::getField public function Shortcut to get a handler's raw field value.
FilterPluginBase::submitOptionsForm public function Simple submit handler Overrides HandlerBase::submitOptionsForm
FilterPluginBase::validateOptionsForm public function Simple validate handler Overrides HandlerBase::validateOptionsForm 1
InOperator::$value_options property Stores all operations which are available on the form.
HandlerBase::submitExposed public function Submit the exposed handler form
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. Overrides HandlerBase::exposedInfo
HandlerBase::$realField public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
PluginBase::$displayHandler public property The display object this plugin is for.
Bundle::$entityInfo protected property The entity info for the entity type.
Bundle::$entityType protected property The entity type for the filter.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
HandlerBase::$relationship public property The relationship used for this field.
HandlerBase::$table public property The table this handler is attached to.
PluginBase::$view public property The top object of a view. 1
InOperator::operators function This kind of construct makes it relatively easy for a child class to add or remove functionality by overriding this function and adding/removing items from this array. 1
HandlerBase::caseTransform protected function Transform a string by a certain method.
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
FilterPluginBase::buildGroupValidate protected function Validate the build group options form. 1
HandlerBase::validateExposed public function Validate the exposed handler form 4
FilterPluginBase::operatorValidate protected function Validate the operator form.
FilterPluginBase::valueValidate protected function Validate the options form. 3
FilterPluginBase::validateExposeForm public function Validate the options form. Overrides HandlerBase::validateExposeForm
HandlerBase::validateExtraOptionsForm public function Validate the options form.
InOperator::validate public function Validates the handler against the complete View. Overrides HandlerBase::validate
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.
InOperator::reduceValueOptions public function When using exposed filters, we may be required to reduce the set.
HandlerBase::$query public property Where the $query object will reside: 1
HandlerBase::$field public property With field you can override the realField if the real field is not set.