SchemaAlterTableEventArgs.php 1.42 KB
Newer Older
1 2 3 4
<?php

namespace Doctrine\DBAL\Event;

Benjamin Morel's avatar
Benjamin Morel committed
5 6
use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Schema\TableDiff;
7

8
use function array_merge;
9
use function func_get_args;
10
use function is_array;
11 12 13 14 15 16

/**
 * Event Arguments used when SQL queries for creating tables are generated inside Doctrine\DBAL\Platform\*Platform.
 */
class SchemaAlterTableEventArgs extends SchemaEventArgs
{
17
    /** @var TableDiff */
18
    private $tableDiff;
19

20
    /** @var AbstractPlatform */
21
    private $platform;
22

23
    /** @var string[] */
24
    private $sql = [];
25 26 27

    public function __construct(TableDiff $tableDiff, AbstractPlatform $platform)
    {
28 29
        $this->tableDiff = $tableDiff;
        $this->platform  = $platform;
30 31 32
    }

    /**
33
     * @return TableDiff
34 35 36
     */
    public function getTableDiff()
    {
37
        return $this->tableDiff;
38 39 40
    }

    /**
41
     * @return AbstractPlatform
42 43 44
     */
    public function getPlatform()
    {
45
        return $this->platform;
46 47 48
    }

    /**
49 50
     * Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead.
     *
51
     * @param string|string[] $sql
Benjamin Morel's avatar
Benjamin Morel committed
52
     *
Grégoire Paris's avatar
Grégoire Paris committed
53
     * @return SchemaAlterTableEventArgs
54 55 56
     */
    public function addSql($sql)
    {
57
        $this->sql = array_merge($this->sql, is_array($sql) ? $sql : func_get_args());
58 59 60 61 62

        return $this;
    }

    /**
63
     * @return string[]
64 65 66
     */
    public function getSql()
    {
67
        return $this->sql;
68 69
    }
}