From 7171165697310c75a49ca414ec22e4ea05520700 Mon Sep 17 00:00:00 2001 From: Alex Pott Date: Sun, 10 May 2015 17:08:05 -0700 Subject: [PATCH] Issue #2471653 by bojanz, Kazanir: Standardize getter docblocks in Drupal\Core\Entity --- .../Drupal/Core/Entity/ContentEntityBase.php | 2 +- .../Entity/ContentEntityFormInterface.php | 4 +- .../Entity/Display/EntityDisplayInterface.php | 12 ++-- .../Display/EntityViewDisplayInterface.php | 4 +- core/lib/Drupal/Core/Entity/Entity.php | 10 ++-- .../Core/Entity/EntityAutocompleteMatcher.php | 2 +- .../Core/Entity/EntityChangedInterface.php | 2 +- .../Entity/EntityDefinitionUpdateManager.php | 2 +- ...EntityDefinitionUpdateManagerInterface.php | 2 +- .../Core/Entity/EntityDeleteFormTrait.php | 4 +- .../Drupal/Core/Entity/EntityDisplayBase.php | 4 +- .../Entity/EntityDisplayModeInterface.php | 2 +- core/lib/Drupal/Core/Entity/EntityForm.php | 2 +- .../Entity/EntityFormBuilderInterface.php | 2 +- .../Core/Entity/EntityFormInterface.php | 4 +- .../Drupal/Core/Entity/EntityHandlerBase.php | 2 +- .../Drupal/Core/Entity/EntityInterface.php | 32 +++++----- .../Drupal/Core/Entity/EntityListBuilder.php | 4 +- .../Entity/EntityListBuilderInterface.php | 2 +- core/lib/Drupal/Core/Entity/EntityManager.php | 6 +- .../Core/Entity/EntityManagerInterface.php | 26 ++++----- .../SelectionInterface.php | 2 +- .../SelectionPluginManagerInterface.php | 2 +- .../Core/Entity/EntityResolverManager.php | 2 +- .../Core/Entity/EntityStorageInterface.php | 8 +-- .../Entity/EntityTypeEventSubscriberTrait.php | 2 +- .../Core/Entity/EntityTypeInterface.php | 58 +++++++++---------- .../Drupal/Core/Entity/EntityViewBuilder.php | 4 +- .../Entity/EntityViewBuilderInterface.php | 8 +-- .../EntityWithPluginCollectionInterface.php | 2 +- .../Core/Entity/FieldableEntityInterface.php | 4 +- .../Plugin/DataType/EntityReference.php | 2 +- .../Entity/Query/QueryFactoryInterface.php | 2 +- .../Drupal/Core/Entity/Query/Sql/Query.php | 2 +- .../Drupal/Core/Entity/Query/Sql/Tables.php | 2 +- .../Core/Entity/Query/Sql/TablesInterface.php | 2 +- .../Core/Entity/RevisionableInterface.php | 4 +- .../Core/Entity/Sql/DefaultTableMapping.php | 2 +- .../Entity/Sql/SqlContentEntityStorage.php | 14 ++--- .../Sql/SqlContentEntityStorageSchema.php | 20 +++---- .../Core/Entity/Sql/TableMappingInterface.php | 14 ++--- .../EntityDataDefinitionInterface.php | 4 +- 42 files changed, 145 insertions(+), 145 deletions(-) diff --git a/core/lib/Drupal/Core/Entity/ContentEntityBase.php b/core/lib/Drupal/Core/Entity/ContentEntityBase.php index 16de8fb6d2..0aeb13f68b 100644 --- a/core/lib/Drupal/Core/Entity/ContentEntityBase.php +++ b/core/lib/Drupal/Core/Entity/ContentEntityBase.php @@ -981,7 +981,7 @@ public function referencedEntities() { } /** - * Returns the value of the given entity key, if defined. + * Gets the value of the given entity key, if defined. * * @param string $key * Name of the entity key, for example id, revision or bundle. diff --git a/core/lib/Drupal/Core/Entity/ContentEntityFormInterface.php b/core/lib/Drupal/Core/Entity/ContentEntityFormInterface.php index 4f130dc48b..8fae58efde 100644 --- a/core/lib/Drupal/Core/Entity/ContentEntityFormInterface.php +++ b/core/lib/Drupal/Core/Entity/ContentEntityFormInterface.php @@ -16,7 +16,7 @@ interface ContentEntityFormInterface extends EntityFormInterface { /** - * Returns the form display. + * Gets the form display. * * @param \Drupal\Core\Form\FormStateInterface $form_state * The current state of the form. @@ -40,7 +40,7 @@ public function getFormDisplay(FormStateInterface $form_state); public function setFormDisplay(EntityFormDisplayInterface $form_display, FormStateInterface $form_state); /** - * Returns the code identifying the active form language. + * Gets the code identifying the active form language. * * @param \Drupal\Core\Form\FormStateInterface $form_state * The current state of the form. diff --git a/core/lib/Drupal/Core/Entity/Display/EntityDisplayInterface.php b/core/lib/Drupal/Core/Entity/Display/EntityDisplayInterface.php index f128331d91..a49d223ebb 100644 --- a/core/lib/Drupal/Core/Entity/Display/EntityDisplayInterface.php +++ b/core/lib/Drupal/Core/Entity/Display/EntityDisplayInterface.php @@ -72,7 +72,7 @@ public function setComponent($name, array $options = array()); public function removeComponent($name); /** - * Returns the highest weight of the components in the display. + * Gets the highest weight of the components in the display. * * @return int|null * The highest weight of the components in the display, or NULL if the @@ -81,7 +81,7 @@ public function removeComponent($name); public function getHighestWeight(); /** - * Returns the renderer plugin for a field (e.g. widget, formatter). + * Gets the renderer plugin for a field (e.g. widget, formatter). * * @param string $field_name * The field name. @@ -92,7 +92,7 @@ public function getHighestWeight(); public function getRenderer($field_name); /** - * Returns the entity type for which this display is used. + * Gets the entity type for which this display is used. * * @return string * The entity type id. @@ -100,7 +100,7 @@ public function getRenderer($field_name); public function getTargetEntityTypeId(); /** - * Returns the view or form mode to be displayed. + * Gets the view or form mode to be displayed. * * @return string * The mode to be displayed. @@ -108,7 +108,7 @@ public function getTargetEntityTypeId(); public function getMode(); /** - * Returns the original view or form mode that was requested. + * Gets the original view or form mode that was requested. * * @return string * The original mode that was requested. @@ -116,7 +116,7 @@ public function getMode(); public function getOriginalMode(); /** - * Returns the bundle to be displayed. + * Gets the bundle to be displayed. * * @return string * The bundle to be displayed. diff --git a/core/lib/Drupal/Core/Entity/Display/EntityViewDisplayInterface.php b/core/lib/Drupal/Core/Entity/Display/EntityViewDisplayInterface.php index 3771d81433..ce54810225 100644 --- a/core/lib/Drupal/Core/Entity/Display/EntityViewDisplayInterface.php +++ b/core/lib/Drupal/Core/Entity/Display/EntityViewDisplayInterface.php @@ -15,7 +15,7 @@ interface EntityViewDisplayInterface extends EntityDisplayInterface { /** - * Returns a renderable array for the components of an entity. + * Builds a renderable array for the components of an entity. * * See the buildMultiple() method for details. * @@ -30,7 +30,7 @@ interface EntityViewDisplayInterface extends EntityDisplayInterface { public function build(FieldableEntityInterface $entity); /** - * Returns a renderable array for the components of a set of entities. + * Builds a renderable array for the components of a set of entities. * * This only includes the components handled by the Display object, but * excludes 'extra fields', that are typically rendered through specific, diff --git a/core/lib/Drupal/Core/Entity/Entity.php b/core/lib/Drupal/Core/Entity/Entity.php index a5c3d0f0a4..102b318478 100644 --- a/core/lib/Drupal/Core/Entity/Entity.php +++ b/core/lib/Drupal/Core/Entity/Entity.php @@ -67,7 +67,7 @@ public function __construct(array $values, $entity_type) { } /** - * Returns the entity manager. + * Gets the entity manager. * * @return \Drupal\Core\Entity\EntityManagerInterface */ @@ -76,7 +76,7 @@ protected function entityManager() { } /** - * Returns the language manager. + * Gets the language manager. * * @return \Drupal\Core\Language\LanguageManagerInterface */ @@ -85,7 +85,7 @@ protected function languageManager() { } /** - * Returns the UUID generator. + * Gets the UUID generator. * * @return \Drupal\Component\Uuid\UuidInterface */ @@ -235,7 +235,7 @@ public function hasLinkTemplate($rel) { } /** - * Returns an array link templates. + * Gets an array link templates. * * @return array * An array of link templates containing paths. @@ -274,7 +274,7 @@ public function url($rel = 'canonical', $options = array()) { } /** - * Returns an array of placeholders for this entity. + * Gets an array of placeholders for this entity. * * Individual entity classes may override this method to add additional * placeholders if desired. If so, they should be sure to replicate the diff --git a/core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php b/core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php index 0cf0edc03f..cf19b0c175 100644 --- a/core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php +++ b/core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php @@ -34,7 +34,7 @@ public function __construct(SelectionPluginManagerInterface $selection_manager) } /** - * Returns matched labels based on a given search string. + * Gets matched labels based on a given search string. * * @param string $target_type * The ID of the target entity type. diff --git a/core/lib/Drupal/Core/Entity/EntityChangedInterface.php b/core/lib/Drupal/Core/Entity/EntityChangedInterface.php index f5ee395420..3013f118aa 100644 --- a/core/lib/Drupal/Core/Entity/EntityChangedInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityChangedInterface.php @@ -22,7 +22,7 @@ interface EntityChangedInterface { /** - * Returns the timestamp of the last entity change. + * Gets the timestamp of the last entity change. * * @return int * The timestamp of the last entity save operation. diff --git a/core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManager.php b/core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManager.php index 99aa59d550..c2a6fad6ec 100644 --- a/core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManager.php +++ b/core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManager.php @@ -146,7 +146,7 @@ public function applyUpdates() { } /** - * Returns a list of changes to entity type and field storage definitions. + * Gets a list of changes to entity type and field storage definitions. * * @return array * An associative array keyed by entity type id of change descriptors. Every diff --git a/core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php b/core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php index 25bbdade1e..8eee170dfa 100644 --- a/core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php @@ -64,7 +64,7 @@ interface EntityDefinitionUpdateManagerInterface { public function needsUpdates(); /** - * Returns a human readable summary of the detected changes. + * Gets a human readable summary of the detected changes. * * @return array * An associative array keyed by entity type id. Each entry is an array of diff --git a/core/lib/Drupal/Core/Entity/EntityDeleteFormTrait.php b/core/lib/Drupal/Core/Entity/EntityDeleteFormTrait.php index 7e4ce04b88..d35bcea71a 100644 --- a/core/lib/Drupal/Core/Entity/EntityDeleteFormTrait.php +++ b/core/lib/Drupal/Core/Entity/EntityDeleteFormTrait.php @@ -22,7 +22,7 @@ trait EntityDeleteFormTrait { use ConfigDependencyDeleteFormTrait; /** - * Returns the entity of this form. + * Gets the entity of this form. * * Provided by \Drupal\Core\Entity\EntityForm. * @@ -62,7 +62,7 @@ public function getConfirmText() { } /** - * Returns the message to display to the user after deleting the entity. + * Gets the message to display to the user after deleting the entity. * * @return string * The translated string of the deletion message. diff --git a/core/lib/Drupal/Core/Entity/EntityDisplayBase.php b/core/lib/Drupal/Core/Entity/EntityDisplayBase.php index ca17e6410f..d5cda6511a 100644 --- a/core/lib/Drupal/Core/Entity/EntityDisplayBase.php +++ b/core/lib/Drupal/Core/Entity/EntityDisplayBase.php @@ -388,7 +388,7 @@ public function getHighestWeight() { } /** - * Returns the field definition of a field. + * Gets the field definition of a field. */ protected function getFieldDefinition($field_name) { $definitions = $this->getFieldDefinitions(); @@ -396,7 +396,7 @@ protected function getFieldDefinition($field_name) { } /** - * Returns the definitions of the fields that are candidate for display. + * Gets the definitions of the fields that are candidate for display. */ protected function getFieldDefinitions() { if (!isset($this->fieldDefinitions)) { diff --git a/core/lib/Drupal/Core/Entity/EntityDisplayModeInterface.php b/core/lib/Drupal/Core/Entity/EntityDisplayModeInterface.php index 0ed6b7143c..25753462c7 100644 --- a/core/lib/Drupal/Core/Entity/EntityDisplayModeInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityDisplayModeInterface.php @@ -15,7 +15,7 @@ interface EntityDisplayModeInterface extends ConfigEntityInterface { /** - * Returns the entity type this display mode is used for. + * Gets the entity type this display mode is used for. * * @return string * The entity type name. diff --git a/core/lib/Drupal/Core/Entity/EntityForm.php b/core/lib/Drupal/Core/Entity/EntityForm.php index fb015c767d..6d61d0c602 100644 --- a/core/lib/Drupal/Core/Entity/EntityForm.php +++ b/core/lib/Drupal/Core/Entity/EntityForm.php @@ -129,7 +129,7 @@ protected function init(FormStateInterface $form_state) { } /** - * Returns the actual form array to be built. + * Gets the actual form array to be built. * * @see \Drupal\Core\Entity\EntityForm::processForm() * @see \Drupal\Core\Entity\EntityForm::afterBuild() diff --git a/core/lib/Drupal/Core/Entity/EntityFormBuilderInterface.php b/core/lib/Drupal/Core/Entity/EntityFormBuilderInterface.php index 889ed6bf18..3549f4cef3 100644 --- a/core/lib/Drupal/Core/Entity/EntityFormBuilderInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityFormBuilderInterface.php @@ -13,7 +13,7 @@ interface EntityFormBuilderInterface { /** - * Returns the built and processed entity form for the given entity. + * Gets the built and processed entity form for the given entity. * * @param \Drupal\Core\Entity\EntityInterface $entity * The entity to be created or edited. diff --git a/core/lib/Drupal/Core/Entity/EntityFormInterface.php b/core/lib/Drupal/Core/Entity/EntityFormInterface.php index 29b248b0f2..26ce9098ab 100644 --- a/core/lib/Drupal/Core/Entity/EntityFormInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityFormInterface.php @@ -29,7 +29,7 @@ interface EntityFormInterface extends BaseFormIdInterface { public function setOperation($operation); /** - * Returns the operation identifying the form. + * Gets the operation identifying the form. * * @return string * The name of the operation. @@ -37,7 +37,7 @@ public function setOperation($operation); public function getOperation(); /** - * Returns the form entity. + * Gets the form entity. * * The form entity which has been used for populating form element defaults. * diff --git a/core/lib/Drupal/Core/Entity/EntityHandlerBase.php b/core/lib/Drupal/Core/Entity/EntityHandlerBase.php index 541fc51042..c3255426f2 100644 --- a/core/lib/Drupal/Core/Entity/EntityHandlerBase.php +++ b/core/lib/Drupal/Core/Entity/EntityHandlerBase.php @@ -28,7 +28,7 @@ abstract class EntityHandlerBase { protected $moduleHandler; /** - * Returns the module handler. + * Gets the module handler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface * The module handler. diff --git a/core/lib/Drupal/Core/Entity/EntityInterface.php b/core/lib/Drupal/Core/Entity/EntityInterface.php index 7b5ebc723b..284b39622b 100644 --- a/core/lib/Drupal/Core/Entity/EntityInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityInterface.php @@ -18,7 +18,7 @@ interface EntityInterface extends AccessibleInterface, CacheableDependencyInterface { /** - * Returns the entity UUID (Universally Unique Identifier). + * Gets the entity UUID (Universally Unique Identifier). * * The UUID is guaranteed to be unique and can be used to identify an entity * across multiple systems. @@ -29,7 +29,7 @@ interface EntityInterface extends AccessibleInterface, CacheableDependencyInterf public function uuid(); /** - * Returns the identifier. + * Gets the identifier. * * @return string|int|null * The entity identifier, or NULL if the object does not yet have an @@ -38,7 +38,7 @@ public function uuid(); public function id(); /** - * Returns the language of the entity. + * Gets the language of the entity. * * @return \Drupal\Core\Language\LanguageInterface * The language object. @@ -46,7 +46,7 @@ public function id(); public function language(); /** - * Returns whether the entity is new. + * Determines whether the entity is new. * * Usually an entity is new if no ID exists for it yet. However, entities may * be enforced to be new with existing IDs too. @@ -75,7 +75,7 @@ public function isNew(); public function enforceIsNew($value = TRUE); /** - * Returns the ID of the type of the entity. + * Gets the ID of the type of the entity. * * @return string * The entity type ID. @@ -83,7 +83,7 @@ public function enforceIsNew($value = TRUE); public function getEntityTypeId(); /** - * Returns the bundle of the entity. + * Gets the bundle of the entity. * * @return string * The bundle of the entity. Defaults to the entity type ID if the entity @@ -92,7 +92,7 @@ public function getEntityTypeId(); public function bundle(); /** - * Returns the label of the entity. + * Gets the label of the entity. * * @return string|null * The label of the entity, or NULL if there is no label defined. @@ -100,7 +100,7 @@ public function bundle(); public function label(); /** - * Returns the URI elements of the entity. + * Gets the URI elements of the entity. * * URI templates might be set in the links array in an annotation, for * example: @@ -131,7 +131,7 @@ public function label(); public function urlInfo($rel = 'canonical', array $options = array()); /** - * Returns the public URL for this entity. + * Gets the public URL for this entity. * * @param string $rel * The link relationship type, for example: canonical or edit-form. @@ -162,7 +162,7 @@ public function url($rel = 'canonical', $options = array()); public function link($text = NULL, $rel = 'canonical', array $options = []); /** - * Returns the internal path for this entity. + * Gets the internal path for this entity. * * self::url() will return the full path including any prefixes, fragments, or * query strings. This path does not include those. @@ -190,7 +190,7 @@ public function getSystemPath($rel = 'canonical'); public function hasLinkTemplate($key); /** - * Returns a list of URI relationships supported by this entity. + * Gets a list of URI relationships supported by this entity. * * @return string[] * An array of link relationships supported by this entity. @@ -341,7 +341,7 @@ public static function postLoad(EntityStorageInterface $storage, array &$entitie public function createDuplicate(); /** - * Returns the entity type definition. + * Gets the entity type definition. * * @return \Drupal\Core\Entity\EntityTypeInterface * The entity type definition. @@ -349,7 +349,7 @@ public function createDuplicate(); public function getEntityType(); /** - * Returns a list of entities referenced by this entity. + * Gets a list of entities referenced by this entity. * * @return \Drupal\Core\Entity\EntityInterface[] * An array of entities. @@ -357,7 +357,7 @@ public function getEntityType(); public function referencedEntities(); /** - * Returns the original ID. + * Gets the original ID. * * @return int|string|null * The original ID, or NULL if no ID was set or for entity types that do not @@ -377,7 +377,7 @@ public function getOriginalId(); public function setOriginalId($id); /** - * Returns an array of all property values. + * Gets an array of all property values. * * @return mixed[] * An array of property values, keyed by property name. @@ -385,7 +385,7 @@ public function setOriginalId($id); public function toArray(); /** - * Returns a typed data object for this entity object. + * Gets a typed data object for this entity object. * * The returned typed data object wraps this entity and allows dealing with * entities based on the generic typed data API. diff --git a/core/lib/Drupal/Core/Entity/EntityListBuilder.php b/core/lib/Drupal/Core/Entity/EntityListBuilder.php index 22322f8a21..dbc77c9403 100644 --- a/core/lib/Drupal/Core/Entity/EntityListBuilder.php +++ b/core/lib/Drupal/Core/Entity/EntityListBuilder.php @@ -101,7 +101,7 @@ protected function getEntityIds() { } /** - * Returns the escaped label of an entity. + * Gets the escaped label of an entity. * * @param \Drupal\Core\Entity\EntityInterface $entity * The entity being listed. @@ -234,7 +234,7 @@ public function render() { } /** - * Returns the title of the page. + * Gets the title of the page. * * @return string * A string title of the page. diff --git a/core/lib/Drupal/Core/Entity/EntityListBuilderInterface.php b/core/lib/Drupal/Core/Entity/EntityListBuilderInterface.php index fce074caa7..67e65a38c4 100644 --- a/core/lib/Drupal/Core/Entity/EntityListBuilderInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityListBuilderInterface.php @@ -48,7 +48,7 @@ public function load(); public function getOperations(EntityInterface $entity); /** - * Returns a listing of entities for the given entity type. + * Builds a listing of entities for the given entity type. * * @return array * A render array as expected by drupal_render(). diff --git a/core/lib/Drupal/Core/Entity/EntityManager.php b/core/lib/Drupal/Core/Entity/EntityManager.php index ae6009d3f6..a49377f597 100644 --- a/core/lib/Drupal/Core/Entity/EntityManager.php +++ b/core/lib/Drupal/Core/Entity/EntityManager.php @@ -913,7 +913,7 @@ public function getFormModes($entity_type_id) { } /** - * Returns the entity display mode info for all entity types. + * Gets the entity display mode info for all entity types. * * @param string $display_type * The display type to be retrieved. It can be "view_mode" or "form_mode". @@ -944,7 +944,7 @@ protected function getAllDisplayModesByEntityType($display_type) { } /** - * Returns the entity display mode info for a specific entity type. + * Gets the entity display mode info for a specific entity type. * * @param string $display_type * The display type to be retrieved. It can be "view_mode" or "form_mode". @@ -982,7 +982,7 @@ public function getFormModeOptions($entity_type, $include_disabled = FALSE) { } /** - * Returns an array of display mode options. + * Gets an array of display mode options. * * @param string $display_type * The display type to be retrieved. It can be "view_mode" or "form_mode". diff --git a/core/lib/Drupal/Core/Entity/EntityManagerInterface.php b/core/lib/Drupal/Core/Entity/EntityManagerInterface.php index b3bda8b24d..d75e28fd04 100644 --- a/core/lib/Drupal/Core/Entity/EntityManagerInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityManagerInterface.php @@ -118,7 +118,7 @@ public function getFieldStorageDefinitions($entity_type_id); public function getLastInstalledFieldStorageDefinitions($entity_type_id); /** - * Returns a lightweight map of fields across bundles. + * Gets a lightweight map of fields across bundles. * * @return array * An array keyed by entity type. Each value is an array which keys are @@ -129,7 +129,7 @@ public function getLastInstalledFieldStorageDefinitions($entity_type_id); public function getFieldMap(); /** - * Returns a lightweight map of fields across bundles filtered by field type. + * Gets a lightweight map of fields across bundles filtered by field type. * * @param string $field_type * The field type to filter by. @@ -280,7 +280,7 @@ public function getHandler($entity_type, $handler_type); public function createHandlerInstance($class, EntityTypeInterface $definition = null); /** - * Get the bundle info of an entity type. + * Gets the bundle info of an entity type. * * @param string $entity_type * The entity type. @@ -291,7 +291,7 @@ public function createHandlerInstance($class, EntityTypeInterface $definition = public function getBundleInfo($entity_type); /** - * Retrieves the "extra fields" for a bundle. + * Gets the "extra fields" for a bundle. * * @param string $entity_type_id * The entity type ID. @@ -320,7 +320,7 @@ public function getBundleInfo($entity_type); public function getExtraFields($entity_type_id, $bundle); /** - * Returns the entity translation to be used in the given context. + * Gets the entity translation to be used in the given context. * * This will check whether a translation for the desired language is available * and if not, it will fall back to the most appropriate translation based on @@ -350,7 +350,7 @@ public function getTranslationFromContext(EntityInterface $entity, $langcode = N public function getDefinition($entity_type_id, $exception_on_invalid = TRUE); /** - * Returns the entity type definition in its most recently installed state. + * Gets the entity type definition in its most recently installed state. * * During the application lifetime, entity type definitions can change. For * example, updated code can be deployed. The getDefinition() method will @@ -389,7 +389,7 @@ public function getLastInstalledDefinition($entity_type_id); public function getDefinitions(); /** - * Returns the entity view mode info for all entity types. + * Gets the entity view mode info for all entity types. * * @return array * The view mode info for all entity types. @@ -397,7 +397,7 @@ public function getDefinitions(); public function getAllViewModes(); /** - * Returns the entity view mode info for a specific entity type. + * Gets the entity view mode info for a specific entity type. * * @param string $entity_type_id * The entity type whose view mode info should be returned. @@ -408,7 +408,7 @@ public function getAllViewModes(); public function getViewModes($entity_type_id); /** - * Returns the entity form mode info for all entity types. + * Gets the entity form mode info for all entity types. * * @return array * The form mode info for all entity types. @@ -416,7 +416,7 @@ public function getViewModes($entity_type_id); public function getAllFormModes(); /** - * Returns the entity form mode info for a specific entity type. + * Gets the entity form mode info for a specific entity type. * * @param string $entity_type_id * The entity type whose form mode info should be returned. @@ -427,7 +427,7 @@ public function getAllFormModes(); public function getFormModes($entity_type_id); /** - * Returns an array of view mode options. + * Gets an array of view mode options. * * @param string $entity_type_id * The entity type whose view mode options should be returned. @@ -440,7 +440,7 @@ public function getFormModes($entity_type_id); public function getViewModeOptions($entity_type_id, $include_disabled = FALSE); /** - * Returns an array of form mode options. + * Gets an array of form mode options. * * @param string $entity_type_id * The entity type whose form mode options should be returned. @@ -492,7 +492,7 @@ public function loadEntityByUuid($entity_type_id, $uuid); public function loadEntityByConfigTarget($entity_type_id, $target); /** - * Returns the entity type ID based on the class that is called on. + * Gets the entity type ID based on the class that is called on. * * Compares the class this is called on against the known entity classes * and returns the entity type ID of a direct match or a subclass as fallback, diff --git a/core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionInterface.php b/core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionInterface.php index fb4ea5d44d..65d86c9aaf 100644 --- a/core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionInterface.php @@ -23,7 +23,7 @@ interface SelectionInterface extends PluginFormInterface { /** - * Returns a list of referenceable entities. + * Gets the list of referenceable entities. * * @return array * A nested array of entities, the first level is keyed by the diff --git a/core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionPluginManagerInterface.php b/core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionPluginManagerInterface.php index 278e3c4cc5..a3186111b6 100644 --- a/core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionPluginManagerInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionPluginManagerInterface.php @@ -30,7 +30,7 @@ interface SelectionPluginManagerInterface extends PluginManagerInterface { public function getPluginId($target_type, $base_plugin_id); /** - * Returns selection plugins that can reference a specific entity type. + * Gets the selection plugins that can reference a specific entity type. * * @param string $entity_type_id * A Drupal entity type ID. diff --git a/core/lib/Drupal/Core/Entity/EntityResolverManager.php b/core/lib/Drupal/Core/Entity/EntityResolverManager.php index 36a0abf0f1..cadd158363 100644 --- a/core/lib/Drupal/Core/Entity/EntityResolverManager.php +++ b/core/lib/Drupal/Core/Entity/EntityResolverManager.php @@ -217,7 +217,7 @@ public function setRouteOptions(Route $route) { } /** - * Returns a list of all entity types. + * Gets the list of all entity types. * * @return \Drupal\Core\Entity\EntityTypeInterface[] */ diff --git a/core/lib/Drupal/Core/Entity/EntityStorageInterface.php b/core/lib/Drupal/Core/Entity/EntityStorageInterface.php index 17a264bd44..98cd4b419a 100644 --- a/core/lib/Drupal/Core/Entity/EntityStorageInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityStorageInterface.php @@ -148,7 +148,7 @@ public function delete(array $entities); public function save(EntityInterface $entity); /** - * Returns an entity query instance. + * Gets an entity query instance. * * @param string $conjunction * (optional) The logical operator for the query, either: @@ -163,7 +163,7 @@ public function save(EntityInterface $entity); public function getQuery($conjunction = 'AND'); /** - * Returns an aggregated query instance. + * Gets an aggregated query instance. * * @param string $conjunction * (optional) The logical operator for the query, either: @@ -178,7 +178,7 @@ public function getQuery($conjunction = 'AND'); public function getAggregateQuery($conjunction = 'AND'); /** - * Returns the entity type ID. + * Gets the entity type ID. * * @return string * The entity type ID. @@ -186,7 +186,7 @@ public function getAggregateQuery($conjunction = 'AND'); public function getEntityTypeId(); /** - * Returns the entity type definition. + * Gets the entity type definition. * * @return \Drupal\Core\Entity\EntityTypeInterface * Entity type definition. diff --git a/core/lib/Drupal/Core/Entity/EntityTypeEventSubscriberTrait.php b/core/lib/Drupal/Core/Entity/EntityTypeEventSubscriberTrait.php index 1324d3a5b3..f63bc8f33a 100644 --- a/core/lib/Drupal/Core/Entity/EntityTypeEventSubscriberTrait.php +++ b/core/lib/Drupal/Core/Entity/EntityTypeEventSubscriberTrait.php @@ -19,7 +19,7 @@ trait EntityTypeEventSubscriberTrait { /** - * Returns the subscribed events. + * Gets the subscribed events. * * @return array * An array of subscribed event names. diff --git a/core/lib/Drupal/Core/Entity/EntityTypeInterface.php b/core/lib/Drupal/Core/Entity/EntityTypeInterface.php index 5963b37096..46c20583c8 100644 --- a/core/lib/Drupal/Core/Entity/EntityTypeInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityTypeInterface.php @@ -51,7 +51,7 @@ public function get($property); public function set($property, $value); /** - * Returns the unique identifier of the entity type. + * Gets the unique identifier of the entity type. * * @return string * The unique identifier of the entity type. @@ -59,7 +59,7 @@ public function set($property, $value); public function id(); /** - * Returns the name of the provider of this entity type. + * Gets the name of the provider of this entity type. * * @return string * The name of the provider of this entity type. @@ -67,7 +67,7 @@ public function id(); public function getProvider(); /** - * Returns the name of the entity type class. + * Gets the name of the entity type class. * * @return string * The name of the entity type class. @@ -75,7 +75,7 @@ public function getProvider(); public function getClass(); /** - * Returns the name of the original entity type class. + * Gets the name of the original entity type class. * * In case the class name was changed with setClass(), this will return * the initial value. Useful when trying to identify the entity type ID based @@ -87,7 +87,7 @@ public function getClass(); public function getOriginalClass(); /** - * Returns an array of entity keys. + * Gets an array of entity keys. * * @return array * An array describing how the Field API can extract certain information @@ -120,7 +120,7 @@ public function getOriginalClass(); public function getKeys(); /** - * Returns a specific entity key. + * Gets a specific entity key. * * @param string $key * The name of the entity key to return. @@ -203,7 +203,7 @@ public function hasHandlerClass($handler_type, $nested = FALSE); public function getHandlerClass($handler_type); /** - * Returns an array of handlers. + * Gets an array of handlers. * * @return array * An associative array where the keys are the names of different handler @@ -233,7 +233,7 @@ public function getHandlerClass($handler_type); public function getHandlerClasses(); /** - * Returns the storage class. + * Gets the storage class. * * @return string * The class for this entity type's storage. @@ -251,7 +251,7 @@ public function getStorageClass(); public function setStorageClass($class); /** - * Returns the form class for a specific operation. + * Gets the form class for a specific operation. * * @param string $operation * The name of the operation to use, e.g., 'default'. @@ -303,7 +303,7 @@ public function hasRouteProviders(); public function getRouteProviderClasses(); /** - * Returns the list class. + * Gets the list class. * * @return string * The class for this entity type's list. @@ -329,7 +329,7 @@ public function setListBuilderClass($class); public function hasListBuilderClass(); /** - * Returns the view builder class. + * Gets the view builder class. * * @return string * The class for this entity type's view builder. @@ -337,7 +337,7 @@ public function hasListBuilderClass(); public function getViewBuilderClass(); /** - * Returns the view builder class. + * Gets the view builder class. * * @param string $class * The class for this entity type's view builder. @@ -355,7 +355,7 @@ public function setViewBuilderClass($class); public function hasViewBuilderClass(); /** - * Returns the access control class. + * Gets the access control class. * * @return string * The class for this entity type's access control. @@ -363,7 +363,7 @@ public function hasViewBuilderClass(); public function getAccessControlClass(); /** - * Returns the access class. + * Gets the access class. * * @param string $class * The class for this entity type's access. @@ -396,7 +396,7 @@ public function isSubclassOf($class); public function setHandlerClass($handler_type, $value); /** - * Returns the name of the default administrative permission. + * Gets the name of the default administrative permission. * * The default \Drupal\Core\Entity\EntityAccessControlHandler class checks this * permission for all operations in its checkAccess() method. Entities with @@ -408,7 +408,7 @@ public function setHandlerClass($handler_type, $value); public function getAdminPermission(); /** - * Returns the permission granularity level. + * Gets the permission granularity level. * * The allowed values are respectively "entity_type" or "bundle". * @@ -419,7 +419,7 @@ public function getAdminPermission(); public function getPermissionGranularity(); /** - * Returns link templates using the URI template syntax. + * Gets the link templates using the URI template syntax. * * Links are an array of standard link relations to the URI template that * should be used for them. Where possible, link relationships should use @@ -449,7 +449,7 @@ public function getPermissionGranularity(); public function getLinkTemplates(); /** - * Returns the link template for a given key. + * Gets the link template for a given key. * * @param string $key * The link type. @@ -523,14 +523,14 @@ public function setLabelCallback($callback); public function hasLabelCallback(); /** - * Returns the name of the entity type which provides bundles. + * Gets the name of the entity type which provides bundles. * * @return string */ public function getBundleEntityType(); /** - * Returns the entity type for which this entity provides bundles. + * Gets the entity type for which this entity provides bundles. * * It can be used by other modules to act accordingly; for example, * the Field UI module uses it to add operation links to manage fields and @@ -543,7 +543,7 @@ public function getBundleEntityType(); public function getBundleOf(); /** - * Returns the label for the bundle. + * Gets the label for the bundle. * * @return string|null * The bundle label, or NULL if none exists. @@ -551,7 +551,7 @@ public function getBundleOf(); public function getBundleLabel(); /** - * Returns the name of the entity's base table. + * Gets the name of the entity's base table. * * @todo Used by SqlContentEntityStorage only. * @@ -578,7 +578,7 @@ public function isTranslatable(); public function isRevisionable(); /** - * Returns the name of the entity's revision data table. + * Gets the name of the entity's revision data table. * * @todo Used by SqlContentEntityStorage only. * @@ -589,7 +589,7 @@ public function isRevisionable(); public function getRevisionDataTable(); /** - * Returns the name of the entity's revision table. + * Gets the name of the entity's revision table. * * @todo Used by SqlContentEntityStorage only. * @@ -599,7 +599,7 @@ public function getRevisionDataTable(); public function getRevisionTable(); /** - * Returns the name of the entity's data table. + * Gets the name of the entity's data table. * * @todo Used by SqlContentEntityStorage only. * @@ -609,7 +609,7 @@ public function getRevisionTable(); public function getDataTable(); /** - * Returns the human-readable name of the entity type. + * Gets the human-readable name of the entity type. * * @return string * The human-readable name of the entity type. @@ -617,7 +617,7 @@ public function getDataTable(); public function getLabel(); /** - * Returns the lowercase form of the human-readable entity type name. + * Gets the lowercase form of the human-readable entity type name. * * @return string * The lowercase form of the human-readable entity type name. @@ -625,7 +625,7 @@ public function getLabel(); public function getLowercaseLabel(); /** - * Returns a callable that can be used to provide the entity URI. + * Gets a callable that can be used to provide the entity URI. * * This is only called if there is no matching link template for the link * relationship type, and there is no bundle-specific callback provided. @@ -684,7 +684,7 @@ public function getConfigDependencyKey(); public function isCommonReferenceTarget(); /** - * Returns an array of validation constraints. + * Gets an array of validation constraints. * * See \Drupal\Core\TypedData\DataDefinitionInterface::getConstraints() for * details on how constraints are defined. diff --git a/core/lib/Drupal/Core/Entity/EntityViewBuilder.php b/core/lib/Drupal/Core/Entity/EntityViewBuilder.php index 6d2caf7de0..e9fdb13b04 100644 --- a/core/lib/Drupal/Core/Entity/EntityViewBuilder.php +++ b/core/lib/Drupal/Core/Entity/EntityViewBuilder.php @@ -378,7 +378,7 @@ public function resetCache(array $entities = NULL) { } /** - * Returns TRUE if the view mode is cacheable. + * Determines whether the view mode is cacheable. * * @param string $view_mode * Name of the view mode that should be rendered. @@ -437,7 +437,7 @@ public function viewFieldItem(FieldItemInterface $item, $display = array()) { } /** - * Returns an EntityViewDisplay for rendering an individual field. + * Gets an EntityViewDisplay for rendering an individual field. * * @param \Drupal\Core\Entity\EntityInterface $entity * The entity. diff --git a/core/lib/Drupal/Core/Entity/EntityViewBuilderInterface.php b/core/lib/Drupal/Core/Entity/EntityViewBuilderInterface.php index c3e167a013..0549060729 100644 --- a/core/lib/Drupal/Core/Entity/EntityViewBuilderInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityViewBuilderInterface.php @@ -36,7 +36,7 @@ interface EntityViewBuilderInterface { public function buildComponents(array &$build, array $entities, array $displays, $view_mode, $langcode = NULL); /** - * Returns the render array for the provided entity. + * Builds the render array for the provided entity. * * @param \Drupal\Core\Entity\EntityInterface $entity * The entity to render. @@ -58,7 +58,7 @@ public function buildComponents(array &$build, array $entities, array $displays, public function view(EntityInterface $entity, $view_mode = 'full', $langcode = NULL); /** - * Returns the render array for the provided entities. + * Builds the render array for the provided entities. * * @param array $entities * An array of entities implementing EntityInterface to view. @@ -89,7 +89,7 @@ public function viewMultiple(array $entities = array(), $view_mode = 'full', $la public function resetCache(array $entities = NULL); /** - * Returns a renderable array for the value of a single field in an entity. + * Builds a renderable array for the value of a single field in an entity. * * The resulting output is a fully themed field with label and multiple * values. @@ -133,7 +133,7 @@ public function resetCache(array $entities = NULL); public function viewField(FieldItemListInterface $items, $display_options = array()); /** - * Returns a renderable array for a single field item. + * Builds a renderable array for a single field item. * * @param \Drupal\Core\Field\FieldItemInterface $item * FieldItem to be displayed. diff --git a/core/lib/Drupal/Core/Entity/EntityWithPluginCollectionInterface.php b/core/lib/Drupal/Core/Entity/EntityWithPluginCollectionInterface.php index dd92a5acce..3cc13e0fcd 100644 --- a/core/lib/Drupal/Core/Entity/EntityWithPluginCollectionInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityWithPluginCollectionInterface.php @@ -17,7 +17,7 @@ interface EntityWithPluginCollectionInterface extends EntityInterface { /** - * Returns the plugin collections used by this entity. + * Gets the plugin collections used by this entity. * * @return \Drupal\Component\Plugin\LazyPluginCollection[] * An array of plugin collections, keyed by the property name they use to diff --git a/core/lib/Drupal/Core/Entity/FieldableEntityInterface.php b/core/lib/Drupal/Core/Entity/FieldableEntityInterface.php index 566f9b276f..813a91039d 100644 --- a/core/lib/Drupal/Core/Entity/FieldableEntityInterface.php +++ b/core/lib/Drupal/Core/Entity/FieldableEntityInterface.php @@ -99,7 +99,7 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type); public static function bundleFieldDefinitions(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions); /** - * Returns whether the entity has a field with the given name. + * Determines whether the entity has a field with the given name. * * @param string $field_name * The field name. @@ -131,7 +131,7 @@ public function getFieldDefinition($name); public function getFieldDefinitions(); /** - * Returns an array of all field values. + * Gets an array of all field values. * * Gets an array of plain field values, including only non-computed values. * Note that the structure varies by entity type and bundle. diff --git a/core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php b/core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php index 0bf641d220..00590a545f 100644 --- a/core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php +++ b/core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php @@ -46,7 +46,7 @@ class EntityReference extends DataReferenceBase { protected $id; /** - * Returns the definition of the referenced entity. + * Gets the definition of the referenced entity. * * @return \Drupal\Core\Entity\TypedData\EntityDataDefinitionInterface * The reference target's definition. diff --git a/core/lib/Drupal/Core/Entity/Query/QueryFactoryInterface.php b/core/lib/Drupal/Core/Entity/Query/QueryFactoryInterface.php index c42635ccbb..7b57d7e781 100644 --- a/core/lib/Drupal/Core/Entity/Query/QueryFactoryInterface.php +++ b/core/lib/Drupal/Core/Entity/Query/QueryFactoryInterface.php @@ -27,7 +27,7 @@ interface QueryFactoryInterface { public function get(EntityTypeInterface $entity_type, $conjunction); /** - * Returns a aggregation query object for a given entity type. + * Instantiates an aggregation query object for a given entity type. * * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type * The entity type definition. diff --git a/core/lib/Drupal/Core/Entity/Query/Sql/Query.php b/core/lib/Drupal/Core/Entity/Query/Sql/Query.php index 626961724d..62e04f9a33 100644 --- a/core/lib/Drupal/Core/Entity/Query/Sql/Query.php +++ b/core/lib/Drupal/Core/Entity/Query/Sql/Query.php @@ -288,7 +288,7 @@ protected function getSqlField($field, $langcode) { } /** - * Returns whether the query requires GROUP BY and ORDER BY MIN/MAX. + * Determines whether the query requires GROUP BY and ORDER BY MIN/MAX. * * @return bool */ diff --git a/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php b/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php index 31925b40a8..98f4f843a4 100644 --- a/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php +++ b/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php @@ -289,7 +289,7 @@ protected function addJoin($type, $table, $join_condition, $langcode) { } /** - * Returns the schema for the given table. + * Gets the schema for the given table. * * @param string $table * The table name. diff --git a/core/lib/Drupal/Core/Entity/Query/Sql/TablesInterface.php b/core/lib/Drupal/Core/Entity/Query/Sql/TablesInterface.php index 0301396a9e..c80554367c 100644 --- a/core/lib/Drupal/Core/Entity/Query/Sql/TablesInterface.php +++ b/core/lib/Drupal/Core/Entity/Query/Sql/TablesInterface.php @@ -34,7 +34,7 @@ interface TablesInterface { public function addField($field, $type, $langcode); /** - * Returns whether the given field is case sensitive. + * Determines whether the given field is case sensitive. * * This information can only be provided after it was added with addField(). * diff --git a/core/lib/Drupal/Core/Entity/RevisionableInterface.php b/core/lib/Drupal/Core/Entity/RevisionableInterface.php index 312d975722..f9433bcdc4 100644 --- a/core/lib/Drupal/Core/Entity/RevisionableInterface.php +++ b/core/lib/Drupal/Core/Entity/RevisionableInterface.php @@ -13,7 +13,7 @@ interface RevisionableInterface { /** - * Returns whether a new revision should be created on save. + * Determines whether a new revision should be created on save. * * @return bool * TRUE if a new revision should be created. @@ -36,7 +36,7 @@ public function isNewRevision(); public function setNewRevision($value = TRUE); /** - * Returns the revision identifier of the entity. + * Gets the revision identifier of the entity. * * @return * The revision identifier of the entity, or NULL if the entity does not diff --git a/core/lib/Drupal/Core/Entity/Sql/DefaultTableMapping.php b/core/lib/Drupal/Core/Entity/Sql/DefaultTableMapping.php index c51ef08708..ac12621d19 100644 --- a/core/lib/Drupal/Core/Entity/Sql/DefaultTableMapping.php +++ b/core/lib/Drupal/Core/Entity/Sql/DefaultTableMapping.php @@ -288,7 +288,7 @@ public function requiresDedicatedTableStorage(FieldStorageDefinitionInterface $s } /** - * Returns a list of dedicated table names for this mapping. + * Gets a list of dedicated table names for this mapping. * * @return string[] * An array of table names. diff --git a/core/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorage.php b/core/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorage.php index 924f6a8eae..f0a03f0a51 100644 --- a/core/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorage.php +++ b/core/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorage.php @@ -216,7 +216,7 @@ protected function initTableLayout() { } /** - * Returns the base table name. + * Gets the base table name. * * @return string * The table name. @@ -226,7 +226,7 @@ public function getBaseTable() { } /** - * Returns the revision table name. + * Gets the revision table name. * * @return string|false * The table name or FALSE if it is not available. @@ -236,7 +236,7 @@ public function getRevisionTable() { } /** - * Returns the data table name. + * Gets the data table name. * * @return string|false * The table name or FALSE if it is not available. @@ -246,7 +246,7 @@ public function getDataTable() { } /** - * Returns the revision data table name. + * Gets the revision data table name. * * @return string|false * The table name or FALSE if it is not available. @@ -256,7 +256,7 @@ public function getRevisionDataTable() { } /** - * Returns the entity type's storage schema object. + * Gets the entity type's storage schema object. * * @return \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema * The schema object. @@ -586,7 +586,7 @@ public function resetCache(array $ids = NULL) { } /** - * Returns the cache ID for the passed in entity ID. + * Builds the cache ID for the passed in entity ID. * * @param int $id * Entity ID for which the cache ID should be built. @@ -1781,7 +1781,7 @@ public function countFieldData($storage_definition, $as_bool = FALSE) { } /** - * Returns whether the passed field has been already deleted. + * Determines whether the passed field has been already deleted. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition * The field storage definition. diff --git a/core/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorageSchema.php b/core/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorageSchema.php index b0669697aa..b81f705432 100644 --- a/core/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorageSchema.php +++ b/core/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorageSchema.php @@ -108,7 +108,7 @@ public function __construct(EntityManagerInterface $entity_manager, ContentEntit } /** - * Returns the keyvalue collection for tracking the installed schema. + * Gets the keyvalue collection for tracking the installed schema. * * @return \Drupal\Core\KeyValueStore\KeyValueStoreInterface * @@ -473,7 +473,7 @@ protected function checkEntityType(EntityTypeInterface $entity_type) { } /** - * Returns the entity schema for the specified entity type. + * Gets the entity schema for the specified entity type. * * Entity types may override this method in order to optimize the generated * schema of the entity tables. However, only cross-field optimizations should @@ -578,7 +578,7 @@ protected function getEntitySchemaTables() { } /** - * Returns entity schema definitions for index and key definitions. + * Gets entity schema definitions for index and key definitions. * * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type * The entity type definition. @@ -616,7 +616,7 @@ protected function getEntitySchemaData(ContentEntityTypeInterface $entity_type, } /** - * Returns an index schema array for a given field. + * Gets an index schema array for a given field. * * @param string $field_name * The name of the field. @@ -633,7 +633,7 @@ protected function getFieldIndexes($field_name, array $field_schema, array $colu } /** - * Returns a unique key schema array for a given field. + * Gets a unique key schema array for a given field. * * @param string $field_name * The name of the field. @@ -650,7 +650,7 @@ protected function getFieldUniqueKeys($field_name, array $field_schema, array $c } /** - * Returns field schema data for the given key. + * Gets field schema data for the given key. * * @param string $field_name * The name of the field. @@ -720,7 +720,7 @@ protected function getFieldSchemaIdentifierName($entity_type_id, $field_name, $k } /** - * Returns field foreign keys. + * Gets field foreign keys. * * @param string $field_name * The name of the field. @@ -1389,7 +1389,7 @@ protected function updateSharedTableSchema(FieldStorageDefinitionInterface $stor } /** - * Returns the schema for a single field definition. + * Gets the schema for a single field definition. * * Entity types may override this method in order to optimize the generated * schema for given field. While all optimizations that apply to a single @@ -1533,7 +1533,7 @@ protected function addSharedTableFieldForeignKey(FieldStorageDefinitionInterface } /** - * Returns the SQL schema for a dedicated table. + * Gets the SQL schema for a dedicated table. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition * The field storage definition. @@ -1700,7 +1700,7 @@ protected function getDedicatedTableSchema(FieldStorageDefinitionInterface $stor } /** - * Returns the name to be used for the given entity index. + * Gets the name to be used for the given entity index. * * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type * The entity type. diff --git a/core/lib/Drupal/Core/Entity/Sql/TableMappingInterface.php b/core/lib/Drupal/Core/Entity/Sql/TableMappingInterface.php index 3c11df59ed..9d555a10c9 100644 --- a/core/lib/Drupal/Core/Entity/Sql/TableMappingInterface.php +++ b/core/lib/Drupal/Core/Entity/Sql/TableMappingInterface.php @@ -25,7 +25,7 @@ interface TableMappingInterface { /** - * Returns a list of table names for this mapping. + * Gets a list of table names for this mapping. * * @return string[] * An array of table names. @@ -33,7 +33,7 @@ interface TableMappingInterface { public function getTableNames(); /** - * Returns a list of all database columns for a given table. + * Gets a list of all database columns for a given table. * * @param string $table_name * The name of the table to return the columns for. @@ -45,7 +45,7 @@ public function getTableNames(); public function getAllColumns($table_name); /** - * Returns a list of names of fields stored in the specified table. + * Gets a list of names of fields stored in the specified table. * * @param string $table_name * The name of the table to return the field names for. @@ -56,7 +56,7 @@ public function getAllColumns($table_name); public function getFieldNames($table_name); /** - * Returns a mapping of field columns to database columns for a given field. + * Gets a mapping of field columns to database columns for a given field. * * @param string $field_name * The name of the entity field to return the column mapping for. @@ -69,7 +69,7 @@ public function getFieldNames($table_name); public function getColumnNames($field_name); /** - * Returns a list of extra database columns, which store denormalized data. + * Gets a list of extra database columns, which store denormalized data. * * These database columns do not belong to any entity fields. Any normalized * data that is stored should be associated with an entity field. @@ -83,7 +83,7 @@ public function getColumnNames($field_name); public function getExtraColumns($table_name); /** - * A list of columns that can not be used as field type columns. + * Gets the list of columns that can not be used as field type columns. * * @return array */ @@ -104,7 +104,7 @@ public function getReservedColumns(); public function getFieldColumnName(FieldStorageDefinitionInterface $storage_definition, $property_name); /** - * Returns the table name for a given column. + * Gets the table name for a given column. * * @param string $field_name * The name of the entity field to return the column mapping for. diff --git a/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinitionInterface.php b/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinitionInterface.php index 4d0a6c7d25..b597a47c65 100644 --- a/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinitionInterface.php +++ b/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinitionInterface.php @@ -15,7 +15,7 @@ interface EntityDataDefinitionInterface extends ComplexDataDefinitionInterface { /** - * Returns the entity type ID. + * Gets the entity type ID. * * @return string|null * The entity type ID, or NULL if the entity type is unknown. @@ -33,7 +33,7 @@ public function getEntityTypeId(); public function setEntityTypeId($entity_type_id); /** - * Returns the array of possible entity bundles. + * Gets the array of possible entity bundles. * * @return array|null * The array of possible bundles, or NULL for any. -- GitLab