db =& $db; } //-------------------------------------------------------------------- /** * Provides access to the forge's current database connection. * * @return ConnectionInterface */ public function getConnection() { return $this->db; } //-------------------------------------------------------------------- /** * Create database * * @param string $db_name * * @return bool */ public function createDatabase($db_name) { if ($this->createDatabaseStr === false) { if ($this->db->DBDebug) { throw new DatabaseException('This feature is not available for the database you are using.'); } return false; } elseif ( ! $this->db->query(sprintf($this->createDatabaseStr, $db_name, $this->db->charset, $this->db->DBCollat)) ) { if ($this->db->DBDebug) { throw new DatabaseException('Unable to drop the specified database.'); } return false; } if ( ! empty($this->db->dataCache['db_names'])) { $this->db->dataCache['db_names'][] = $db_name; } return true; } //-------------------------------------------------------------------- /** * Drop database * * @param string $db_name * * @return bool */ public function dropDatabase($db_name) { if ($this->dropDatabaseStr === false) { if ($this->db->DBDebug) { throw new DatabaseException('This feature is not available for the database you are using.'); } return false; } elseif ( ! $this->db->query(sprintf($this->dropDatabaseStr, $db_name))) { if ($this->db->DBDebug) { throw new DatabaseException('Unable to drop the specified database.'); } return false; } if ( ! empty($this->db->dataCache['db_names'])) { $key = array_search(strtolower($db_name), array_map('strtolower', $this->db->dataCache['db_names']), true); if ($key !== false) { unset($this->db->dataCache['db_names'][$key]); } } return true; } //-------------------------------------------------------------------- /** * Add Key * * @param string $key * @param bool $primary * * @return CI_DB_forge */ public function addKey($key, $primary = false) { if ($primary === true) { foreach ((array) $key as $one) { $this->primaryKeys[] = $one; } } else { $this->keys[] = $key; } return $this; } //-------------------------------------------------------------------- /** * Add Field * * @param array $field * * @return CI_DB_forge */ public function addField($field) { if (is_string($field)) { if ($field === 'id') { $this->addField([ 'id' => [ 'type' => 'INT', 'constraint' => 9, 'auto_increment' => true, ], ]); $this->addKey('id', true); } else { if (strpos($field, ' ') === false) { throw new \InvalidArgumentException('Field information is required for that operation.'); } $this->fields[] = $field; } } if (is_array($field)) { $this->fields = array_merge($this->fields, $field); } return $this; } //-------------------------------------------------------------------- /** * Create Table * * @param string $table Table name * @param bool $if_not_exists Whether to add IF NOT EXISTS condition * @param array $attributes Associative array of table attributes * * @return bool * @throws \CodeIgniter\DatabaseException */ public function createTable($table, $if_not_exists = false, array $attributes = []) { if ($table === '') { throw new \InvalidArgumentException('A table name is required for that operation.'); } else { $table = $this->db->DBPrefix.$table; } if (count($this->fields) === 0) { throw new \RuntimeException('Field information is required.'); } $sql = $this->_createTable($table, $if_not_exists, $attributes); if (is_bool($sql)) { $this->_reset(); if ($sql === false) { if ($this->db->DBDebug) { throw new DatabaseException('This feature is not available for the database you are using.'); } return false; } } if (($result = $this->db->query($sql)) !== false) { empty($this->db->dataCache['table_names']) OR $this->db->dataCache['table_names'][] = $table; // Most databases don't support creating indexes from within the CREATE TABLE statement if ( ! empty($this->keys)) { for ($i = 0, $sqls = $this->_processIndexes($table), $c = count($sqls); $i < $c; $i++) { $this->db->query($sqls[$i]); } } } $this->_reset(); return $result; } //-------------------------------------------------------------------- /** * Create Table * * @param string $table Table name * @param bool $if_not_exists Whether to add 'IF NOT EXISTS' condition * @param array $attributes Associative array of table attributes * * @return mixed */ protected function _createTable($table, $if_not_exists, $attributes) { if ($if_not_exists === true && $this->createTableIfStr === false) { if ($this->db->tableExists($table)) { return true; } else { $if_not_exists = false; } } $sql = ($if_not_exists) ? sprintf($this->createTableIfStr, $this->db->escapeIdentifiers($table)) : 'CREATE TABLE'; $columns = $this->_processFields(true); for ($i = 0, $c = count($columns); $i < $c; $i++) { $columns[$i] = ($columns[$i]['_literal'] !== false) ? "\n\t".$columns[$i]['_literal'] : "\n\t".$this->_processColumn($columns[$i]); } $columns = implode(',', $columns) .$this->_processPrimaryKeys($table); // Are indexes created from within the CREATE TABLE statement? (e.g. in MySQL) if ($this->createTableKeys === true) { $columns .= $this->_processIndexes($table); } // createTableStr will usually have the following format: "%s %s (%s\n)" $sql = sprintf($this->createTableStr.'%s', $sql, $this->db->escapeIdentifiers($table), $columns, $this->_createTableAttributes($attributes) ); return $sql; } //-------------------------------------------------------------------- /** * CREATE TABLE attributes * * @param array $attributes Associative array of table attributes * * @return string */ protected function _createTableAttributes($attributes) { $sql = ''; foreach (array_keys($attributes) as $key) { if (is_string($key)) { $sql .= ' '.strtoupper($key).' '.$attributes[$key]; } } return $sql; } //-------------------------------------------------------------------- /** * Drop Table * * @param string $table_name Table name * @param bool $if_exists Whether to add an IF EXISTS condition * * @return bool */ public function dropTable($table_name, $if_exists = false) { if ($table_name === '') { if ($this->db->DBDebug) { throw new DatabaseException('A table name is required for that operation.'); } return false; } if (($query = $this->_dropTable($this->db->DBPrefix.$table_name, $if_exists)) === true) { return true; } $query = $this->db->query($query); // Update table list cache if ($query && ! empty($this->db->dataCache['table_names'])) { $key = array_search(strtolower($this->db->DBPrefix.$table_name), array_map('strtolower', $this->db->dataCache['table_names']), true); if ($key !== false) { unset($this->db->dataCache['table_names'][$key]); } } return $query; } //-------------------------------------------------------------------- /** * Drop Table * * Generates a platform-specific DROP TABLE string * * @param string $table Table name * @param bool $if_exists Whether to add an IF EXISTS condition * * @return string */ protected function _dropTable($table, $if_exists) { $sql = 'DROP TABLE'; if ($if_exists) { if ($this->dropTableIfStr === false) { if ( ! $this->db->tableExists($table)) { return true; } } else { $sql = sprintf($this->dropTableIfStr, $this->db->escapeIdentifiers($table)); } } return $sql.' '.$this->db->escapeIdentifiers($table); } //-------------------------------------------------------------------- /** * Rename Table * * @param string $table_name Old table name * @param string $new_table_name New table name * * @return bool */ public function renameTable($table_name, $new_table_name) { if ($table_name === '' OR $new_table_name === '') { throw new \InvalidArgumentException('A table name is required for that operation.'); } elseif ($this->renameTableStr === false) { if ($this->db->DBDebug) { throw new DatabaseException('This feature is not available for the database you are using.'); } return false; } $result = $this->db->query(sprintf($this->renameTableStr, $this->db->escapeIdentifiers($this->db->DBPrefix.$table_name), $this->db->escapeIdentifiers($this->db->DBPrefix.$new_table_name)) ); if ($result && ! empty($this->db->dataCache['table_names'])) { $key = array_search(strtolower($this->db->DBPrefix.$table_name), array_map('strtolower', $this->db->dataCache['table_names']), true); if ($key !== false) { $this->db->dataCache['table_names'][$key] = $this->db->DBPrefix.$new_table_name; } } return $result; } //-------------------------------------------------------------------- /** * Column Add * * @param string $table Table name * @param array $field Column definition * @param string $_after Column for AFTER clause (deprecated) * * @return bool */ public function addColumn($table, $field, $_after = null) { // Work-around for literal column definitions is_array($field) OR $field = [$field]; foreach (array_keys($field) as $k) { $this->addField([$k => $field[$k]]); } $sqls = $this->_alterTable('ADD', $this->db->DBPrefix.$table, $this->_processFields()); $this->_reset(); if ($sqls === false) { if ($this->db->DBDebug) { throw new DatabaseException('This feature is not available for the database you are using.'); } return false; } for ($i = 0, $c = count($sqls); $i < $c; $i++) { if ($this->db->query($sqls[$i]) === false) { return false; } } return true; } //-------------------------------------------------------------------- /** * Column Drop * * @param string $table Table name * @param string $column_name Column name * * @return bool */ public function dropColumn($table, $column_name) { $sql = $this->_alterTable('DROP', $this->db->DBPrefix.$table, $column_name); if ($sql === false) { if ($this->db->DBDebug) { throw new DatabaseException('This feature is not available for the database you are using.'); } return false; } return $this->db->query($sql); } //-------------------------------------------------------------------- /** * Column Modify * * @param string $table Table name * @param string $field Column definition * * @return bool */ public function modifyColumn($table, $field) { // Work-around for literal column definitions is_array($field) OR $field = [$field]; foreach (array_keys($field) as $k) { $this->addField([$k => $field[$k]]); } if (count($this->fields) === 0) { throw new \RuntimeException('Field information is required'); } $sqls = $this->_alterTable('CHANGE', $this->db->DBPrefix.$table, $this->_processFields()); $this->_reset(); if ($sqls === false) { if ($this->db->DBDebug) { throw new DatabaseException('This feature is not available for the database you are using.'); } return false; } for ($i = 0, $c = count($sqls); $i < $c; $i++) { if ($this->db->query($sqls[$i]) === false) { return false; } } return true; } //-------------------------------------------------------------------- /** * ALTER TABLE * * @param string $alter_type ALTER type * @param string $table Table name * @param mixed $field Column definition * * @return string|string[] */ protected function _alterTable($alter_type, $table, $field) { $sql = 'ALTER TABLE '.$this->db->escapeIdentifiers($table).' '; // DROP has everything it needs now. if ($alter_type === 'DROP') { return $sql.'DROP COLUMN '.$this->db->escapeIdentifiers($field); } $sql .= ($alter_type === 'ADD') ? 'ADD ' : $alter_type.' COLUMN '; $sqls = []; for ($i = 0, $c = count($field); $i < $c; $i++) { $sqls[] = $sql .($field[$i]['_literal'] !== false ? $field[$i]['_literal'] : $this->_processColumn($field[$i])); } return $sqls; } //-------------------------------------------------------------------- /** * Process fields * * @param bool $create_table * * @return array */ protected function _processFields($create_table = false) { $fields = []; foreach ($this->fields as $key => $attributes) { if (is_int($key) && ! is_array($attributes)) { $fields[] = ['_literal' => $attributes]; continue; } $attributes = array_change_key_case($attributes, CASE_UPPER); if ($create_table === true && empty($attributes['TYPE'])) { continue; } isset($attributes['TYPE']) && $this->_attributeType($attributes); $field = [ 'name' => $key, 'new_name' => isset($attributes['NAME']) ? $attributes['NAME'] : null, 'type' => isset($attributes['TYPE']) ? $attributes['TYPE'] : null, 'length' => '', 'unsigned' => '', 'null' => '', 'unique' => '', 'default' => '', 'auto_increment' => '', '_literal' => false, ]; isset($attributes['TYPE']) && $this->_attributeUnsigned($attributes, $field); if ($create_table === false) { if (isset($attributes['AFTER'])) { $field['after'] = $attributes['AFTER']; } elseif (isset($attributes['FIRST'])) { $field['first'] = (bool)$attributes['FIRST']; } } $this->_attributeDefault($attributes, $field); if (isset($attributes['NULL'])) { if ($attributes['NULL'] === true) { $field['null'] = empty($this->null) ? '' : ' '.$this->null; } else { $field['null'] = ' NOT NULL'; } } elseif ($create_table === true) { $field['null'] = ' NOT NULL'; } $this->_attributeAutoIncrement($attributes, $field); $this->_attributeUnique($attributes, $field); if (isset($attributes['COMMENT'])) { $field['comment'] = $this->db->escape($attributes['COMMENT']); } if (isset($attributes['TYPE']) && ! empty($attributes['CONSTRAINT'])) { switch (strtoupper($attributes['TYPE'])) { case 'ENUM': case 'SET': $attributes['CONSTRAINT'] = $this->db->escape($attributes['CONSTRAINT']); $field['length'] = is_array($attributes['CONSTRAINT']) ? "('".implode("','", $attributes['CONSTRAINT'])."')" : '('.$attributes['CONSTRAINT'].')'; break; default: $field['length'] = is_array($attributes['CONSTRAINT']) ? '('.implode(',', $attributes['CONSTRAINT']).')' : '('.$attributes['CONSTRAINT'].')'; break; } } $fields[] = $field; } return $fields; } //-------------------------------------------------------------------- /** * Process column * * @param array $field * * @return string */ protected function _processColumn($field) { return $this->db->escapeIdentifiers($field['name']) .' '.$field['type'].$field['length'] .$field['unsigned'] .$field['default'] .$field['null'] .$field['auto_increment'] .$field['unique']; } //-------------------------------------------------------------------- /** * Field attribute TYPE * * Performs a data type mapping between different databases. * * @param array &$attributes * * @return void */ protected function _attributeType(&$attributes) { // Usually overridden by drivers } //-------------------------------------------------------------------- /** * Field attribute UNSIGNED * * Depending on the unsigned property value: * * - TRUE will always set $field['unsigned'] to 'UNSIGNED' * - FALSE will always set $field['unsigned'] to '' * - array(TYPE) will set $field['unsigned'] to 'UNSIGNED', * if $attributes['TYPE'] is found in the array * - array(TYPE => UTYPE) will change $field['type'], * from TYPE to UTYPE in case of a match * * @param array &$attributes * @param array &$field * * @return void */ protected function _attributeUnsigned(&$attributes, &$field) { if (empty($attributes['UNSIGNED']) OR $attributes['UNSIGNED'] !== true) { return; } // Reset the attribute in order to avoid issues if we do type conversion $attributes['UNSIGNED'] = false; if (is_array($this->unsigned)) { foreach (array_keys($this->unsigned) as $key) { if (is_int($key) && strcasecmp($attributes['TYPE'], $this->unsigned[$key]) === 0) { $field['unsigned'] = ' UNSIGNED'; return; } elseif (is_string($key) && strcasecmp($attributes['TYPE'], $key) === 0) { $field['type'] = $key; return; } } return; } $field['unsigned'] = ($this->unsigned === true) ? ' UNSIGNED' : ''; } //-------------------------------------------------------------------- /** * Field attribute DEFAULT * * @param array &$attributes * @param array &$field * * @return void */ protected function _attributeDefault(&$attributes, &$field) { if ($this->default === false) { return; } if (array_key_exists('DEFAULT', $attributes)) { if ($attributes['DEFAULT'] === null) { $field['default'] = empty($this->null) ? '' : $this->default.$this->null; // Override the NULL attribute if that's our default $attributes['NULL'] = true; $field['null'] = empty($this->null) ? '' : ' '.$this->null; } else { $field['default'] = $this->default.$this->db->escape($attributes['DEFAULT']); } } } //-------------------------------------------------------------------- /** * Field attribute UNIQUE * * @param array &$attributes * @param array &$field * * @return void */ protected function _attributeUnique(&$attributes, &$field) { if ( ! empty($attributes['UNIQUE']) && $attributes['UNIQUE'] === true) { $field['unique'] = ' UNIQUE'; } } //-------------------------------------------------------------------- /** * Field attribute AUTO_INCREMENT * * @param array &$attributes * @param array &$field * * @return void */ protected function _attributeAutoIncrement(&$attributes, &$field) { if ( ! empty($attributes['AUTO_INCREMENT']) && $attributes['AUTO_INCREMENT'] === true && stripos($field['type'], 'int') !== false ) { $field['auto_increment'] = ' AUTO_INCREMENT'; } } //-------------------------------------------------------------------- /** * Process primary keys * * @param string $table Table name * * @return string */ protected function _processPrimaryKeys($table) { $sql = ''; for ($i = 0, $c = count($this->primaryKeys); $i < $c; $i++) { if ( ! isset($this->fields[$this->primaryKeys[$i]])) { unset($this->primaryKeys[$i]); } } if (count($this->primaryKeys) > 0) { $sql .= ",\n\tCONSTRAINT ".$this->db->escapeIdentifiers('pk_'.$table) .' PRIMARY KEY('.implode(', ', $this->db->escapeIdentifiers($this->primaryKeys)).')'; } return $sql; } //-------------------------------------------------------------------- /** * Process indexes * * @param string $table * * @return string */ protected function _processIndexes($table) { $sqls = []; for ($i = 0, $c = count($this->keys); $i < $c; $i++) { $this->keys[$i] = (array) $this->keys[$i]; for ($i2 = 0, $c2 = count($this->keys[$i]); $i2 < $c2; $i2++) { if ( ! isset($this->fields[$this->keys[$i][$i2]])) { unset($this->keys[$i][$i2]); } } if (count($this->keys[$i]) <= 0) { continue; } $sqls[] = 'CREATE INDEX '.$this->db->escapeIdentifiers($table.'_'.implode('_', $this->keys[$i])) .' ON '.$this->db->escapeIdentifiers($table) .' ('.implode(', ', $this->db->escapeIdentifiers($this->keys[$i])).');'; } return $sqls; } //-------------------------------------------------------------------- //-------------------------------------------------------------------- /** * Reset * * Resets table creation vars * * @return void */ protected function _reset() { $this->fields = $this->keys = $this->primaryKeys = []; } }