SchemaCreateTableColumnEventArgs.php 2.98 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\Table;
25 26 27 28

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

40
    /**
41
     * @var \Doctrine\DBAL\Schema\Table
42
     */
Benjamin Morel's avatar
Benjamin Morel committed
43
    private $_table;
44 45

    /**
46
     * @var \Doctrine\DBAL\Platforms\AbstractPlatform
47
     */
Benjamin Morel's avatar
Benjamin Morel committed
48
    private $_platform;
49 50 51 52 53 54

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

jsor's avatar
jsor committed
55
    /**
Benjamin Morel's avatar
Benjamin Morel committed
56 57
     * @param \Doctrine\DBAL\Schema\Column              $column
     * @param \Doctrine\DBAL\Schema\Table               $table
58
     * @param \Doctrine\DBAL\Platforms\AbstractPlatform $platform
jsor's avatar
jsor committed
59
     */
60 61
    public function __construct(Column $column, Table $table, AbstractPlatform $platform)
    {
62 63 64
        $this->_column   = $column;
        $this->_table    = $table;
        $this->_platform = $platform;
65 66 67
    }

    /**
68
     * @return \Doctrine\DBAL\Schema\Column
69 70 71 72 73
     */
    public function getColumn()
    {
        return $this->_column;
    }
74 75

    /**
76
     * @return \Doctrine\DBAL\Schema\Table
77 78 79 80 81 82 83
     */
    public function getTable()
    {
        return $this->_table;
    }

    /**
84
     * @return \Doctrine\DBAL\Platforms\AbstractPlatform
85 86 87 88 89 90 91 92
     */
    public function getPlatform()
    {
        return $this->_platform;
    }

    /**
     * @param string|array $sql
Benjamin Morel's avatar
Benjamin Morel committed
93
     *
94
     * @return \Doctrine\DBAL\Event\SchemaCreateTableColumnEventArgs
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
     */
    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;
    }
114
}