PHP Class Ruckusing_Adapter_MySQL_TableDefinition, ruckusing-migrations

See link: https://github.com/ruckus/ruckusing-migrations

Show file Open project: ruckus/ruckusing-migrations Class Usage Examples

Public Methods

Method	Description
__construct ( Ruckusing_Adapter_MySQL_Base $adapter, string $name, array $options = [] ) : Ruckusing_Adapter_MySQL_TableDefinition	Creates an instance of Ruckusing_Adapters_MySQL_Adapter
column ( string $column_name, string $type, array $options = [] )	Create a column
finish ( boolean $wants_sql = false ) : boolean \| string	Table definition
timestamps ( string $created_column_name = "created_at", string $updated_column_name = "updated_at" )	Shortcut to create timestamps columns (default created_at, updated_at)

Private Methods

Method	Description
columns_to_str ( ) : string	get all columns
init_sql ( string $name, array $options )	Init create sql
keys ( ) : string	Get all primary keys

Method Details

__construct() public method

Creates an instance of Ruckusing_Adapters_MySQL_Adapter

public __construct ( Ruckusing_Adapter_MySQL_Base $adapter, string $name, array $options = [] ) : Ruckusing_Adapter_MySQL_TableDefinition
$adapter	Ruckusing_Adapter_MySQL_Base	the current adapter
$name	string	the table name
$options	array	the options
return	Ruckusing_Adapter_MySQL_TableDefinition

column() public method

Create a column

public column ( string $column_name, string $type, array $options = [] )
$column_name	string	the column name
$type	string	the column type
$options	array

finish() public method

Table definition

public finish ( boolean $wants_sql = false ) : boolean \| string
$wants_sql	boolean
return	boolean \| string	\| string

timestamps() public method

Shortcut to create timestamps columns (default created_at, updated_at)

public timestamps ( string $created_column_name = "created_at", string $updated_column_name = "updated_at" )
$created_column_name	string	Created at column name
$updated_column_name	string	Updated at column name