Field.php 20 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\Entity\Annotation\EntityType;
12 13
use Drupal\Core\Annotation\Translation;
use Drupal\Core\Config\Entity\ConfigEntityBase;
14
use Drupal\Core\Entity\EntityInterface;
15
use Drupal\field\FieldException;
16
use Drupal\field\FieldInterface;
17 18 19 20 21 22 23

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

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

  /**
49 50 51 52 53 54 55 56 57 58 59 60
   * 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.
61 62
   *
   * This is the name of the property under which the field values are placed in
63 64
   * an entity: $entity->{$field_name}. The maximum length is
   * Field:NAME_MAX_LENGTH.
65 66 67 68 69
   *
   * Example: body, field_main_image.
   *
   * @var string
   */
70
  public $name;
71 72 73 74 75 76 77 78 79 80

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

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

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 113 114
  /**
   * 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
115
   * field type.
116 117 118
   *
   * @var array
   */
119
  public $settings = array();
120 121 122 123 124 125 126 127 128

  /**
   * The field cardinality.
   *
   * The maximum number of values the field can hold. Possible values are
   * positive integers or FIELD_CARDINALITY_UNLIMITED. Defaults to 1.
   *
   * @var integer
   */
129
  public $cardinality = 1;
130 131 132 133 134 135 136 137

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

  /**
   * 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
   */
152
  public $locked = FALSE;
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169

  /**
   * 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
   */
170
  public $indexes = array();
171 172 173 174 175 176 177 178 179 180 181 182 183 184

  /**
   * 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
   */
185
  public $deleted = FALSE;
186 187 188 189 190 191 192 193

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

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

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

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

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

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

  /**
275 276 277 278 279 280 281 282 283
   * Overrides \Drupal\Core\Entity\Entity::save().
   *
   * @return int
   *   Either SAVED_NEW or SAVED_UPDATED, depending on the operation performed.
   *
   * @throws \Drupal\field\FieldException
   *   If the field definition is invalid.
   * @throws \Drupal\Core\Entity\EntityStorageException
   *   In case of failures at the configuration storage level.
284 285 286
   */
  public function save() {
    // Clear the derived data about the field.
287
    unset($this->schema);
288 289

    if ($this->isNew()) {
290 291 292 293 294 295
      return $this->saveNew();
    }
    else {
      return $this->saveUpdated();
    }
  }
296

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
  /**
   * Saves a new field definition.
   *
   * @return int
   *   SAVED_NEW if the definition was saved.
   *
   * @throws \Drupal\field\FieldException
   *   If the field definition is invalid.
   * @throws \Drupal\Core\Entity\EntityStorageException
   *   In case of failures at the configuration storage level.
   */
  protected function saveNew() {
    $entity_manager = \Drupal::entityManager();
    $storage_controller = $entity_manager->getStorageController($this->entityType);

312 313 314 315 316
    // 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
317
    // are given in characters rather than bytes.
318
    if (Unicode::strlen($this->name) > static::NAME_MAX_LENGTH) {
319
      throw new FieldException(format_string(
320 321 322
        'Attempt to create a field with an ID longer than @max characters: %name', array(
          '@max' => static::NAME_MAX_LENGTH,
          '%name' => $this->name,
323 324 325
        )
      ));
    }
326

327
    // Ensure the field name is unique (we do not care about deleted fields).
328
    if ($prior_field = $storage_controller->load($this->id)) {
329
      $message = $prior_field->active ?
330 331 332
        '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)));
333
    }
334

335 336 337 338
    // 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) {
339 340
      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)));
341
      }
342 343 344
    }

    // Check that the field type is known.
345
    $field_type = \Drupal::service('plugin.manager.entity.field.field_type')->getDefinition($this->type);
346 347 348
    if (!$field_type) {
      throw new FieldException(format_string('Attempt to create a field of unknown type %type.', array('%type' => $this->type)));
    }
349
    $this->module = $field_type['provider'];
350
    $this->active = TRUE;
351

352 353 354
    // 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'];
355

356 357
    // Notify the entity storage controller.
    $entity_manager->getStorageController($this->entity_type)->onFieldCreate($this);
358

359 360 361
    // Save the configuration.
    $result = parent::save();
    field_cache_clear();
362

363 364
    return $result;
  }
365

366 367 368 369 370 371 372 373 374 375 376 377 378
  /**
   * Saves an updated field definition.
   *
   * @return int
   *   SAVED_UPDATED if the definition was saved.
   *
   * @throws \Drupal\field\FieldException
   *   If the field definition is invalid.
   * @throws \Drupal\Core\Entity\EntityStorageException
   *   In case of failures at the configuration storage level.
   */
  protected function saveUpdated() {
    $module_handler = \Drupal::moduleHandler();
379 380
    $entity_manager = \Drupal::entityManager();
    $storage_controller = $entity_manager->getStorageController($this->entityType);
381 382

    $original = $storage_controller->loadUnchanged($this->id());
383
    $this->original = $original;
384

385 386 387 388
    // Some updates are always disallowed.
    if ($this->type != $original->type) {
      throw new FieldException("Cannot change an existing field's type.");
    }
389 390
    if ($this->entity_type != $original->entity_type) {
      throw new FieldException("Cannot change an existing field's entity_type.");
391 392 393 394 395 396 397 398 399
    }

    // Make sure all settings are present, so that a complete field definition
    // is saved. This allows calling code to perform partial updates on field
    // objects.
    $this->settings += $original->settings;

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

402 403 404 405
    // 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.
    $entity_manager->getStorageController($this->entity_type)->onFieldUpdate($this, $original);
406 407 408 409 410 411 412 413 414 415 416 417 418

    // Save the configuration.
    $result = parent::save();
    field_cache_clear();

    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function delete() {
    if (!$this->deleted) {
419
      $instance_controller = \Drupal::entityManager()->getStorageController('field_instance');
420 421 422 423
      $state = \Drupal::state();

      // Delete all non-deleted instances.
      $instance_ids = array();
424 425
      foreach ($this->getBundles() as $bundle) {
        $instance_ids[] = "{$this->entity_type}.$bundle.{$this->name}";
426
      }
427
      foreach ($instance_controller->loadMultiple($instance_ids) as $instance) {
428 429 430 431 432 433 434
        // By default, FieldInstance::delete() will automatically try to delete
        // a field definition when it is deleting the last instance of the
        // field. Since the whole field is being deleted here, pass FALSE as
        // the $field_cleanup parameter to prevent a loop.
        $instance->delete(FALSE);
      }

435
      \Drupal::entityManager()->getStorageController($this->entity_type)->onFieldDelete($this);
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454

      // Delete the configuration of this field and save the field configuration
      // in the key_value table so we can use it later during
      // field_purge_batch(). This makes sure a new field can be created
      // immediately with the same name.
      $deleted_fields = $state->get('field.field.deleted') ?: array();
      $config = $this->getExportProperties();
      $config['deleted'] = TRUE;
      $deleted_fields[$this->uuid] = $config;
      $state->set('field.field.deleted', $deleted_fields);

      parent::delete();

      // Clear the cache.
      field_cache_clear();
    }
  }

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

      // Check that the schema does not include forbidden column names.
467
      if (array_intersect(array_keys($schema['columns']), static::getReservedColumns())) {
468 469 470 471 472 473 474 475 476 477 478 479 480
        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;
  }

481 482 483 484 485 486 487 488 489 490 491 492 493 494
  /**
   * {@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'];
  }

495
  /**
496
   * {@inheritdoc}
497 498 499 500
   */
  public function getBundles() {
    if (empty($this->deleted)) {
      $map = field_info_field_map();
501 502
      if (isset($map[$this->entity_type][$this->name]['bundles'])) {
        return $map[$this->entity_type][$this->name]['bundles'];
503 504 505 506 507
      }
    }
    return array();
  }

508 509 510 511
  /**
   * {@inheritdoc}
   */
  public function getFieldName() {
512
    return $this->name;
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
  }

  /**
   * {@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.
530
    $field_type_info = \Drupal::service('plugin.manager.entity.field.field_type')->getDefinition($this->type);
531

532
    $settings = $this->settings + $field_type_info['settings'] + $field_type_info['instance_settings'];
533 534 535 536 537 538 539 540
    return $settings;
  }

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

    // We assume here that consecutive array_key_exists() is more efficient than
    // calling getFieldSettings() when all we need is a single setting.
545
    if (array_key_exists($setting_name, $this->settings)) {
546 547
      return $this->settings[$setting_name];
    }
548
    elseif (array_key_exists($setting_name, $field_type_info['settings'])) {
549 550
      return $field_type_info['settings'][$setting_name];
    }
551 552 553
    else {
      return $field_type_info['instance_settings'][$setting_name];
    }
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 597 598
  }

  /**
   * {@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;
  }

599 600 601 602 603
  /**
   * {@inheritdoc}
   */
  public function getFieldDefaultValue(EntityInterface $entity) { }

604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
  /**
   * {@inheritdoc}
   */
  public function offsetExists($offset) {
    return isset($this->{$offset}) || in_array($offset, array('columns', 'foreign keys', 'bundles', 'storage_details'));
  }

  /**
   * {@inheritdoc}
   */
  public function &offsetGet($offset) {
    switch ($offset) {
      case 'id':
        return $this->uuid;

      case 'field_name':
620
        return $this->name;
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655

      case 'columns':
        $this->getSchema();
        return $this->schema['columns'];

      case 'foreign keys':
        $this->getSchema();
        return $this->schema['foreign keys'];

      case 'bundles':
        $bundles = $this->getBundles();
        return $bundles;
    }

    return $this->{$offset};
  }

  /**
   * {@inheritdoc}
   */
  public function offsetSet($offset, $value) {
    if (!in_array($offset, array('columns', 'foreign keys', 'bundles', 'storage_details'))) {
      $this->{$offset} = $value;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function offsetUnset($offset) {
    if (!in_array($offset, array('columns', 'foreign keys', 'bundles', 'storage_details'))) {
      unset($this->{$offset});
    }
  }

656 657 658 659 660 661 662 663
  /**
   * A list of columns that can not be used as field type columns.
   *
   * @return array
   */
  public static function getReservedColumns() {
    return array('deleted');
  }
664

665 666 667 668 669 670 671
  /**
   * Determines whether a field has any data.
   *
   * @return
   *   TRUE if the field has data for any entity; FALSE otherwise.
   */
  public function hasData() {
672 673 674 675
    if ($this->getBundles()) {
      $storage_details = $this->getSchema();
      $columns = array_keys($storage_details['columns']);
      $factory = \Drupal::service('entity.query');
676
      // Entity Query throws an exception if there is no base table.
677
      $entity_info = \Drupal::entityManager()->getDefinition($this->entity_type);
678
      if (!isset($entity_info['base_table'])) {
679
        return FALSE;
680
      }
681
      $query = $factory->get($this->entity_type);
682 683
      $group = $query->orConditionGroup();
      foreach ($columns as $column) {
684
        $group->exists($this->name . '.' . $column);
685 686 687 688 689 690 691 692 693 694 695 696 697 698
      }
      $result = $query
        ->condition($group)
        ->count()
        ->accessCheck(FALSE)
        ->range(0, 1)
        ->execute();
      if ($result) {
        return TRUE;
      }
    }

    return FALSE;
  }
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720

  /**
   * 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);
  }

721
}