Field.php 19.3 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains \Drupal\field\Entity\Field.
6 7
 */

8
namespace Drupal\field\Entity;
9

10
use Drupal\Component\Utility\Unicode;
11
use Drupal\Core\Config\Entity\ConfigEntityBase;
12
use Drupal\Core\Entity\EntityInterface;
13
use Drupal\Core\Entity\EntityStorageControllerInterface;
14
use Drupal\field\FieldException;
15
use Drupal\field\FieldInterface;
16 17 18 19 20 21 22

/**
 * Defines the Field entity.
 *
 * @todo use 'field' as the id once hook_field_load() and friends
 * are removed.
 *
23
 * @EntityType(
24 25
 *   id = "field_entity",
 *   label = @Translation("Field"),
26
 *   controllers = {
27
 *     "storage" = "Drupal\field\FieldStorageController"
28
 *   },
29 30 31 32 33 34 35 36
 *   config_prefix = "field.field",
 *   entity_keys = {
 *     "id" = "id",
 *     "label" = "id",
 *     "uuid" = "uuid"
 *   }
 * )
 */
37
class Field extends ConfigEntityBase implements FieldInterface {
38 39

  /**
40
   * The maximum length of the field name, in characters.
41 42 43
   *
   * For fields created through Field UI, this includes the 'field_' prefix.
   */
44
  const NAME_MAX_LENGTH = 32;
45 46

  /**
47 48 49 50 51 52 53 54 55 56 57 58
   * The field ID.
   *
   * The ID consists of 2 parts: the entity type and the field name.
   *
   * Example: node.body, user.field_main_image.
   *
   * @var string
   */
  public $id;

  /**
   * The field name.
59 60
   *
   * This is the name of the property under which the field values are placed in
61 62
   * an entity: $entity->{$field_name}. The maximum length is
   * Field:NAME_MAX_LENGTH.
63 64 65 66 67
   *
   * Example: body, field_main_image.
   *
   * @var string
   */
68
  public $name;
69 70 71 72 73 74 75 76 77 78

  /**
   * The field UUID.
   *
   * This is assigned automatically when the field is created.
   *
   * @var string
   */
  public $uuid;

79 80 81 82 83 84 85
  /**
   * The name of the entity type the field can be attached to.
   *
   * @var string
   */
  public $entity_type;

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
  /**
   * The field type.
   *
   * Example: text, number_integer.
   *
   * @var string
   */
  public $type;

  /**
   * The name of the module that provides the field type.
   *
   * @var string
   */
  public $module;

  /**
   * Flag indicating whether the field type module is enabled.
   *
   * @var bool
   */
  public $active;

  /**
   * Field-type specific settings.
   *
   * An array of key/value pairs, The keys and default values are defined by the
113
   * field type.
114 115 116
   *
   * @var array
   */
117
  public $settings = array();
118 119 120 121 122

  /**
   * The field cardinality.
   *
   * The maximum number of values the field can hold. Possible values are
123 124
   * positive integers or FieldDefinitionInterface::CARDINALITY_UNLIMITED.
   * Defaults to 1.
125 126 127
   *
   * @var integer
   */
128
  public $cardinality = 1;
129 130 131 132 133 134 135 136

  /**
   * Flag indicating whether the field is translatable.
   *
   * Defaults to FALSE.
   *
   * @var bool
   */
137
  public $translatable = FALSE;
138 139 140 141 142 143 144 145 146 147 148 149 150

  /**
   * Flag indicating whether the field is available for editing.
   *
   * If TRUE, some actions not available though the UI (but are still possible
   * through direct API manipulation):
   * - field settings cannot be changed,
   * - new instances cannot be created
   * - existing instances cannot be deleted.
   * Defaults to FALSE.
   *
   * @var bool
   */
151
  public $locked = FALSE;
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168

  /**
   * The custom storage indexes for the field data storage.
   *
   * This set of indexes is merged with the "default" indexes specified by the
   * field type in hook_field_schema() to determine the actual set of indexes
   * that get created.
   *
   * The indexes are defined using the same definition format as Schema API
   * index specifications. Only columns that are part of the field schema, as
   * defined by the field type in hook_field_schema(), are allowed.
   *
   * Some storage backends might not support indexes, and discard that
   * information.
   *
   * @var array
   */
169
  public $indexes = array();
170 171 172 173 174 175 176 177 178 179 180 181 182 183

  /**
   * Flag indicating whether the field is deleted.
   *
   * The delete() method marks the field as "deleted" and removes the
   * corresponding entry from the config storage, but keeps its definition in
   * the state storage while field data is purged by a separate
   * garbage-collection process.
   *
   * Deleted fields stay out of the regular entity lifecycle (notably, their
   * values are not populated in loaded entities, and are not saved back).
   *
   * @var bool
   */
184
  public $deleted = FALSE;
185 186 187 188 189 190 191 192

  /**
   * The field schema.
   *
   * @var array
   */
  protected $schema;

193 194 195
  /**
   * The original field.
   *
196
   * @var \Drupal\field\Entity\Field
197 198 199
   */
  public $original = NULL;

200
  /**
201 202 203 204 205 206 207
   * 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:
208
   *   - name: required. As a temporary Backwards Compatibility layer right now,
209
   *     a 'field_name' property can be accepted in place of 'id'.
210
   *   - entity_type: required.
211 212 213 214 215 216 217 218 219
   *   - 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
220 221 222
   */
  public function __construct(array $values, $entity_type = 'field_entity') {
    // Check required properties.
223
    if (empty($values['name'])) {
224 225
      throw new FieldException('Attempt to create an unnamed field.');
    }
226
    if (!preg_match('/^[_a-z]+[_a-z0-9]*$/', $values['name'])) {
227 228
      throw new FieldException('Attempt to create a field with invalid characters. Only lowercase alphanumeric characters and underscores are allowed, and only lowercase letters and underscore are allowed as the first character');
    }
229 230 231 232 233 234
    if (empty($values['type'])) {
      throw new FieldException('Attempt to create a field with no type.');
    }
    if (empty($values['entity_type'])) {
      throw new FieldException('Attempt to create a field with no entity_type.');
    }
235 236 237 238

    parent::__construct($values, $entity_type);
  }

239 240 241 242 243 244 245
  /**
   * {@inheritdoc}
   */
  public function id() {
    return $this->entity_type . '.' . $this->name;
  }

246 247 248 249 250 251 252 253 254
  /**
   * {@inheritdoc}
   */
  public function getExportProperties() {
    $names = array(
      'id',
      'uuid',
      'status',
      'langcode',
255 256
      'name',
      'entity_type',
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
      'type',
      'settings',
      'module',
      'active',
      'locked',
      'cardinality',
      'translatable',
      'indexes',
    );
    $properties = array();
    foreach ($names as $name) {
      $properties[$name] = $this->get($name);
    }
    return $properties;
  }

  /**
274
   * Overrides \Drupal\Core\Entity\Entity::preSave().
275 276 277 278 279
   *
   * @throws \Drupal\field\FieldException
   *   If the field definition is invalid.
   * @throws \Drupal\Core\Entity\EntityStorageException
   *   In case of failures at the configuration storage level.
280
   */
281
  public function preSave(EntityStorageControllerInterface $storage_controller) {
282
    // Clear the derived data about the field.
283
    unset($this->schema);
284 285

    if ($this->isNew()) {
286
      return $this->preSaveNew($storage_controller);
287 288
    }
    else {
289
      return $this->preSaveUpdated($storage_controller);
290 291
    }
  }
292

293
  /**
294
   * Prepares saving a new field definition.
295
   *
296 297
   * @param \Drupal\Core\Entity\EntityStorageControllerInterface $storage_controller
   *   The entity storage controller.
298
   *
299
   * @throws \Drupal\field\FieldException If the field definition is invalid.
300
   */
301
   protected function preSaveNew(EntityStorageControllerInterface $storage_controller) {
302 303
    $entity_manager = \Drupal::entityManager();

304 305 306 307 308
    // Assign the ID.
    $this->id = $this->id();

    // Field name cannot be longer than Field::NAME_MAX_LENGTH characters. We
    // use Unicode::strlen() because the DB layer assumes that column widths
309
    // are given in characters rather than bytes.
310
    if (Unicode::strlen($this->name) > static::NAME_MAX_LENGTH) {
311
      throw new FieldException(format_string(
312 313 314
        'Attempt to create a field with an ID longer than @max characters: %name', array(
          '@max' => static::NAME_MAX_LENGTH,
          '%name' => $this->name,
315 316 317
        )
      ));
    }
318

319
    // Ensure the field name is unique (we do not care about deleted fields).
320
    if ($prior_field = $storage_controller->load($this->id)) {
321
      $message = $prior_field->active ?
322 323 324
        'Attempt to create field name %name which already exists and is active.' :
        'Attempt to create field name %name which already exists, although it is inactive.';
      throw new FieldException(format_string($message, array('%name' => $this->name)));
325
    }
326

327 328 329 330
    // Disallow reserved field names. This can't prevent all field name
    // collisions with existing entity properties, but some is better than
    // none.
    foreach ($entity_manager->getDefinitions() as $type => $info) {
331 332
      if (in_array($this->name, $info['entity_keys'])) {
        throw new FieldException(format_string('Attempt to create field %name which is reserved by entity type %type.', array('%name' => $this->name, '%type' => $type)));
333
      }
334 335 336
    }

    // Check that the field type is known.
337
    $field_type = \Drupal::service('plugin.manager.field.field_type')->getDefinition($this->type);
338 339 340
    if (!$field_type) {
      throw new FieldException(format_string('Attempt to create a field of unknown type %type.', array('%type' => $this->type)));
    }
341
    $this->module = $field_type['provider'];
342
    $this->active = TRUE;
343

344 345 346
    // Make sure all settings are present, so that a complete field
    // definition is passed to the various hooks and written to config.
    $this->settings += $field_type['settings'];
347

348 349
    // Notify the entity storage controller.
    $entity_manager->getStorageController($this->entity_type)->onFieldCreate($this);
350
  }
351

352
  /**
353
   * Prepares saving an updated field definition.
354
   *
355 356
   * @param \Drupal\Core\Entity\EntityStorageControllerInterface $storage_controller
   *   The entity storage controller.
357
   */
358
  protected function preSaveUpdated(EntityStorageControllerInterface $storage_controller) {
359
    $module_handler = \Drupal::moduleHandler();
360
    $entity_manager = \Drupal::entityManager();
361
    $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
362

363
    // Some updates are always disallowed.
364
    if ($this->type != $this->original->type) {
365 366
      throw new FieldException("Cannot change an existing field's type.");
    }
367
    if ($this->entity_type != $this->original->entity_type) {
368
      throw new FieldException("Cannot change an existing field's entity_type.");
369 370
    }

371 372 373
    // Make sure all settings are present, so that a complete field
    // definition is passed to the various hooks and written to config.
    $this->settings += $field_type_manager->getDefaultSettings($this->type);
374 375 376

    // See if any module forbids the update by throwing an exception. This
    // invokes hook_field_update_forbid().
377
    $module_handler->invokeAll('field_update_forbid', array($this, $this->original));
378

379 380 381
    // Notify the storage controller. The controller can reject the definition
    // update as invalid by raising an exception, which stops execution before
    // the definition is written to config.
382 383
    $entity_manager->getStorageController($this->entity_type)->onFieldUpdate($this);
  }
384

385 386 387 388 389
  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageControllerInterface $storage_controller, $update = TRUE) {
    // Clear the cache.
390 391 392 393 394 395
    field_cache_clear();
  }

  /**
   * {@inheritdoc}
   */
396 397 398 399 400 401 402 403 404 405 406 407 408
  public static function preDelete(EntityStorageControllerInterface $storage_controller, array $fields) {
    $state = \Drupal::state();
    $instance_controller = \Drupal::entityManager()->getStorageController('field_instance');

    // Delete instances first. Note: when deleting a field through
    // FieldInstance::postDelete(), the instances have been deleted already, so
    // no instances will be found here.
    $instance_ids = array();
    foreach ($fields as $field) {
      if (!$field->deleted) {
        foreach ($field->getBundles() as $bundle) {
          $instance_ids[] = "{$field->entity_type}.$bundle.{$field->name}";
        }
409
      }
410 411 412 413 414 415
    }
    if ($instance_ids) {
      $instances = $instance_controller->loadMultiple($instance_ids);
      // Tag the objects to preserve recursive deletion of the field.
      foreach ($instances as $instance) {
        $instance->noFieldDelete = TRUE;
416
      }
417 418
      $instance_controller->delete($instances);
    }
419

420 421 422 423 424 425 426 427 428 429 430 431 432
    // Keep the field definitions in the state storage so we can use them later
    // during field_purge_batch().
    $deleted_fields = $state->get('field.field.deleted') ?: array();
    foreach ($fields as $field) {
      if (!$field->deleted) {
        $config = $field->getExportProperties();
        $config['deleted'] = TRUE;
        $config['bundles'] = $field->getBundles();
        $deleted_fields[$field->uuid] = $config;
      }
    }
    $state->set('field.field.deleted', $deleted_fields);
  }
433

434 435 436 437 438 439 440 441 442
  /**
   * {@inheritdoc}
   */
  public static function postDelete(EntityStorageControllerInterface $storage_controller, array $fields) {
    // Notify the storage.
    foreach ($fields as $field) {
      if (!$field->deleted) {
        \Drupal::entityManager()->getStorageController($field->entity_type)->onFieldDelete($field);
      }
443
    }
444 445 446

    // Clear the cache.
    field_cache_clear();
447 448 449
  }

  /**
450
   * {@inheritdoc}
451 452 453
   */
  public function getSchema() {
    if (!isset($this->schema)) {
454
      // Get the schema from the field item class.
455
      $definition = \Drupal::service('plugin.manager.field.field_type')->getDefinition($this->type);
456 457 458 459
      $class = $definition['class'];
      $schema = $class::schema($this);
      // Fill in default values for optional entries.
      $schema += array('indexes' => array(), 'foreign keys' => array());
460 461

      // Check that the schema does not include forbidden column names.
462
      if (array_intersect(array_keys($schema['columns']), static::getReservedColumns())) {
463 464 465 466 467 468 469 470 471 472 473 474 475
        throw new FieldException('Illegal field type columns.');
      }

      // Merge custom indexes with those specified by the field type. Custom
      // indexes prevail.
      $schema['indexes'] = $this->indexes + $schema['indexes'];

      $this->schema = $schema;
    }

    return $this->schema;
  }

476 477 478 479 480 481 482 483 484 485 486 487 488 489
  /**
   * {@inheritdoc}
   */
  public function getColumns() {
    $schema = $this->getSchema();
    // A typical use case for the method is to iterate on the columns, while
    // some other use cases rely on identifying the first column with the key()
    // function. Since the schema is persisted in the Field object, we take care
    // of resetting the array pointer so that the former does not interfere with
    // the latter.
    reset($schema['columns']);
    return $schema['columns'];
  }

490
  /**
491
   * {@inheritdoc}
492 493 494 495
   */
  public function getBundles() {
    if (empty($this->deleted)) {
      $map = field_info_field_map();
496 497
      if (isset($map[$this->entity_type][$this->name]['bundles'])) {
        return $map[$this->entity_type][$this->name]['bundles'];
498 499 500 501 502
      }
    }
    return array();
  }

503 504 505 506
  /**
   * {@inheritdoc}
   */
  public function getFieldName() {
507
    return $this->name;
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldType() {
    return $this->type;
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldSettings() {
    // @todo field_info_field_types() calls _field_info_collate_types() which
    //   maintains its own static cache. However, do some CPU and memory
    //   profiling to see if it's worth statically caching $field_type_info, or
    //   the default field and instance settings, within $this.
525
    $field_type_info = \Drupal::service('plugin.manager.field.field_type')->getDefinition($this->type);
526

527
    $settings = $this->settings + $field_type_info['settings'] + $field_type_info['instance_settings'];
528 529 530 531 532 533 534 535
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldSetting($setting_name) {
    // @todo See getFieldSettings() about potentially statically caching this.
536
    $field_type_info = \Drupal::service('plugin.manager.field.field_type')->getDefinition($this->type);
537 538 539

    // We assume here that consecutive array_key_exists() is more efficient than
    // calling getFieldSettings() when all we need is a single setting.
540
    if (array_key_exists($setting_name, $this->settings)) {
541 542
      return $this->settings[$setting_name];
    }
543
    elseif (array_key_exists($setting_name, $field_type_info['settings'])) {
544 545
      return $field_type_info['settings'][$setting_name];
    }
546
    elseif (array_key_exists($setting_name, $field_type_info['instance_settings'])) {
547 548
      return $field_type_info['instance_settings'][$setting_name];
    }
549 550 551
    else {
      return NULL;
    }
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldPropertyNames() {
    $schema = $this->getSchema();
    return array_keys($schema['columns']);
  }

  /**
   * {@inheritdoc}
   */
  public function isFieldTranslatable() {
    return $this->translatable;
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldLabel() {
    return $this->label();
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldDescription() {
    return '';
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldCardinality() {
    return $this->cardinality;
  }

  /**
   * {@inheritdoc}
   */
  public function isFieldRequired() {
    return FALSE;
  }

597 598 599 600 601 602 603 604
  /**
   * {@inheritdoc}
   */
  public function isFieldMultiple() {
    $cardinality = $this->getFieldCardinality();
    return ($cardinality == static::CARDINALITY_UNLIMITED) || ($cardinality > 1);
  }

605 606 607 608 609
  /**
   * {@inheritdoc}
   */
  public function getFieldDefaultValue(EntityInterface $entity) { }

610 611 612 613 614 615 616 617
  /**
   * A list of columns that can not be used as field type columns.
   *
   * @return array
   */
  public static function getReservedColumns() {
    return array('deleted');
  }
618

619 620 621 622 623 624 625
  /**
   * Determines whether a field has any data.
   *
   * @return
   *   TRUE if the field has data for any entity; FALSE otherwise.
   */
  public function hasData() {
626 627 628 629
    if ($this->getBundles()) {
      $storage_details = $this->getSchema();
      $columns = array_keys($storage_details['columns']);
      $factory = \Drupal::service('entity.query');
630
      // Entity Query throws an exception if there is no base table.
631
      $entity_info = \Drupal::entityManager()->getDefinition($this->entity_type);
632
      if (!isset($entity_info['base_table'])) {
633
        return FALSE;
634
      }
635
      $query = $factory->get($this->entity_type);
636 637
      $group = $query->orConditionGroup();
      foreach ($columns as $column) {
638
        $group->exists($this->name . '.' . $column);
639 640 641 642 643 644 645 646 647 648 649 650 651 652
      }
      $result = $query
        ->condition($group)
        ->count()
        ->accessCheck(FALSE)
        ->range(0, 1)
        ->execute();
      if ($result) {
        return TRUE;
      }
    }

    return FALSE;
  }
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674

  /**
   * Implements the magic __sleep() method.
   *
   * Using the Serialize interface and serialize() / unserialize() methods
   * breaks entity forms in PHP 5.4.
   * @todo Investigate in https://drupal.org/node/2074253.
   */
  public function __sleep() {
    // Only serialize properties from getExportProperties().
    return array_keys(array_intersect_key($this->getExportProperties(), get_object_vars($this)));
  }

  /**
   * Implements the magic __wakeup() method.
   */
  public function __wakeup() {
    // Run the values from getExportProperties() through __construct().
    $values = array_intersect_key($this->getExportProperties(), get_object_vars($this));
    $this->__construct($values);
  }

675 676 677 678 679 680 681
  /**
   * {@inheritdoc}
   */
  public function isFieldConfigurable() {
    return TRUE;
  }

682
}