Blame view

vendor/yiisoft/yii2/db/TableSchema.php 3.04 KB
abf1649b   andryeyev   Чистая установка ...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
  <?php
  /**
   * @link http://www.yiiframework.com/
   * @copyright Copyright (c) 2008 Yii Software LLC
   * @license http://www.yiiframework.com/license/
   */
  
  namespace yii\db;
  
  use yii\base\Object;
  use yii\base\InvalidParamException;
  
  /**
   * TableSchema represents the metadata of a database table.
   *
   * @property array $columnNames List of column names. This property is read-only.
   *
   * @author Qiang Xue <qiang.xue@gmail.com>
   * @since 2.0
   */
  class TableSchema extends Object
  {
      /**
       * @var string the name of the schema that this table belongs to.
       */
      public $schemaName;
      /**
       * @var string the name of this table. The schema name is not included. Use [[fullName]] to get the name with schema name prefix.
       */
      public $name;
      /**
       * @var string the full name of this table, which includes the schema name prefix, if any.
       * Note that if the schema name is the same as the [[Schema::defaultSchema|default schema name]],
       * the schema name will not be included.
       */
      public $fullName;
      /**
       * @var string[] primary keys of this table.
       */
      public $primaryKey = [];
      /**
       * @var string sequence name for the primary key. Null if no sequence.
       */
      public $sequenceName;
      /**
       * @var array foreign keys of this table. Each array element is of the following structure:
       *
       * ~~~
       * [
       *  'ForeignTableName',
       *  'fk1' => 'pk1',  // pk1 is in foreign table
       *  'fk2' => 'pk2',  // if composite foreign key
       * ]
       * ~~~
       */
      public $foreignKeys = [];
      /**
       * @var ColumnSchema[] column metadata of this table. Each array element is a [[ColumnSchema]] object, indexed by column names.
       */
      public $columns = [];
  
  
      /**
       * Gets the named column metadata.
       * This is a convenient method for retrieving a named column even if it does not exist.
       * @param string $name column name
       * @return ColumnSchema metadata of the named column. Null if the named column does not exist.
       */
      public function getColumn($name)
      {
          return isset($this->columns[$name]) ? $this->columns[$name] : null;
      }
  
      /**
       * Returns the names of all columns in this table.
       * @return array list of column names
       */
      public function getColumnNames()
      {
          return array_keys($this->columns);
      }
  
      /**
       * Manually specifies the primary key for this table.
       * @param string|array $keys the primary key (can be composite)
       * @throws InvalidParamException if the specified key cannot be found in the table.
       */
      public function fixPrimaryKey($keys)
      {
          $keys = (array) $keys;
          $this->primaryKey = $keys;
          foreach ($this->columns as $column) {
              $column->isPrimaryKey = false;
          }
          foreach ($keys as $key) {
              if (isset($this->columns[$key])) {
                  $this->columns[$key]->isPrimaryKey = true;
              } else {
                  throw new InvalidParamException("Primary key '$key' cannot be found in table '{$this->name}'.");
              }
          }
      }
  }