SchemaColumnDefinitionEventArgs.php 3.41 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\Connection;
use Doctrine\DBAL\Schema\Column;
24 25

/**
jsor's avatar
jsor committed
26
 * Event Arguments used when the portable column definition is generated inside Doctrine\DBAL\Schema\AbstractSchemaManager.
27
 *
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 SchemaColumnDefinitionEventArgs extends SchemaEventArgs
{
    /**
Benjamin Morel's avatar
Benjamin Morel committed
35
     * @var \Doctrine\DBAL\Schema\Column|null
36 37 38
     */
    private $_column = null;

39
    /**
Benjamin Morel's avatar
Benjamin Morel committed
40
     * Raw column data as fetched from the database.
41 42 43
     *
     * @var array
     */
Benjamin Morel's avatar
Benjamin Morel committed
44
    private $_tableColumn;
45

46 47 48
    /**
     * @var string
     */
Benjamin Morel's avatar
Benjamin Morel committed
49
    private $_table;
50 51 52 53

    /**
     * @var string
     */
Benjamin Morel's avatar
Benjamin Morel committed
54
    private $_database;
55 56 57 58

    /**
     * @var \Doctrine\DBAL\Connection
     */
Benjamin Morel's avatar
Benjamin Morel committed
59
    private $_connection;
60 61

    /**
Benjamin Morel's avatar
Benjamin Morel committed
62 63 64 65
     * @param array                     $tableColumn
     * @param string                    $table
     * @param string                    $database
     * @param \Doctrine\DBAL\Connection $connection
66
     */
67 68 69 70 71 72 73
    public function __construct(array $tableColumn, $table, $database, Connection $connection)
    {
        $this->_tableColumn = $tableColumn;
        $this->_table       = $table;
        $this->_database    = $database;
        $this->_connection  = $connection;
    }
74 75

    /**
76 77 78 79
     * Allows to clear the column which means the column will be excluded from
     * tables column list.
     *
     * @param null|\Doctrine\DBAL\Schema\Column $column
Benjamin Morel's avatar
Benjamin Morel committed
80 81
     *
     * @return \Doctrine\DBAL\Event\SchemaColumnDefinitionEventArgs
82
     */
83
    public function setColumn(Column $column = null)
84
    {
85 86 87
        $this->_column = $column;

        return $this;
88
    }
89

90
    /**
Benjamin Morel's avatar
Benjamin Morel committed
91
     * @return \Doctrine\DBAL\Schema\Column|null
92 93 94 95 96 97
     */
    public function getColumn()
    {
        return $this->_column;
    }

98 99 100 101 102 103 104 105
    /**
     * @return array
     */
    public function getTableColumn()
    {
        return $this->_tableColumn;
    }

106 107 108 109 110 111 112 113 114 115 116 117 118
    /**
     * @return string
     */
    public function getTable()
    {
        return $this->_table;
    }

    /**
     * @return string
     */
    public function getDatabase()
    {
119
        return $this->_database;
120 121 122 123 124 125 126 127 128 129 130
    }

    /**
     * @return \Doctrine\DBAL\Connection
     */
    public function getConnection()
    {
        return $this->_connection;
    }

    /**
131
     * @return \Doctrine\DBAL\Platforms\AbstractPlatform
132 133 134 135 136 137
     */
    public function getDatabasePlatform()
    {
        return $this->_connection->getDatabasePlatform();
    }
}