carono / yii2-migrate

src/PivotColumn.php

<?php

namespace carono\yii2migrate;

use carono\yii2migrate\helpers\SchemaHelper;
use yii\helpers\Inflector;

/**
 * Class PivotColumn
 *
 * @package carono\yii2installer
 */
class PivotColumn
{
    protected $_refTable;
    protected $_refColumn;
    protected $_sourceTable;
    protected $_sourceColumn;
    protected $_suffix;
    protected $_tableName;
    protected $_columns = [];
    protected $_prefix = 'pv';
    /**
     * @var Migration
     */
    public $migrate;
    public $column_type = \yii\db\Schema::TYPE_INTEGER;
    public $column_length;

    /**
     * @return string
     */
    public function __toString()
    {
        return $this->getPrefix();
    }

    public function setPrefix($value)
    {
        $this->_prefix = $value;
    }

    public function getPrefix()
    {
        return $this->_prefix;
    }

    /**
     * @param $migrate
     * @return $this
     */
    public function setMigrate($migrate)
    {
        $this->migrate = $migrate;
        return $this;
    }

    /**
     * @param $value
     * @return $this
     */
    public function setSuffix($value)
    {
        $this->_suffix = $value;
        return $this;
    }

    /**
     * @param $name
     * @return $this
     */
    public function tableName($name)
    {
        $this->_tableName = $name;
        return $this;
    }

    /**
     * @param array $columns
     * @return $this
     */
    public function columns($columns)
    {
        $this->_columns = $columns;
        return $this;
    }

    /**
     * @return array
     */
    public function getColumns()
    {
        return $this->_columns;
    }

    /**
     * @return mixed
     */
    public function getTableName()
    {
        $name = $this->_tableName ?: implode('_', [$this->getPrefix(), $this->_sourceTable, $this->_suffix]);
        return '{{%' . SchemaHelper::expandTablePrefix($name, '') . '}}';

Are you sure carono\yii2migrate\helpers\SchemaHelper::expandTablePrefix($name, '') of type null|string|string[] can be used in concatenation?

    }

    /**
     * @return mixed
     */
    public function getSuffix()
    {
        return $this->_suffix;
    }

    public function remove()
    {
        if ($this->_columns) {

The expression $this->_columns of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            $this->migrate->downNewColumns([$this->getTableName() => $this->_columns]);
        }
        $this->migrate->dropTable($this->getTableName());
    }

    /**
     * @param $value
     * @return $this
     */
    public function setType($value)
    {
        $this->column_type = $value;
        return $this;
    }

    /**
     * @param $value
     * @return $this
     */
    public function setLength($value)
    {
        $this->column_length = $value;
        return $this;
    }

    public function apply()
    {
        /**
         * @var ForeignKeyColumn $type
         */
        $columns = [
            $this->getSourceColumn() => $this->migrate->foreignKey($this->getSourceTable()),

Are you sure the usage of $this->getSourceTable() targeting carono\yii2migrate\PivotColumn::getSourceTable() seems to always return null.

            $this->getRefColumn() => $this->migrate->foreignKey($this->getRefTable()),

Are you sure the usage of $this->getRefTable() targeting carono\yii2migrate\PivotColumn::getRefTable() seems to always return null.

        ];
        $columnsInt = array_combine(array_keys($columns), [
            $this->migrate->db->getSchema()->createColumnSchemaBuilder($this->column_type, $this->column_length),
            $this->migrate->db->getSchema()->createColumnSchemaBuilder($this->column_type, $this->column_length)
        ]);

        $this->migrate->createTable($this->getTableName(), $columnsInt);
        $this->migrate->addPrimaryKey(null, $this->getTableName(), array_keys($columns));

        foreach ($columns as $name => $type) {
            $type->sourceTable($this->getTableName())->sourceColumn($name);
            $type->apply();
        }
        if ($advancedColumns = $this->getColumns()) {

The assignment to $advancedColumns is dead and can be removed.

            $this->migrate->upNewColumns([$this->getTableName() => $this->getColumns()]);
        }
    }

    /**
     * @return null
     */
    public function getRefTable()
    {
        return $this->_refTable;
    }

    /**
     * @return mixed
     */
    public function getRefColumn()
    {
        if (!$this->_refColumn) {
            $name = implode('_', [$this->getRefTable(), 'id']);

Are you sure the usage of $this->getRefTable() targeting carono\yii2migrate\PivotColumn::getRefTable() seems to always return null.

        } else {
            $name = $this->_refColumn;
        }
        $refColumn = SchemaHelper::expandTablePrefix($name, '');
        if (strtolower($refColumn) === strtolower($this->getSourceColumn())) {

It seems like $refColumn can also be of type null and string[]; however, parameter $string of strtolower() does only seem to accept string, maybe add an additional type check?

            $refColumn = Inflector::singularize($this->_suffix) . '_id';
        }
        return $refColumn;
    }

    /**
     * @return null
     */
    public function getSourceTable()
    {
        return $this->_sourceTable;
    }

    /**
     * @return mixed
     */
    public function getSourceColumn()
    {
        if (!$this->_sourceColumn) {
            $name = implode('_', [$this->getSourceTable(), 'id']);

Are you sure the usage of $this->getSourceTable() targeting carono\yii2migrate\PivotColumn::getSourceTable() seems to always return null.

        } else {
            $name = $this->_sourceColumn;
        }
        return SchemaHelper::expandTablePrefix($name, '');
    }

    /**
     * @param $name
     * @return $this
     */
    public function refTable($name)
    {
        $this->_refTable = $name;
        return $this;
    }

    /**
     * @param $name
     * @return $this
     */
    public function sourceColumn($name)
    {
        $this->_sourceColumn = $name;
        return $this;
    }

    /**
     * @param $name
     * @return $this
     */
    public function sourceTable($name)
    {
        $this->_sourceTable = $name;
        return $this;
    }

    /**
     * @param $name
     * @return $this
     */
    public function refColumn($name)
    {
        $this->_refColumn = $name;
        return $this;
    }
}