class UniqueKey

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Database/SchemaDefinition/UniqueKey.php \Drupal\Core\Database\SchemaDefinition\UniqueKey

Describes a database unique key.

Hierarchy

Expanded class hierarchy of UniqueKey

2 files declare their use of UniqueKey
SchemaDefinitionConversionTest.php in core/tests/Drupal/Tests/Core/Database/SchemaDefinitionConversionTest.php
SchemaDefinitionTest.php in core/tests/Drupal/Tests/Core/Database/SchemaDefinitionTest.php

File

View on git.drupalcode.org

core/lib/Drupal/Core/Database/SchemaDefinition/UniqueKey.php, line 10

Namespace

Drupal\Core\Database\SchemaDefinition
View source 
final class UniqueKey extends KeyBase {
  
  /**
   * Constructor.
   *
   * @param string $name
   *   The unique key name.
   * @param list<KeyColumn|string> $columns
   *   A mix of key column specifiers, being KeyColumn objects, strings naming
   *   columns, or arrays of two elements, column name and length, specifying a
   *   prefix of the named column.
   */
  public function __construct(public readonly string $name, array $columns) {
    parent::__construct($columns, FALSE);
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
KeyBase::$columns public property The key columns.
KeyBase::buildKeyColumns protected function Builds an array of KeyColumn objects from a mixed list of columns.
KeyBase::toArray public function Converts the object to legacy array-based specifications. Overrides SchemaDefinitionInterface::toArray 1
UniqueKey::__construct public function Constructor. Overrides KeyBase::__construct

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.