app/Db/Importers/Base.php
<?php
/**
* Base file for database import.
*
* @package App
*
* @copyright YetiForce S.A.
* @license YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)
* @author Mariusz Krzaczkowski <m.krzaczkowski@yetiforce.com>
* @author Radosław Skrzypczak <r.skrzypczak@yetiforce.com>
*/
namespace App\Db\Importers;
use yii\db\Schema;
/**
* Base class for database import.
*/
class Base
{
/** @var string Database section. */
public $dbType = 'base';
/** @var array Table structure. */
public $tables = [];
/** @var array Drop tables. */
public $dropTables = [];
/** @var array Drop columns. */
public $dropColumns = [];
/** @var array Drop indexes. */
public $dropIndexes = [];
/** @var array Foreign keys. */
public $foreignKey = [];
/** @var array Data to import. */
public $data = [];
/** @var \App\Db Database connection instance */
public $db;
/** @var \yii\db\Schema Database schema information. */
protected $schema;
/**
* Construct.
*/
public function __construct()
{
$this->db = \App\Db::getInstance($this->dbType);
$this->schema = $this->db->getSchema();
}
/**
* Returns the schema information for the database opened by this connection.
*
* @return Schema the schema information for the database opened by this connection.
*/
public function getSchema()
{
return $this->schema;
}
/**
* Creates a primary key column.
*
* @param int $length column size or precision definition.
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function primaryKey($length = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_PK, $length)->notNull()->autoIncrement();
}
/**
* Creates a primary unsigned key column.
*
* @param int $length column size or precision definition.
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function primaryKeyUnsigned($length = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_UPK, $length)->notNull()->unsigned()->autoIncrement();
}
/**
* Creates a big primary key column.
*
* @param int $length column size or precision definition.
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function bigPrimaryKey($length = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_BIGPK, $length)->notNull()->autoIncrement();
}
/**
* Creates a big primary unsigned key column.
*
* @param int $length column size or precision definition.
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function bigPrimaryKeyUnsigned($length = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_UBIGPK, $length)->notNull()->unsigned()->autoIncrement();
}
/**
* Creates a char column.
*
* @param int $length column size definition i.e. the maximum string length.
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function char($length = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_CHAR, $length);
}
/**
* Creates a string column.
*
* @param int $length column size definition i.e. the maximum string length.
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function stringType($length = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_STRING, $length);
}
/**
* Creates a text column.
*
* @param string|null $length
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function text(?string $length = null)
{
if ('mysql' === \App\Db::getInstance()->getDriverName()) {
if ($length <= 65535) {
$columnSchemaBuilder = $this->schema->createColumnSchemaBuilder(Schema::TYPE_TEXT);
} elseif ($length <= 16777215) {
$columnSchemaBuilder = $this->schema->createColumnSchemaBuilder('MEDIUMTEXT');
} elseif ($length > 16777215) {
$columnSchemaBuilder = $this->schema->createColumnSchemaBuilder('LONGTEXT');
}
} else {
$columnSchemaBuilder = $this->schema->createColumnSchemaBuilder(Schema::TYPE_TEXT);
}
return $columnSchemaBuilder;
}
/**
* Creates a medium text column.
*
* @param string|null $length
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function mediumText($length = null)
{
return $this->schema->createColumnSchemaBuilder('MEDIUMTEXT', $length);
}
/**
* Creates a tiny int column. Available only in MySql.
*
* @param int $length column size or precision definition
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function tinyInteger($length = 5)
{
return $this->schema->createColumnSchemaBuilder('tinyint', $length);
}
/**
* Creates a smallint column.
*
* @param int $length column size or precision definition.
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function smallInteger($length = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_SMALLINT, $length);
}
/**
* Creates an integer column.
*
* @param int $length column size or precision definition.
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function integer($length = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_INTEGER, $length);
}
/**
* Creates a bigint column.
*
* @param int $length column size or precision definition.
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function bigInteger($length = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_BIGINT, $length);
}
/**
* Creates a float column.
*
* @param int $precision column value precision. First parameter passed to the column type, e.g. FLOAT(precision).
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function floatType($precision = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_FLOAT, $precision);
}
/**
* Creates a double column.
*
* @param int $precision column value precision. First parameter passed to the column type, e.g. DOUBLE(precision).
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function double($precision = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_DOUBLE, $precision);
}
/**
* Creates a decimal column.
*
* @param int $precision column value precision, which is usually the total number of digits.
* First parameter passed to the column type, e.g. DECIMAL(precision, scale).
* This parameter will be ignored if not supported by the DBMS
* @param int $scale column value scale, which is usually the number of digits after the decimal point.
* Second parameter passed to the column type, e.g. DECIMAL(precision, scale).
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function decimal($precision = null, $scale = null)
{
$length = [];
if (null !== $precision) {
$length[] = $precision;
}
if (null !== $scale) {
$length[] = $scale;
}
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_DECIMAL, $length);
}
/**
* Creates a datetime column.
*
* @param int $precision column value precision. First parameter passed to the column type, e.g. DATETIME(precision).
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function dateTime($precision = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_DATETIME, $precision);
}
/**
* Creates a timestamp column.
*
* @param int $precision column value precision. First parameter passed to the column type, e.g. TIMESTAMP(precision).
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function timestamp($precision = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_TIMESTAMP, $precision);
}
/**
* Creates a time column.
*
* @param int $precision column value precision. First parameter passed to the column type, e.g. TIME(precision).
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function time($precision = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_TIME, $precision);
}
/**
* Creates a date column.
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function date()
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_DATE);
}
/**
* Creates a binary column.
*
* @param int $length column size or precision definition.
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function binary($length = null)
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_BINARY, $length);
}
/**
* Creates a varbinary column. Available only in MySql.
*
* @param int $length column size or precision definition
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function varbinary($length = 255)
{
return $this->schema->createColumnSchemaBuilder('varbinary', $length);
}
/**
* Creates a boolean column.
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function boolean()
{
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_BOOLEAN);
}
/**
* Creates a money column.
*
* @param int $precision column value precision, which is usually the total number of digits.
* First parameter passed to the column type, e.g. DECIMAL(precision, scale).
* This parameter will be ignored if not supported by the DBMS
* @param int $scale column value scale, which is usually the number of digits after the decimal point.
* Second parameter passed to the column type, e.g. DECIMAL(precision, scale).
* This parameter will be ignored if not supported by the DBMS
*
* @return \yii\db\ColumnSchemaBuilder the column instance which can be further customized
*/
public function money($precision = null, $scale = null)
{
$length = [];
if (null !== $precision) {
$length[] = $precision;
}
if (null !== $scale) {
$length[] = $scale;
}
return $this->schema->createColumnSchemaBuilder(Schema::TYPE_MONEY, $length);
}
}