SchemaAlterTableRenameColumnEventArgs.php 3.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
Benjamin Eberlei's avatar
Benjamin Eberlei committed
16
 * and is licensed under the MIT license. For more information, see
17
 * <http://www.doctrine-project.org>.
Benjamin Morel's avatar
Benjamin Morel committed
18
 */
19 20 21

namespace Doctrine\DBAL\Event;

Benjamin Morel's avatar
Benjamin Morel committed
22 23 24
use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Schema\Column;
use Doctrine\DBAL\Schema\TableDiff;
25 26
use function array_merge;
use function is_array;
27 28 29 30

/**
 * Event Arguments used when SQL queries for renaming table columns are generated inside Doctrine\DBAL\Platform\*Platform.
 *
Benjamin Morel's avatar
Benjamin Morel committed
31 32 33
 * @link   www.doctrine-project.org
 * @since  2.2
 * @author Jan Sorgalla <jsorgalla@googlemail.com>
34
 */
jsor's avatar
jsor committed
35
class SchemaAlterTableRenameColumnEventArgs extends SchemaEventArgs
36 37 38 39
{
    /**
     * @var string
     */
Benjamin Morel's avatar
Benjamin Morel committed
40
    private $_oldColumnName;
41 42

    /**
43
     * @var \Doctrine\DBAL\Schema\Column
44
     */
Benjamin Morel's avatar
Benjamin Morel committed
45
    private $_column;
46 47

    /**
48
     * @var \Doctrine\DBAL\Schema\TableDiff
49
     */
Benjamin Morel's avatar
Benjamin Morel committed
50
    private $_tableDiff;
51 52

    /**
53
     * @var \Doctrine\DBAL\Platforms\AbstractPlatform
54
     */
Benjamin Morel's avatar
Benjamin Morel committed
55
    private $_platform;
56 57 58 59

    /**
     * @var array
     */
60
    private $_sql = [];
61 62

    /**
Benjamin Morel's avatar
Benjamin Morel committed
63 64 65
     * @param string                                    $oldColumnName
     * @param \Doctrine\DBAL\Schema\Column              $column
     * @param \Doctrine\DBAL\Schema\TableDiff           $tableDiff
66
     * @param \Doctrine\DBAL\Platforms\AbstractPlatform $platform
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
     */
    public function __construct($oldColumnName, Column $column, TableDiff $tableDiff, AbstractPlatform $platform)
    {
        $this->_oldColumnName = $oldColumnName;
        $this->_column        = $column;
        $this->_tableDiff     = $tableDiff;
        $this->_platform      = $platform;
    }

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

    /**
85
     * @return \Doctrine\DBAL\Schema\Column
86 87 88 89 90 91 92
     */
    public function getColumn()
    {
        return $this->_column;
    }

    /**
93
     * @return \Doctrine\DBAL\Schema\TableDiff
94 95 96 97 98 99 100
     */
    public function getTableDiff()
    {
        return $this->_tableDiff;
    }

    /**
101
     * @return \Doctrine\DBAL\Platforms\AbstractPlatform
102 103 104 105 106 107 108 109
     */
    public function getPlatform()
    {
        return $this->_platform;
    }

    /**
     * @param string|array $sql
Benjamin Morel's avatar
Benjamin Morel committed
110
     *
111
     * @return \Doctrine\DBAL\Event\SchemaAlterTableRenameColumnEventArgs
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
     */
    public function addSql($sql)
    {
        if (is_array($sql)) {
            $this->_sql = array_merge($this->_sql, $sql);
        } else {
            $this->_sql[] = $sql;
        }

        return $this;
    }

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