SchemaAlterTableEventArgs.php 2.64 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
use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Schema\TableDiff;
24 25 26 27

/**
 * Event Arguments used when SQL queries for creating tables are generated inside Doctrine\DBAL\Platform\*Platform.
 *
Benjamin Morel's avatar
Benjamin Morel committed
28 29 30
 * @link   www.doctrine-project.org
 * @since  2.2
 * @author Jan Sorgalla <jsorgalla@googlemail.com>
31 32 33 34
 */
class SchemaAlterTableEventArgs extends SchemaEventArgs
{
    /**
35
     * @var \Doctrine\DBAL\Schema\TableDiff
36
     */
Benjamin Morel's avatar
Benjamin Morel committed
37
    private $_tableDiff;
38 39

    /**
40
     * @var \Doctrine\DBAL\Platforms\AbstractPlatform
41
     */
Benjamin Morel's avatar
Benjamin Morel committed
42
    private $_platform;
43 44 45 46 47 48 49

    /**
     * @var array
     */
    private $_sql = array();

    /**
Benjamin Morel's avatar
Benjamin Morel committed
50
     * @param \Doctrine\DBAL\Schema\TableDiff           $tableDiff
51
     * @param \Doctrine\DBAL\Platforms\AbstractPlatform $platform
52 53 54 55 56 57 58 59
     */
    public function __construct(TableDiff $tableDiff, AbstractPlatform $platform)
    {
        $this->_tableDiff = $tableDiff;
        $this->_platform  = $platform;
    }

    /**
60
     * @return \Doctrine\DBAL\Schema\TableDiff
61 62 63 64 65 66 67
     */
    public function getTableDiff()
    {
        return $this->_tableDiff;
    }

    /**
68
     * @return \Doctrine\DBAL\Platforms\AbstractPlatform
69 70 71 72 73 74 75 76
     */
    public function getPlatform()
    {
        return $this->_platform;
    }

    /**
     * @param string|array $sql
Benjamin Morel's avatar
Benjamin Morel committed
77
     *
78
     * @return \Doctrine\DBAL\Event\SchemaAlterTableEventArgs
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
     */
    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;
    }
}