mirror of
https://github.com/yiisoft/yii2.git
synced 2026-03-06 15:28:58 +01:00
ba0ab403b5
* php-cs-fixer: PSR2 rule. * php-cs-fixer: PSR2 rule - fix views. * Travis setup refactoring. * Add php-cs-fixer to travis cs tests. * Fix tests on hhvm-3.12 * improve travis config * composer update * revert composer update * improve travis config * Fix CS. * Extract config to separate classes. * Extract config to separate classes. * Add file header. * Force short array syntax. * binary_operator_spaces fixer * Fix broken tests * cast_spaces fixer * concat_space fixer * dir_constant fixer * ereg_to_preg fixer * function_typehint_space fixer * hash_to_slash_comment fixer * is_null fixer * linebreak_after_opening_tag fixer * lowercase_cast fixer * magic_constant_casing fixer * modernize_types_casting fixer * native_function_casing fixer * new_with_braces fixer * no_alias_functions fixer * no_blank_lines_after_class_opening fixer * no_blank_lines_after_phpdoc fixer * no_empty_comment fixer * no_empty_phpdoc fixer * no_empty_statement fixer * no_extra_consecutive_blank_lines fixer * no_leading_import_slash fixer * no_leading_namespace_whitespace fixer * no_mixed_echo_print fixer * no_multiline_whitespace_around_double_arrow fixer * no_multiline_whitespace_before_semicolons fixer * no_php4_constructor fixer * no_short_bool_cast fixer * no_singleline_whitespace_before_semicolons fixer * no_spaces_around_offset fixer * no_trailing_comma_in_list_call fixer * no_trailing_comma_in_singleline_array fixer * no_unneeded_control_parentheses fixer * no_unused_imports fixer * no_useless_return fixer * no_whitespace_before_comma_in_array fixer * no_whitespace_in_blank_line fixer * not_operator_with_successor_space fixer * object_operator_without_whitespace fixer * ordered_imports fixer * php_unit_construct fixer * php_unit_dedicate_assert fixer * php_unit_fqcn_annotation fixer * phpdoc_indent fixer * phpdoc_no_access fixer * phpdoc_no_empty_return fixer * phpdoc_no_package fixer * phpdoc_no_useless_inheritdoc fixer * Fix broken tests * phpdoc_return_self_reference fixer * phpdoc_single_line_var_spacing fixer * phpdoc_single_line_var_spacing fixer * phpdoc_to_comment fixer * phpdoc_trim fixer * phpdoc_var_without_name fixer * psr4 fixer * self_accessor fixer * short_scalar_cast fixer * single_blank_line_before_namespace fixer * single_quote fixer * standardize_not_equals fixer * ternary_operator_spaces fixer * trailing_comma_in_multiline_array fixer * trim_array_spaces fixer * protected_to_private fixer * unary_operator_spaces fixer * whitespace_after_comma_in_array fixer * `parent::setRules()` -> `$this->setRules()` * blank_line_after_opening_tag fixer * Update finder config. * Revert changes for YiiRequirementChecker. * Fix array formatting. * Add missing import. * Fix CS for new code merged from master. * Fix some indentation issues.
104 lines
3.0 KiB
PHP
104 lines
3.0 KiB
PHP
<?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\InvalidParamException;
|
|
use yii\base\Object;
|
|
|
|
/**
|
|
* 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:
|
|
*
|
|
* ```php
|
|
* [
|
|
* '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}'.");
|
|
}
|
|
}
|
|
}
|
|
}
|