public function BaseFieldDefinition::getColumns in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 core/lib/Drupal/Core/Field/BaseFieldDefinition.php \Drupal\Core\Field\BaseFieldDefinition::getColumns()

Returns the field columns, as defined in the field schema.

Return value

array[] The array of field columns, keyed by column name, in the same format returned by getSchema().

Overrides FieldStorageDefinitionInterface::getColumns

See also

\Drupal\Core\Field\FieldStorageDefinitionInterface::getSchema()

File

core/lib/Drupal/Core/Field/BaseFieldDefinition.php, line 661

Contains \Drupal\Core\Field\BaseFieldDefinition.

Class

BaseFieldDefinition

A class for defining entity fields.

Namespace

Drupal\Core\Field

Code

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'];
}