class Field

Same name in this branch

8.9.x core/modules/field/src/Plugin/migrate/source/d6/Field.php \Drupal\field\Plugin\migrate\source\d6\Field
8.9.x core/modules/field/src/Plugin/migrate/source/d7/Field.php \Drupal\field\Plugin\migrate\source\d7\Field

Same name in other branches

9 core/modules/field/src/Plugin/migrate/source/d6/Field.php \Drupal\field\Plugin\migrate\source\d6\Field
9 core/modules/field/src/Plugin/migrate/source/d7/Field.php \Drupal\field\Plugin\migrate\source\d7\Field
10 core/modules/field/src/Plugin/migrate/source/d6/Field.php \Drupal\field\Plugin\migrate\source\d6\Field
10 core/modules/field/src/Plugin/migrate/source/d7/Field.php \Drupal\field\Plugin\migrate\source\d7\Field
11.x core/modules/field/src/Plugin/migrate/source/d6/Field.php \Drupal\field\Plugin\migrate\source\d6\Field
11.x core/modules/field/src/Plugin/migrate/source/d7/Field.php \Drupal\field\Plugin\migrate\source\d7\Field

A stub class to provide backward compatibility for EntityField.

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\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
      - class \Drupal\views\Plugin\views\field\FieldPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\views\Plugin\views\field\FieldHandlerInterface
        class \Drupal\views\Plugin\views\field\EntityField extends \Drupal\views\Plugin\views\field\FieldPluginBase implements \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\views\Plugin\views\field\MultiItemsFieldHandlerInterface, \Drupal\views\Plugin\DependentWithRemovalPluginInterface uses \Drupal\views\FieldAPIHandlerTrait, \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\DependencyInjection\DeprecatedServicePropertyTrait
        class \Drupal\views\Plugin\views\field\Field extends \Drupal\views\Plugin\views\field\EntityField

Expanded class hierarchy of Field

Deprecated

in drupal:8.3.0 and is removed from drupal:9.0.0. Use \Drupal\views\Plugin\views\field\EntityField instead.

File

core/modules/views/src/Plugin/views/field/Field.php, line 21

Namespace

Drupal\views\Plugin\views\field

View source

class Field extends EntityField {
    
    /**
     * Field constructor.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, FormatterPluginManager $formatter_plugin_manager, FieldTypePluginManagerInterface $field_type_plugin_manager, LanguageManagerInterface $language_manager, RendererInterface $renderer, EntityRepositoryInterface $entity_repository = NULL, EntityFieldManagerInterface $entity_field_manager = NULL) {
        parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager, $formatter_plugin_manager, $field_type_plugin_manager, $language_manager, $renderer);
        @trigger_error(__CLASS__ . ' is deprecated in drupal:8.8.0 and is removed from drupal:9.0.0. Use \\Drupal\\views\\Plugin\\views\\field\\EntityField instead. See https://www.drupal.org/node/3089106', E_USER_DEPRECATED);
    }

}

Members

Title Sort descending	Deprecated	Modifiers	Object type	Summary	Overriden Title	Overrides
DependencyTrait::$dependencies		protected	property	The object's dependencies.
DependencyTrait::addDependencies		protected	function	Adds multiple dependencies.
DependencyTrait::addDependency		protected	function	Adds a dependency.
DeprecatedServicePropertyTrait::__get		public	function	Allows to access deprecated/removed properties.
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
EntityField::$base_table		public	property	A shortcut for $view->base_table.
EntityField::$deprecatedProperties		protected	property
EntityField::$entityFieldRenderer		protected	property	Static cache for ::getEntityFieldRenderer().
EntityField::$entityRepository		protected	property	The entity repository service.
EntityField::$entityTypeManager		protected	property	The entity typemanager.
EntityField::$fieldTypePluginManager		protected	property	The field type plugin manager.
EntityField::$formatterOptions		protected	property	An array of formatter options.
EntityField::$formatterPluginManager		protected	property	The field formatter plugin manager.
EntityField::$items		public	property	An array to store field renderable arrays for use by renderItems().
EntityField::$languageManager		protected	property	The language manager.
EntityField::$limit_values		public	property	Does the rendered fields get limited.
EntityField::$multiple		public	property	Does the field supports multiple field values.
EntityField::$renderer		protected	property	The renderer.	Overrides FieldPluginBase::$renderer
EntityField::access		public	function	Check whether given user has access to this handler.	Overrides HandlerBase::access
EntityField::addSelfTokens		protected	function	Add any special tokens this field might use for itself.	Overrides FieldPluginBase::addSelfTokens
EntityField::add_field_table		public	function	Determine if the field table should be added to the query.
EntityField::buildGroupByForm		public	function	Extend the groupby form with group columns.	Overrides HandlerBase::buildGroupByForm
EntityField::buildOptionsForm		public	function	Default options form that provides the label widget that all fields should have.	Overrides FieldPluginBase::buildOptionsForm	1
EntityField::calculateDependencies		public	function	Calculates dependencies for the configured plugin.	Overrides HandlerBase::calculateDependencies
EntityField::clickSort		public	function	Called to determine what to tell the clicksorter.	Overrides FieldPluginBase::clickSort	1
EntityField::clickSortable		public	function	Determines if this field is click sortable.	Overrides FieldPluginBase::clickSortable
EntityField::create		public static	function	Creates an instance of the plugin.	Overrides PluginBase::create
EntityField::createEntityForGroupBy		protected	function	Creates a fake entity with grouped field values.
EntityField::defineOptions		protected	function	Information about options for all kinds of purposes will be held here.	Overrides FieldPluginBase::defineOptions	1
EntityField::documentSelfTokens		protected	function	Document any special tokens this field might use for itself.	Overrides FieldPluginBase::documentSelfTokens
EntityField::getCacheContexts		public	function	The cache contexts associated with this object.	Overrides CacheableDependencyInterface::getCacheContexts
EntityField::getCacheMaxAge		public	function	The maximum age for which this object may be cached.	Overrides CacheableDependencyInterface::getCacheMaxAge
EntityField::getCacheTags		public	function	The cache tags associated with this object.	Overrides CacheableDependencyInterface::getCacheTags
EntityField::getEntityFieldRenderer		protected	function	Returns the entity field renderer.
EntityField::getFieldStorageDefinition		protected	function	Gets the field storage definition.	Overrides FieldAPIHandlerTrait::getFieldStorageDefinition
EntityField::getFormatterInstance		protected	function	Returns the field formatter instance.
EntityField::getItems		public	function	Gets an array of items for the field.	Overrides MultiItemsFieldHandlerInterface::getItems	3
EntityField::getTableMapping		protected	function	Gets the table mapping for the entity type of the field.
EntityField::getValue		public	function	Gets the value that's supposed to be rendered.	Overrides FieldPluginBase::getValue
EntityField::init		public	function	Initialize the plugin.	Overrides FieldPluginBase::init
EntityField::multiple_options_form		public	function	Provide options for multiple value fields.
EntityField::onDependencyRemoval		public	function	Allows a plugin to define whether it should be removed.	Overrides DependentWithRemovalPluginInterface::onDependencyRemoval
EntityField::prepareItemsByDelta		protected	function	Adapts the $items according to the delta configuration.
EntityField::preRender		public	function	Runs before any fields are rendered.	Overrides FieldPluginBase::preRender
EntityField::query		public	function	Called to add the field to a query.	Overrides FieldPluginBase::query
EntityField::renderItems		public	function	Render all items in this field together.	Overrides MultiItemsFieldHandlerInterface::renderItems
EntityField::render_item		public	function	Renders a single item of a row.	Overrides MultiItemsFieldHandlerInterface::render_item
EntityField::submitFormCalculateOptions		public	function	Calculates options stored on the handler	Overrides HandlerBase::submitFormCalculateOptions
EntityField::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.	Overrides HandlerBase::submitGroupByForm
Field::__construct		public	function	Field constructor.	Overrides EntityField::__construct
FieldAPIHandlerTrait::$entityFieldManager		protected	property	The entity field manager.
FieldAPIHandlerTrait::$fieldDefinition		protected	property	The field definition.
FieldAPIHandlerTrait::$fieldStorageDefinition		protected	property	The field storage definition.
FieldAPIHandlerTrait::getEntityFieldManager		protected	function	Returns the entity field manager.
FieldAPIHandlerTrait::getEntityManager	Deprecated	protected	function	Returns the entity manager.
FieldAPIHandlerTrait::getFieldDefinition		protected	function	Gets the field definition.
FieldPluginBase::$additional_fields		public	property	Stores additional fields which get added to the query.
FieldPluginBase::$aliases		public	property
FieldPluginBase::$field_alias		public	property
FieldPluginBase::$lastRenderIndex		protected	property	Keeps track of the last render index.
FieldPluginBase::$linkGenerator		protected	property	The link generator.
FieldPluginBase::$original_value		public	property	The field value prior to any rewriting.
FieldPluginBase::addAdditionalFields		protected	function	Add 'additional' fields to the query.
FieldPluginBase::adminLabel		public	function	Return a string representing this handler's name in the UI.	Overrides HandlerBase::adminLabel
FieldPluginBase::adminSummary		public	function	Provide extra data to the administration form	Overrides HandlerBase::adminSummary
FieldPluginBase::advancedRender		public	function	Renders a field using advanced settings.	Overrides FieldHandlerInterface::advancedRender
FieldPluginBase::allowAdvancedRender		protected	function	Determine if this field can allow advanced rendering.
FieldPluginBase::elementClasses		public	function	Returns the class of the field.	Overrides FieldHandlerInterface::elementClasses
FieldPluginBase::elementLabelClasses		public	function	Returns the class of the field's label.	Overrides FieldHandlerInterface::elementLabelClasses
FieldPluginBase::elementLabelType		public	function	Returns an HTML element for the label based upon the field's element type.	Overrides FieldHandlerInterface::elementLabelType
FieldPluginBase::elementType		public	function	Returns an HTML element based upon the field's element type.	Overrides FieldHandlerInterface::elementType	1
FieldPluginBase::elementWrapperClasses		public	function	Returns the class of the field's wrapper.	Overrides FieldHandlerInterface::elementWrapperClasses
FieldPluginBase::elementWrapperType		public	function	Returns an HTML element for the wrapper based upon the field's element type.	Overrides FieldHandlerInterface::elementWrapperType
FieldPluginBase::getElements		public	function	Provides a list of elements valid for field HTML.	Overrides FieldHandlerInterface::getElements
FieldPluginBase::getEntity		public	function	Gets the entity matching the current row and relationship.	Overrides FieldHandlerInterface::getEntity
FieldPluginBase::getFieldTokenPlaceholder		protected	function	Returns a token placeholder for the current field.
FieldPluginBase::getPreviousFieldLabels		protected	function	Returns all field labels of fields before this field.
FieldPluginBase::getRenderer		protected	function	Returns the render API renderer.	Overrides PluginBase::getRenderer
FieldPluginBase::getRenderTokens		public	function	Gets the 'render' tokens to use for advanced rendering.	Overrides FieldHandlerInterface::getRenderTokens
FieldPluginBase::getTokenValuesRecursive		protected	function	Recursive function to add replacements for nested query string parameters.
FieldPluginBase::isValueEmpty		public	function	Checks if a field value is empty.	Overrides FieldHandlerInterface::isValueEmpty
FieldPluginBase::label		public	function	Gets this field's label.	Overrides FieldHandlerInterface::label
FieldPluginBase::linkGenerator		protected	function	Gets the link generator.
FieldPluginBase::postRender		public	function	Runs after every field has been rendered.	Overrides FieldHandlerInterface::postRender
FieldPluginBase::render		public	function	Renders the field.	Overrides FieldHandlerInterface::render	27
FieldPluginBase::renderAltered		protected	function	Render this field as user-defined altered text.
FieldPluginBase::renderAsLink		protected	function	Render this field as a link, with the info from a fieldset set by the user.
FieldPluginBase::renderText		public	function	Performs an advanced text render for the item.	Overrides FieldHandlerInterface::renderText
FieldPluginBase::renderTrimText		protected	function	Trims the field down to the specified length.
FieldPluginBase::RENDER_TEXT_PHASE_COMPLETELY			constant	Indicator of the renderText() method for rendering the whole element. (if no render_item() method is available).
FieldPluginBase::RENDER_TEXT_PHASE_EMPTY			constant	Indicator of the renderText() method for rendering the empty text.
FieldPluginBase::RENDER_TEXT_PHASE_SINGLE_ITEM			constant	Indicator of the renderText() method for rendering a single item. (If no render_item() is present).
FieldPluginBase::submitOptionsForm		public	function	Performs some cleanup tasks on the options array before saving it.	Overrides PluginBase::submitOptionsForm	1
FieldPluginBase::theme		public	function	Passes values to drupal_render() using $this->themeFunctions() as #theme.	Overrides FieldHandlerInterface::theme
FieldPluginBase::themeFunctions		public	function	Provide a full list of possible theme templates used by this style.	Overrides PluginBase::themeFunctions
FieldPluginBase::tokenizeValue		public	function	Replaces a value with tokens from the last field.	Overrides FieldHandlerInterface::tokenizeValue
FieldPluginBase::trimText		public static	function	Trims the field down to the specified length.
FieldPluginBase::useStringGroupBy		public	function	Determines if this field will be available as an option to group the result by in the style settings.	Overrides FieldHandlerInterface::useStringGroupBy
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::$query		public	property	Where the $query object will reside:		7
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::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::buildExposeForm		public	function	Form for exposed handler options.		2
HandlerBase::buildExtraOptionsForm		public	function	Provide a form for setting options.		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::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::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::showExposeButton		public	function	Shortcut to display the expose/hide button.		2
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::submitTemporaryForm		public	function	A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests.
HandlerBase::usesGroupBy		public	function	Provides the handler some groupby.		13
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.
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::$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::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::getProvider		public	function	Returns the plugin provider.	Overrides ViewsPluginInterface::getProvider
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::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::trustedCallbacks		public static	function	Lists the trusted callbacks provided by the implementing class.	Overrides TrustedCallbackInterface::trustedCallbacks	6
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::validateOptionsForm		public	function	Validate the options form.	Overrides ViewsPluginInterface::validateOptionsForm	15
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.
PluginDependencyTrait::calculatePluginDependencies		protected	function	Calculates and adds dependencies of a specific plugin instance.		1
PluginDependencyTrait::getPluginDependencies		protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler		protected	function	Wraps the module handler.		1
PluginDependencyTrait::themeHandler		protected	function	Wraps the theme handler.		1
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
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.

class Field

Hierarchy

Deprecated

See also

File

Namespace

Members

Search drupal 8.9.x

API Navigation

Breadcrumb

class Field

Hierarchy

Deprecated

See also

File

Namespace

Members

Search drupal 8.9.x

API Navigation