class TaxonomyTerm

Same name in other branches

9 core/modules/taxonomy/src/Plugin/views/wizard/TaxonomyTerm.php \Drupal\taxonomy\Plugin\views\wizard\TaxonomyTerm
8.9.x core/modules/taxonomy/src/Plugin/views/wizard/TaxonomyTerm.php \Drupal\taxonomy\Plugin\views\wizard\TaxonomyTerm
10 core/modules/taxonomy/src/Plugin/views/wizard/TaxonomyTerm.php \Drupal\taxonomy\Plugin\views\wizard\TaxonomyTerm

Tests creating taxonomy views with the wizard.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
  - class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
    - class \Drupal\views\Plugin\views\wizard\WizardPluginBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\wizard\WizardInterface
      - class \Drupal\taxonomy\Plugin\views\wizard\TaxonomyTerm extends \Drupal\views\Plugin\views\wizard\WizardPluginBase

Expanded class hierarchy of TaxonomyTerm

File

core/modules/taxonomy/src/Plugin/views/wizard/TaxonomyTerm.php, line 12

Namespace

Drupal\taxonomy\Plugin\views\wizard

View source

class TaxonomyTerm extends WizardPluginBase {
    
    /**
     * {@inheritdoc}
     */
    protected function defaultDisplayOptions() {
        $display_options = parent::defaultDisplayOptions();
        // Add permission-based access control.
        $display_options['access']['type'] = 'perm';
        $display_options['access']['options']['perm'] = 'access content';
        // Remove the default fields, since we are customizing them here.
        unset($display_options['fields']);
        
        /* Field: Taxonomy: Term */
        $display_options['fields']['name']['id'] = 'name';
        $display_options['fields']['name']['table'] = 'taxonomy_term_field_data';
        $display_options['fields']['name']['field'] = 'name';
        $display_options['fields']['name']['entity_type'] = 'taxonomy_term';
        $display_options['fields']['name']['entity_field'] = 'name';
        $display_options['fields']['name']['label'] = '';
        $display_options['fields']['name']['alter']['alter_text'] = 0;
        $display_options['fields']['name']['alter']['make_link'] = 0;
        $display_options['fields']['name']['alter']['absolute'] = 0;
        $display_options['fields']['name']['alter']['trim'] = 0;
        $display_options['fields']['name']['alter']['word_boundary'] = 0;
        $display_options['fields']['name']['alter']['ellipsis'] = 0;
        $display_options['fields']['name']['alter']['strip_tags'] = 0;
        $display_options['fields']['name']['alter']['html'] = 0;
        $display_options['fields']['name']['hide_empty'] = 0;
        $display_options['fields']['name']['empty_zero'] = 0;
        $display_options['fields']['name']['type'] = 'string';
        $display_options['fields']['name']['settings']['link_to_entity'] = 1;
        $display_options['fields']['name']['plugin_id'] = 'term_name';
        return $display_options;
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
DerivativeInspectionInterface::getBaseId	public	function	Gets the base_plugin_id of the plugin instance.		1
DerivativeInspectionInterface::getDerivativeId	public	function	Gets the derivative_id of the plugin instance.		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::$position	public	property	The handler position.
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::buildOptionsForm	public	function		Overrides ViewsPluginInterface::buildOptionsForm	16
PluginBase::calculateDependencies	public	function		Overrides DependentPluginInterface::calculateDependencies	14
PluginBase::defineOptions	protected	function	Information about options for all kinds of purposes will be held here.		18
PluginBase::destroy	public	function		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		Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens	public	function		Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getProvider	public	function		Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer	protected	function	Returns the render API renderer.		1
PluginBase::globalTokenForm	public	function		Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace	public	function		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::init	public	function		Overrides ViewsPluginInterface::init	6
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function		Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup	public static	function		Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData	public static	function		Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::query	public	function		Overrides ViewsPluginInterface::query	8
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::submitOptionsForm	public	function		Overrides ViewsPluginInterface::submitOptionsForm	16
PluginBase::summaryTitle	public	function		Overrides ViewsPluginInterface::summaryTitle	6
PluginBase::themeFunctions	public	function		Overrides ViewsPluginInterface::themeFunctions	1
PluginBase::trustedCallbacks	public static	function		Overrides TrustedCallbackInterface::trustedCallbacks	6
PluginBase::unpackOptions	public	function		Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions	public	function		Overrides ViewsPluginInterface::usesOptions	8
PluginBase::validate	public	function		Overrides ViewsPluginInterface::validate	6
PluginBase::validateOptionsForm	public	function		Overrides ViewsPluginInterface::validateOptionsForm	15
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string.		1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.		6
PluginInspectionInterface::getPluginId	public	function	Gets the plugin ID of the plugin instance.		2
TaxonomyTerm::defaultDisplayOptions	protected	function		Overrides WizardPluginBase::defaultDisplayOptions
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
WizardPluginBase::$availableSorts	protected	property	The available store criteria.
WizardPluginBase::$base_table	protected	property
WizardPluginBase::$bundleInfoService	protected	property	The bundle info service.
WizardPluginBase::$createdColumn	protected	property	The table column used for sorting by create date of this wizard.		8
WizardPluginBase::$entityType	protected	property	Contains the information from entity_get_info of the $entity_type.
WizardPluginBase::$entityTypeId	protected	property	The entity type connected with the wizard.
WizardPluginBase::$filters	protected	property	Views items configuration arrays for filters added by the wizard.		2
WizardPluginBase::$filter_defaults	protected	property
WizardPluginBase::$parentFormSelector	protected	property	The parent form selector service.
WizardPluginBase::$sorts	protected	property	Views items configuration arrays for sorts added by the wizard.
WizardPluginBase::$validated_views	protected	property
WizardPluginBase::addDisplays	protected	function	Adds the array of display options to the view, with appropriate overrides.
WizardPluginBase::alterDisplayOptions	protected	function	Alters the full array of display options before they are added to the view.
WizardPluginBase::blockDisplayOptions	protected	function	Retrieves the block display options.		1
WizardPluginBase::buildDisplayOptions	protected	function	Builds an array of display options for the view.		1
WizardPluginBase::buildFilters	protected	function	Builds the form structure for selecting the view's filters.		1
WizardPluginBase::buildForm	public	function		Overrides WizardInterface::buildForm
WizardPluginBase::buildFormStyle	protected	function	Adds the style options to the wizard form.
WizardPluginBase::buildSorts	protected	function	Builds the form structure for selecting the view's sort order.
WizardPluginBase::create	public static	function		Overrides PluginBase::create	1
WizardPluginBase::createView	public	function		Overrides WizardInterface::createView
WizardPluginBase::defaultDisplayFilters	protected	function	Retrieves all filter information used by the default display.
WizardPluginBase::defaultDisplayFiltersUser	protected	function	Retrieves filter information based on user input for the default display.		2
WizardPluginBase::defaultDisplaySorts	protected	function	Retrieves all sort information used by the default display.
WizardPluginBase::defaultDisplaySortsUser	protected	function	Retrieves sort information based on user input for the default display.
WizardPluginBase::getAvailableSorts	public	function	Gets the availableSorts property.		2
WizardPluginBase::getCreatedColumn	public	function	Gets the createdColumn property.
WizardPluginBase::getFilters	public	function	Gets the filters property.		1
WizardPluginBase::getSelected	public static	function	Gets the current value of a #select element, from within a form constructor function.
WizardPluginBase::getSorts	public	function	Gets the sorts property.
WizardPluginBase::instantiateView	protected	function	Instantiates a view object from form values.
WizardPluginBase::pageDisplayOptions	protected	function	Retrieves the page display options.		1
WizardPluginBase::pageFeedDisplayOptions	protected	function	Retrieves the feed display options.
WizardPluginBase::restExportDisplayOptions	protected	function	Retrieves the REST export display options from the submitted form values.
WizardPluginBase::retrieveValidatedView	protected	function	Retrieves a validated view for a form submission.
WizardPluginBase::rowStyleOptions	protected	function	Retrieves row style plugin names.		3
WizardPluginBase::setDefaultOptions	protected	function	Sets options for a display and makes them the default options if possible.
WizardPluginBase::setOverrideOptions	protected	function	Sets options for a display, inheriting from the defaults when possible.
WizardPluginBase::setValidatedView	protected	function	Stores a validated view from a form submission.
WizardPluginBase::validateView	public	function	Implements Drupal\views\Plugin\views\wizard\WizardInterface::validate().	Overrides WizardInterface::validateView
WizardPluginBase::__construct	public	function	Constructs a WizardPluginBase object.	Overrides PluginBase::__construct	1

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

class TaxonomyTerm

Hierarchy

File

Namespace

Members

Search drupal 11.x

API Navigation

Breadcrumb

class TaxonomyTerm

Hierarchy

File

Namespace

Members

Search drupal 11.x

API Navigation