Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #1837022 by yched: Fixed Field API comment fixes.

8.0.x
webchick 2012-11-13 21:14:18 -08:00
parent 3337298bc1
commit d249e95a99
2 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
core/modules/field/field.info.inc
View File

@ -399,13 +399,13 @@ function field_info_field_by_ids() {
/** /**
* Retrieves information about field instances. * Retrieves information about field instances.
* *
* Use of this function to retriev instances across separate bundles (i.e. when * Use of this function to retrieve instances across separate bundles (i.e.
* the $bundle parameter is NULL) should be avoided when possible, since it * when the $bundle parameter is NULL) should be avoided when possible, since
* loads and statically caches a potentially large array of information. Use * it loads and statically caches a potentially large array of information.
* field_info_field_map() instead. * Use field_info_field_map() instead.
* *
* When retrieving the instances of a specific bundle (i.e. when both * When retrieving the instances of a specific bundle (i.e. when both
* $entity_type and $bundle_name are provided, the function also populates a * $entity_type and $bundle_name are provided), the function also populates a
* static cache with the corresponding field definitions, allowing fast * static cache with the corresponding field definitions, allowing fast
* retrieval of field_info_field() later in the request. * retrieval of field_info_field() later in the request.
* *

9
core/modules/field/lib/Drupal/field/FieldInfo.php
View File

@ -13,8 +13,8 @@ use Drupal\Core\Cache\CacheBackendInterface;
* Provides field and instance definitions for the current runtime environment. * Provides field and instance definitions for the current runtime environment.
* *
* A Drupal\field\FieldInfo object is created and statically persisted through * A Drupal\field\FieldInfo object is created and statically persisted through
* the request by the field_info_cache() function. The object properties act as * the request by the _field_info_field_cache() function. The object properties
* a "static cache" of fields and instances definitions. * act as a "static cache" of fields and instances definitions.
* *
* The preferred way to access definitions is through the getBundleInstances() * The preferred way to access definitions is through the getBundleInstances()
* method, which keeps cache entries per bundle, storing both fields and * method, which keeps cache entries per bundle, storing both fields and
@ -61,7 +61,7 @@ class FieldInfo {
protected $loadedAllFields = FALSE; protected $loadedAllFields = FALSE;
/** /**
* Separately tracks requested field names or IDs that do not exists. * Separately tracks requested field names or IDs that do not exist.
* *
* @var array * @var array
*/ */
@ -203,9 +203,6 @@ class FieldInfo {
/** /**
* Retrieves all active, non-deleted instances definitions. * Retrieves all active, non-deleted instances definitions.
* *
* This method does not read from nor populate the "static" and persistent
* caches.
*
* @param $entity_type * @param $entity_type
* (optional) The entity type. * (optional) The entity type.
* *