Field.php 19 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\field\FieldException;
14
use Drupal\field\FieldInterface;
15 16 17 18 19 20 21

/**
 * Defines the Field entity.
 *
 * @todo use 'field' as the id once hook_field_load() and friends
 * are removed.
 *
22
 * @EntityType(
23 24 25
 *   id = "field_entity",
 *   label = @Translation("Field"),
 *   module = "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 123 124 125 126

  /**
   * 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
   */
127
  public $cardinality = 1;
128 129 130 131 132 133 134 135

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

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

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

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

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

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

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

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

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

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

  /**
273 274 275 276 277 278 279 280 281
   * 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.
282 283 284
   */
  public function save() {
    // Clear the derived data about the field.
285
    unset($this->schema);
286 287

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

295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
  /**
   * 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);

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

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

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

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

350 351 352
    // 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'];
353

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

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

361 362
    return $result;
  }
363

364 365 366 367 368 369 370 371 372 373 374 375 376
  /**
   * 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();
377 378
    $entity_manager = \Drupal::entityManager();
    $storage_controller = $entity_manager->getStorageController($this->entityType);
379 380

    $original = $storage_controller->loadUnchanged($this->id());
381
    $this->original = $original;
382

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

    // 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().
398
    $module_handler->invokeAll('field_update_forbid', array($this, $original));
399

400 401 402 403
    // 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);
404 405 406 407 408 409 410 411 412 413 414 415 416

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

    return $result;
  }

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

      // Delete all non-deleted instances.
      $instance_ids = array();
422 423
      foreach ($this->getBundles() as $bundle) {
        $instance_ids[] = "{$this->entity_type}.$bundle.{$this->name}";
424
      }
425
      foreach ($instance_controller->loadMultiple($instance_ids) as $instance) {
426 427 428 429 430 431 432
        // 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);
      }

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

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

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

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

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

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

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

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

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

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

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

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

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

605 606 607 608 609 610 611 612
  /**
   * A list of columns that can not be used as field type columns.
   *
   * @return array
   */
  public static function getReservedColumns() {
    return array('deleted');
  }
613

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

    return FALSE;
  }
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669

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

670 671 672 673 674 675 676
  /**
   * {@inheritdoc}
   */
  public function isFieldConfigurable() {
    return TRUE;
  }

677
}