Download the PHP package fyre/forge without Composer

FyreForge

FyreForge is a free, open-source database forge library for PHP.

Table Of Contents

• Installation
• Basic Usage
• Methods
• Forges
  • MySQL Forges
  • Postgres Forges
  • Sqlite Forges
• Table
  • MySQL Tables
  • Postgres Tables
  • Sqlite Tables
• Columns
  • MySQL Columns
• Indexes
• Foreign Keys

Installation

Using Composer

In PHP:

Basic Usage

• $container is a Container.

Autoloading

It is recommended to bind the ForgeRegistry to the Container as a singleton.

Any dependencies will be injected automatically when loading from the Container.

Methods

Map

Map a Connection class to a Forge handler.

• $connectionClass is a string representing the Connection class name.
• $forgeClass is a string representing the Forge class name.

Use

Load the shared Connection.

• $connection is a Connection.

Container.

Forges

Add Column

Add a column to a table.

• $tableName is a string representing the table name.
• $columnName is a string representing the column name.
• $options is an array containing the column options.
  • type is a string representing the column type, and will default to StringType::class.
  • length is a number representing the column length, and will default to the type default.
  • precision is a number representing the column precision, and will default to the type default.
  • nullable is a boolean indicating whether the column is nullable, and will default to false.
  • default is a string representing the column default value, and will default to null (no default).
  • autoIncrement is a boolean indicating whether the column is an an auto incrementing column, and will default to false.

You can also specify a Type class name as the type, which will be automatically mapped to the correct type.

Additional column options may be available depending on the connection handler.

Add Foreign Key

Add a foreign key to a table.

• $tableName is a string representing the table name.
• $foreignKeyName is a string representing the foreign key name.
• $options is an array containing the foreign key options.
  • columns is a string or array containing the columns to use for the foreign key, and will default to the foreign key name.
  • referencedTable is a string representing the referenced table to use.
  • referencedColumns is a string or array containing the columns to use in the referenced table.
  • onUpdate is a string containing the ON UPDATE operation, and will default to null.
  • onDelete is a string containing the ON DELETE operation, and will default to null.

Foreign keys cannot be added to an existing Sqlite table.

Add Index

Add an index to a table.

• $tableName is a string representing the table name.
• $indexName is a string representing the index name.
• $options is an array containing the index options.
  • columns is a string or array containing the columns to use for the index, and will default to the index name.
  • unique is a boolean indicating whether the index must be unique, and will default to false.
  • primary is a boolean indicating whether the index is a primary key, and will default to false.

Additional index options may be available depending on the connection handler.

Primary keys cannot be added to an existing Sqlite table.

Alter Table

Alter a table.

• $tableName is a string representing the table name.
• $options is an array containing the table options.

Additional table options may be available depending on the connection handler.

Build

Build a Table.

• $tableName is a string representing the table name.
• $options is an array containing the table options.

Table dependencies will be resolved automatically from the Container.

Additional table options may be available depending on the connection handler.

Create Table

Create a new table.

• $tableName is a string representing the table name.
• $columns is an array containing the column definitions.
• $indexes is an array containing the index definitions.
• $foreignKeys is an array containing the foreign key definitions.
• $options is an array containing the schema options.

Additional table options may be available depending on the connection handler.

Drop Column

Drop a column from a table.

• $tableName is a string representing the table name.
• $columnName is a string representing the column name.

Drop Foreign Key

Drop a foreign key from a table.

• $tableName is a string representing the table name.
• $foreignKeyName is a string representing the foreign key name.

Foreign keys cannot be dropped from an existing Sqlite table.

Drop Index

Drop an index from a table.

• $tableName is a string representing the table name.
• $indexName is a string representing the index name.

Primary keys cannot be dropped from an existing Sqlite table.

Drop Table

Drop a table.

• $tableName is a string representing the table name.

Get Connection

Get the Connection.

Rename Column

Rename a column.

• $tableName is a string representing the table name.
• $columnName is a string representing the column name.
• $newColumnName is a string representing the new column name.

Rename Table

Rename a table.

• $tableName is a string representing the table name.
• $newTableName is a string representing the new table name.

MySQL Forges

The MySQL Forge extends the Forge class and provides additional methods and options specific to MySQL databases.

Add Column

Add a column to a table.

• $tableName is a string representing the table name.
• $columnName is a string representing the column name.
• $options is an array containing the column options.
  • type is a string representing the column type, and will default to StringType::class.
  • length is a number representing the column length, and will default to the type default.
  • precision is a number representing the column precision, and will default to the type default.
  • values is an array containing the enum/set values, and will default to null.
  • nullable is a boolean indicating whether the column is nullable, and will default to false.
  • unsigned is a boolean indicating whether the column is unsigned, and will default to false.
  • default is a string representing the column default value, and will default to null (no default).
  • charset is a string representing the column character set, and will default to the connection character set.
  • collation is a string representing the column collation, and will default to the connection collation.
  • autoIncrement is a boolean indicating whether the column is an an auto incrementing column, and will default to false.
  • comment is a string representing the column comment, and will default to "".
  • after is a string representing the column to add this column after, and will default to null.
  • first is a boolean indicating whether to add this column first in the table, and will default to false.

You can also specify a Type class name as the type, which will be automatically mapped to the correct type.

Add Index

Add an index to a table.

• $tableName is a string representing the table name.
• $indexName is a string representing the index name.
• $options is an array containing the index options.
  • columns is a string or array containing the columns to use for the index, and will default to the index name.
  • type is a string representing the index type, and will default to "BTREE".
  • unique is a boolean indicating whether the index must be unique, and will default to false.
  • primary is a boolean indicating whether the index is a primary key, and will default to false.

Alter Table

Alter a table.

• $tableName is a string representing the table name.
• $options is an array containing the table options.
  • engine is a string representing the table engine, and will default to "InnoDB".
  • charset is a string representing the table character set, and will default to the connection character set.
  • collation is a string representing the table collation, and will default to the connection collation.
  • comment is a string representing the table comment, and will default to "".

Build

Build a Table.

• $tableName is a string representing the table name.
• $options is an array containing the table options.
  • engine is a string representing the table engine, and will default to "InnoDB".
  • charset is a string representing the table character set, and will default to the connection character set.
  • collation is a string representing the table collation, and will default to the connection collation.
  • comment is a string representing the table comment, and will default to "".

Table dependencies will be resolved automatically from the Container.

Change Column

Change a table column.

• $tableName is a string representing the table name.
• $columnName is a string representing the column name.
• $options is an array containing the column options.
  • name is a string representing the new column name.
  • type is a string representing the column type.
  • length is a number representing the column length.
  • precision is a number representing the column precision.
  • values is an array containing the enum/set values.
  • nullable is a boolean indicating whether the column is nullable.
  • unsigned is a boolean indicating whether the column is unsigned.
  • default is a string representing the column default value.
  • charset is a string representing the column character set.
  • collation is a string representing the column collation.
  • autoIncrement is a boolean indicating whether the column is an an auto incrementing column.
  • comment is a string representing the column comment.
  • after is a string representing the column to add this column after.
  • first is a boolean indicating whether to add this column first in the table.

You can also specify a Type class name as the type, which will be automatically mapped to the correct type.

Unspecified options will default to the current value.

Create Schema

Create a new schema.

• $schema is a string representing the schema name.
• $options is an array containing the schema options.
  • charset is a string representing the schema character set, and will default to the connection character set.
  • collation is a string representing the schema collation, and will default to the connection collation.
  • ifNotExists is a boolean indicating whether to use an IF NOT EXISTS clause, and will default to false.

Create Table

Create a new table.

• $table is a string representing the table name.
• $columns is an array containing the column definitions.
• $indexes is an array containing the index definitions.
• $foreignKeys is an array containing the foreign key definitions.
• $options is an array containing the schema options.
  • engine is a string representing the table engine, and will default to "InnoDB".
  • charset is a string representing the table character set, and will default to the connection character set.
  • collation is a string representing the table collation, and will default to the connection collation.
  • comment is a string representing the table comment, and will default to "".

Drop Primary Key

Drop a primary key from a table.

• $tableName is a string representing the table name.

Drop Schema

Drop a schema.

• $schema is a string representing the schema name.
• $options is an array containing the schema options.
  • ifExists is a boolean indicating whether to use an IF EXISTS clause, and will default to false.

Postgres

The Postgres Forge extends the Forge class and provides additional methods and options specific to Postgres databases.

Add Column

Add a column to a table.

• $tableName is a string representing the table name.
• $columnName is a string representing the column name.
• $options is an array containing the column options.
  • type is a string representing the column type, and will default to StringType::class.
  • length is a number representing the column length, and will default to the type default.
  • precision is a number representing the column precision, and will default to the type default.
  • nullable is a boolean indicating whether the column is nullable, and will default to false.
  • default is a string representing the column default value, and will default to null (no default).
  • autoIncrement is a boolean indicating whether the column is an an auto incrementing column, and will default to false.
  • comment is a string representing the column comment, and will default to "".

You can also specify a Type class name as the type, which will be automatically mapped to the correct type.

Alter Table

Alter a table.

• $tableName is a string representing the table name.
• $options is an array containing the table options.
  • comment is a string representing the table comment, and will default to "".

Build

Build a Table.

• $tableName is a string representing the table name.
• $options is an array containing the table options.
  • comment is a string representing the table comment, and will default to "".

Table dependencies will be resolved automatically from the Container.

Change Column

Change a table column.

• $tableName is a string representing the table name.
• $columnName is a string representing the column name.
• $options is an array containing the column options.
  • name is a string representing the new column name.
  • type is a string representing the column type.
  • length is a number representing the column length.
  • precision is a number representing the column precision.
  • nullable is a boolean indicating whether the column is nullable.
  • default is a string representing the column default value.
  • autoIncrement is a boolean indicating whether the column is an an auto incrementing column.
  • comment is a string representing the column comment.

You can also specify a Type class name as the type, which will be automatically mapped to the correct type.

Unspecified options will default to the current value.

Create Schema

Create a new schema.

• $schema is a string representing the schema name.
• $options is an array containing the schema options.
  • ifNotExists is a boolean indicating whether to use an IF NOT EXISTS clause, and will default to false.

Create Table

Create a new table.

• $table is a string representing the table name.
• $columns is an array containing the column definitions.
• $indexes is an array containing the index definitions.
• $foreignKeys is an array containing the foreign key definitions.
• $options is an array containing the schema options.
  • comment is a string representing the table comment, and will default to "".

Drop Primary Key

Drop a primary key from a table.

• $tableName is a string representing the table name.

Drop Schema

Drop a schema.

• $schema is a string representing the schema name.
• $options is an array containing the schema options.
  • ifExists is a boolean indicating whether to use an IF EXISTS clause, and will default to false.

Sqlite

The Sqlite Forge extends the Forge class.

Add Column

Add a column to a table.

• $tableName is a string representing the table name.
• $columnName is a string representing the column name.
• $options is an array containing the column options.
  • type is a string representing the column type, and will default to StringType::class.
  • length is a number representing the column length, and will default to the type default.
  • precision is a number representing the column precision, and will default to the type default.
  • nullable is a boolean indicating whether the column is nullable, and will default to false.
  • unsigned is a boolean indicating whether the column is unsigned, and will default to false.
  • default is a string representing the column default value, and will default to null (no default).
  • autoIncrement is a boolean indicating whether the column is an an auto incrementing column, and will default to false.

You can also specify a Type class name as the type, which will be automatically mapped to the correct type.

Tables

Add Column

Add a column to the table.

• $column is a string representing the column name.
• $options is an array containing the column options.
  • name is a string representing the new column name, and will default to the column name.
  • type is a string representing the column type, and will default to StringType::class.
  • length is a number representing the column length, and will default to the type default.
  • precision is a number representing the column precision, and will default to the type default.
  • nullable is a boolean indicating whether the column is nullable, and will default to false.
  • default is a string representing the column default value, and will default to null (no default).
  • autoIncrement is a boolean indicating whether the column is an an auto incrementing column, and will default to false.

You can also specify a Type class name as the type, which will be automatically mapped to the correct type.

Additional column options may be available depending on the connection handler.

Add Foreign Key

Add a foreign key to the table.

• $foreignKey is a string representing the foreign key name.
• $options is an array containing the foreign key options.
  • columns is a string or array containing the columns to use for the foreign key, and will default to the foreign key name.
  • referencedTable is a string representing the referenced table to use.
  • referencedColumns is a string or array containing the columns to use in the referenced table.
  • onUpdate is a string containing the ON UPDATE operation, and will default to null.
  • onDelete is a string containing the ON DELETE operation, and will default to null.

Foreign keys cannot be added to an existing Sqlite table.

Add Index

Add an index to the table.

• $index is a string representing the index name.
• $options is an array containing the index options.
  • columns is a string or array containing the columns to use for the index, and will default to the index name.
  • unique is a boolean indicating whether the index must be unique, and will default to false.
  • primary is a boolean indicating whether the index is a primary key, and will default to false.

Additional index options may be available depending on the connection handler.

Primary keys cannot be added to an existing Sqlite table.

Change Column

Change a table column.

• $column is a string representing the column name.
• $options is an array containing the column options.
  • name is a string representing the new column name, and will default to the column name.

Additional column options may be available depending on the connection handler.

Column definitions can not be modified for an existing Sqlite table.

Clear

Clear the column and index data.

Column

Get a Column.

• $name is a string representing the column name.

Column Names

Get the names of all table columns.

Columns

Get all table columns.

Drop

Drop the table.

Drop Column

Drop a column from the table.

• $column is a string representing the column name.

Drop Foreign Key

Drop a foreign key from the table.

• $foreignKey is a string representing the foreign key name.

Foreign keys cannot be dropped from an existing Sqlite table.

Drop Index

Drop an index from the table.

• $index is a string representing the index name.

Primary keys cannot be dropped from an existing Sqlite table.

Execute

Generate and execute the SQL queries.

Foreign Key

Get a table ForeignKey.

• $name is a string representing the foreign key name.

Foreign Keys

Get all table foreign keys.

Get Comment

Get the table comment.

Get Forge

Get the Forge.

Get Name

Get the table name.

Has Column

Determine whether the table has a column.

• $name is a string representing the column name.

Has Foreign Key

Determine whether the table has a foreign key.

• $name is a string representing the foreign key name.

Has Index

Determine whether the table has an index.

• $name is a string representing the index name.

Index

Get a table Index.

• $name is a string representing the index name.

Indexes

Get all table indexes.

Rename

Rename the table.

• $table is a string representing the new table name.

Set Primary Key

Set the primary key.

• $columns is a string or array containing the columns to use for the primary key.

Primary keys cannot be added to an existing Sqlite table.

SQL

Generate the SQL queries.

To Array

Get the table data as an array.

MySQL Tables

Add Column

Add a column to the table.

• $column is a string representing the column name.
• $options is an array containing the column options.
  • type is a string representing the column type, and will default to StringType::class.
  • length is a number representing the column length, and will default to the type default.
  • precision is a number representing the column precision, and will default to the type default.
  • values is an array containing the enum/set values, and will default to null.
  • nullable is a boolean indicating whether the column is nullable, and will default to false.
  • unsigned is a boolean indicating whether the column is unsigned, and will default to false.
  • default is a string representing the column default value, and will default to null (no default).
  • charset is a string representing the column character set, and will default to the connection character set.
  • collation is a string representing the column collation, and will default to the connection collation.
  • autoIncrement is a boolean indicating whether the column is an an auto incrementing column, and will default to false.
  • comment is a string representing the column comment, and will default to "".
  • after is a string representing the column to add this column after, and will default to null.
  • first is a boolean indicating whether to add this column first in the table, and will default to false.

You can also specify a Type class name as the type, which will be automatically mapped to the correct type.

Add Index

Add an index to the table.

• $index is a string representing the index name.
• $options is an array containing the index options.
  • columns is a string or array containing the columns to use for the index, and will default to the index name.
  • type is a string representing the index type, and will default to "BTREE".
  • unique is a boolean indicating whether the index must be unique, and will default to false.
  • primary is a boolean indicating whether the index is a primary key, and will default to false.

Change Column

Change a table column.

• $column is a string representing the column name.
• $options is an array containing the column options.
  • name is a string representing the new column name.
  • type is a string representing the column type.
  • length is a number representing the column length.
  • precision is a number representing the column precision.
  • values is an array containing the enum/set values.
  • nullable is a boolean indicating whether the column is nullable.
  • unsigned is a boolean indicating whether the column is unsigned.
  • default is a string representing the column default value.
  • charset is a string representing the column character set.
  • collation is a string representing the column collation.
  • autoIncrement is a boolean indicating whether the column is an an auto incrementing column.
  • comment is a string representing the column comment.
  • after is a string representing the column to add this column after.
  • first is a boolean indicating whether to add this column first in the table.

You can also specify a Type class name as the type, which will be automatically mapped to the correct type.

Unspecified options will default to the current value.

Get Charset

Get the table character set.

Get Collation

Get the table collation.

Get Engine

Get the table engine.

Postgres Tables

Add Column

Add a column to the table.

• $column is a string representing the column name.
• $options is an array containing the column options.
  • type is a string representing the column type, and will default to StringType::class.
  • length is a number representing the column length, and will default to the type default.
  • precision is a number representing the column precision, and will default to the type default.
  • nullable is a boolean indicating whether the column is nullable, and will default to false.
  • default is a string representing the column default value, and will default to null (no default).
  • autoIncrement is a boolean indicating whether the column is an an auto incrementing column, and will default to false.
  • comment is a string representing the column comment, and will default to "".

You can also specify a Type class name as the type, which will be automatically mapped to the correct type.

Add Index

Add an index to the table.

• $index is a string representing the index name.
• $options is an array containing the index options.
  • columns is a string or array containing the columns to use for the index, and will default to the index name.
  • type is a string representing the index type, and will default to "BTREE".
  • unique is a boolean indicating whether the index must be unique, and will default to false.
  • primary is a boolean indicating whether the index is a primary key, and will default to false.

Change Column

Change a table column.

• $column is a string representing the column name.
• $options is an array containing the column options.
  • name is a string representing the new column name.
  • type is a string representing the column type.
  • length is a number representing the column length.
  • precision is a number representing the column precision.
  • nullable is a boolean indicating whether the column is nullable.
  • default is a string representing the column default value.
  • autoIncrement is a boolean indicating whether the column is an an auto incrementing column.
  • comment is a string representing the column comment.

You can also specify a Type class name as the type, which will be automatically mapped to the correct type.

Unspecified options will default to the current value.

Sqlite Tables

Add Column

Add a column to the table.

• $column is a string representing the column name.
• $options is an array containing the column options.
  • type is a string representing the column type, and will default to StringType::class.
  • length is a number representing the column length, and will default to the type default.
  • precision is a number representing the column precision, and will default to the type default.
  • nullable is a boolean indicating whether the column is nullable, and will default to false.
  • unsigned is a boolean indicating whether the column is unsigned, and will default to false.
  • default is a string representing the column default value, and will default to null (no default).
  • autoIncrement is a boolean indicating whether the column is an an auto incrementing column, and will default to false.

You can also specify a Type class name as the type, which will be automatically mapped to the correct type.

Columns

Get Comment

Get the column comment.

Get Default

Get the column default value.

Get Length

Get the column length.

Get Name

Get the column name.

Get Precision

Get the column precision.

Get Table

Get the Table.

Get Type

Get the column type.

Is Auto Increment

Determine whether the column is an auto increment column.

Is Nullable

Determine whether the column is nullable.

Is Unsigned

Determine whether the column is unsigned.

To Array

Get the column data as an array.

MySQL Columns

Get Charset

Get the column character set.

Get Collation

Get the column collation.

Get Values

Get the column enum values.

Indexes

Get Columns

Get the column names.

Get Name

Get the index name.

Get Table

Get the Table.

Get Type

Get the index type.

Is Primary

Determine whether the index is primary.

Is Unique

Determine whether the index is unique.

To Array

Get the index data as an array.

Foreign Keys

Get Columns

Get the column names.

Get Name

Get On Delete

Get the delete action.

Get On Update

Get the update action.

Get Referenced Columns

Get the referenced column names.

Get Referenced Table

Get the referenced table name.

Get Table

Get the Table.

To Array

Get the foreign key data as an array.