CI_DB_mysqli_forge Class Reference

Inheritance diagram for CI_DB_mysqli_forge:

[legend]

Collaboration diagram for CI_DB_mysqli_forge:

[legend]

List of all members.

Public Member Functions
	_create_database ($name)
	Create database.
	_drop_database ($name)
	Drop database.
	_process_fields ($fields)
	Process Fields.
	_create_table ($table, $fields, $primary_keys, $keys, $if_not_exists)
	Create Table.
	_drop_table ($table)
	Drop Table.
	_alter_table ($alter_type, $table, $fields, $after_field= '')
	Alter table query.
	_rename_table ($table_name, $new_table_name)
	Rename a table.

---

Detailed Description

Definition at line 25 of file mysqli_forge.php.

---

Member Function Documentation

CI_DB_mysqli_forge::_alter_table	(	$	alter_type,
		$	table,
		$	fields,
		$	after_field = ''
	)

Alter table query.

Generates a platform-specific query so that a table can be altered Called by add_column(), drop_column(), and column_alter(),

private

Parameters:

	string	the ALTER type (ADD, DROP, CHANGE)
	string	the column name
	array	fields
	string	the field after which we should add the new field

Returns:

object

Definition at line 213 of file mysqli_forge.php.

References CI_DB_forge::$fields, and _process_fields().

        {
                $sql = 'ALTER TABLE '.$this->db->_protect_identifiers($table)." $alter_type ";

                // DROP has everything it needs now.
                if ($alter_type == 'DROP')
                {
                        return $sql.$this->db->_protect_identifiers($fields);
                }

                $sql .= $this->_process_fields($fields);

                if ($after_field != '')
                {
                        $sql .= ' AFTER ' . $this->db->_protect_identifiers($after_field);
                }
                
                return $sql;
        }

Here is the call graph for this function:

CI_DB_mysqli_forge::_create_database

(

$

name

)

Create database.

private

Parameters:

string

the database name

Returns:

bool

Definition at line 34 of file mysqli_forge.php.

        {
                return "CREATE DATABASE ".$name;
        }

CI_DB_mysqli_forge::_create_table	(	$	table,
		$	fields,
		$	primary_keys,
		$	keys,
		$	if_not_exists
	)

Create Table.

private

Parameters:

	string	the table name
	mixed	the fields
	mixed	primary key(s)
	mixed	key(s)
	boolean	should 'IF NOT EXISTS' be added to the SQL

Returns:

bool

Definition at line 141 of file mysqli_forge.php.

References CI_DB_forge::$fields, CI_DB_forge::$keys, CI_DB_forge::$primary_keys, and _process_fields().

        {
                $sql = 'CREATE TABLE ';
                
                if ($if_not_exists === TRUE)
                {
                        $sql .= 'IF NOT EXISTS ';
                }
                
                $sql .= $this->db->_escape_identifiers($table)." (";

                $sql .= $this->_process_fields($fields);

                if (count($primary_keys) > 0)
                {
                        $key_name = $this->db->_protect_identifiers(implode('_', $primary_keys));
                        $primary_keys = $this->db->_protect_identifiers($primary_keys);
                        $sql .= ",\n\tPRIMARY KEY ".$key_name." (" . implode(', ', $primary_keys) . ")";
                }

                if (is_array($keys) && count($keys) > 0)
                {
                        foreach ($keys as $key)
                        {
                                if (is_array($key))
                                {
                                        $key_name = $this->db->_protect_identifiers(implode('_', $key));
                                        $key = $this->db->_protect_identifiers($key);   
                                }
                                else
                                {
                                        $key_name = $this->db->_protect_identifiers($key);
                                        $key = array($key_name);
                                }
                                
                                $sql .= ",\n\tKEY {$key_name} (" . implode(', ', $key) . ")";
                        }
                }

                $sql .= "\n) DEFAULT CHARACTER SET {$this->db->char_set} COLLATE {$this->db->dbcollat};";

                return $sql;
        }

Here is the call graph for this function:

CI_DB_mysqli_forge::_drop_database

(

$

name

)

Drop database.

private

Parameters:

string

the database name

Returns:

bool

Definition at line 48 of file mysqli_forge.php.

        {
                return "DROP DATABASE ".$name;
        }

CI_DB_mysqli_forge::_drop_table

(

$

table

)

Drop Table.

private

Returns:

string

Definition at line 193 of file mysqli_forge.php.

        {
                return "DROP TABLE IF EXISTS ".$this->db->_escape_identifiers($table);
        }

CI_DB_mysqli_forge::_process_fields

(

$

fields

)

Process Fields.

private

Parameters:

mixed

the fields

Returns:

string

Definition at line 62 of file mysqli_forge.php.

References CI_DB_forge::$fields.

Referenced by _alter_table(), and _create_table().

        {
                $current_field_count = 0;
                $sql = '';

                foreach ($fields as $field=>$attributes)
                {
                        // Numeric field names aren't allowed in databases, so if the key is
                        // numeric, we know it was assigned by PHP and the developer manually
                        // entered the field information, so we'll simply add it to the list
                        if (is_numeric($field))
                        {
                                $sql .= "\n\t$attributes";
                        }
                        else
                        {
                                $attributes = array_change_key_case($attributes, CASE_UPPER);
                                
                                $sql .= "\n\t".$this->db->_protect_identifiers($field);

                                if (array_key_exists('NAME', $attributes))
                                {
                                        $sql .= ' '.$this->db->_protect_identifiers($attributes['NAME']).' ';
                                }
                                
                                if (array_key_exists('TYPE', $attributes))
                                {
                                        $sql .=  ' '.$attributes['TYPE'];
                                }
        
                                if (array_key_exists('CONSTRAINT', $attributes))
                                {
                                        $sql .= '('.$attributes['CONSTRAINT'].')';
                                }
        
                                if (array_key_exists('UNSIGNED', $attributes) && $attributes['UNSIGNED'] === TRUE)
                                {
                                        $sql .= ' UNSIGNED';
                                }
        
                                if (array_key_exists('DEFAULT', $attributes))
                                {
                                        $sql .= ' DEFAULT \''.$attributes['DEFAULT'].'\'';
                                }
        
                                if (array_key_exists('NULL', $attributes))
                                {
                                        $sql .= ($attributes['NULL'] === TRUE) ? ' NULL' : ' NOT NULL';
                                }
        
                                if (array_key_exists('AUTO_INCREMENT', $attributes) && $attributes['AUTO_INCREMENT'] === TRUE)
                                {
                                        $sql .= ' AUTO_INCREMENT';
                                }
                        }
                        
                        // don't add a comma on the end of the last field
                        if (++$current_field_count < count($fields))
                        {
                                $sql .= ',';
                        }
                }
                
                return $sql;
        }

Here is the caller graph for this function:

CI_DB_mysqli_forge::_rename_table	(	$	table_name,
		$	new_table_name
	)

Rename a table.

Generates a platform-specific query so that a table can be renamed

private

Parameters:

	string	the old table name
	string	the new table name

Returns:

string

Definition at line 245 of file mysqli_forge.php.

        {
                $sql = 'ALTER TABLE '.$this->db->_protect_identifiers($table_name)." RENAME TO ".$this->db->_protect_identifiers($new_table_name);
                return $sql;
        }

---

The documentation for this class was generated from the following file:

• mysqli_forge.php