From 7485f62b3bbed387a5835d303631bebe7d11d42f Mon Sep 17 00:00:00 2001
From: Jennifer Hodgdon <yahgrp@poplarware.com>
Date: Mon, 10 Jun 2013 08:42:37 -0700
Subject: [PATCH] Issue #1968986 by jibran, swentel, smiletrl, aspilicious,
yched: Better documentation for Field and FieldInstance constructors
---
.../Drupal/field/Plugin/Core/Entity/Field.php | 19 ++++++++++++++-
.../Plugin/Core/Entity/FieldInstance.php | 23 ++++++++++++++++++-
2 files changed, 40 insertions(+), 2 deletions(-)
diff --git a/core/modules/field/lib/Drupal/field/Plugin/Core/Entity/Field.php b/core/modules/field/lib/Drupal/field/Plugin/Core/Entity/Field.php
index 262781ca9cbd..6c2e022e54ab 100644
--- a/core/modules/field/lib/Drupal/field/Plugin/Core/Entity/Field.php
+++ b/core/modules/field/lib/Drupal/field/Plugin/Core/Entity/Field.php
@@ -210,7 +210,24 @@ class Field extends ConfigEntityBase implements FieldInterface {
protected $storageDetails;
/**
- * {@inheritdoc}
+ * Constructs a Field object.
+ *
+ * @param array $values
+ * An array of field properties, keyed by property name. Most array
+ * elements will be used to set the corresponding properties on the class;
+ * see the class property documentation for details. Some array elements
+ * have special meanings and a few are required. Special elements are:
+ * - id: required. As a temporary Backwards Compatibility layer right now,
+ * a 'field_name' property can be accepted in place of 'id'.
+ * - type: required.
+ *
+ * In most cases, Field entities are created via
+ * entity_create('field_entity', $values)), where $values is the same
+ * parameter as in this constructor.
+ *
+ * @see entity_create()
+ *
+ * @ingroup field_crud
*/
public function __construct(array $values, $entity_type = 'field_entity') {
// Check required properties.
diff --git a/core/modules/field/lib/Drupal/field/Plugin/Core/Entity/FieldInstance.php b/core/modules/field/lib/Drupal/field/Plugin/Core/Entity/FieldInstance.php
index 66d8cbf2fdd3..11c185a00c79 100644
--- a/core/modules/field/lib/Drupal/field/Plugin/Core/Entity/FieldInstance.php
+++ b/core/modules/field/lib/Drupal/field/Plugin/Core/Entity/FieldInstance.php
@@ -201,7 +201,28 @@ class FieldInstance extends ConfigEntityBase implements FieldInstanceInterface {
protected $bundle_rename_allowed = FALSE;
/**
- * {@inheritdoc}
+ * Constructs a FieldInstance object.
+ *
+ * @param array $values
+ * An array of field instance properties, keyed by property name. Most
+ * array elements will be used to set the corresponding properties on the
+ * class; see the class property documentation for details. Some array
+ * elements have special meanings and a few are required; these special
+ * elements are:
+ * - field_name: optional. The name of the field this is an instance of.
+ * - field_uuid: optional. Either field_uuid or field_name is required
+ * to build field instance. field_name will gain higher priority.
+ * If field_name is not provided, field_uuid will be checked then.
+ * - entity_type: required.
+ * - bundle: required.
+ *
+ * In most cases, Field instance entities are created via
+ * entity_create('field_instance', $values)), where $values is the same
+ * parameter as in this constructor.
+ *
+ * @see entity_create()
+ *
+ * @ingroup field_crud
*/
public function __construct(array $values, $entity_type = 'field_instance') {
// Accept incoming 'field_name' instead of 'field_uuid', for easier DX on
--
GitLab