SchemaCreateTableEventArgs.php 1.82 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\Table;
7 8
use function array_merge;
use function is_array;
9 10 11 12 13 14

/**
 * Event Arguments used when SQL queries for creating tables are generated inside Doctrine\DBAL\Platform\AbstractPlatform.
 */
class SchemaCreateTableEventArgs extends SchemaEventArgs
{
15
    /** @var Table */
16
    private $table;
17

Sergei Morozov's avatar
Sergei Morozov committed
18
    /** @var mixed[][] */
19
    private $columns;
20

21
    /** @var mixed[] */
22
    private $options;
23

24
    /** @var AbstractPlatform */
25
    private $platform;
26

27
    /** @var string[] */
28
    private $sql = [];
29

jsor's avatar
jsor committed
30
    /**
Sergei Morozov's avatar
Sergei Morozov committed
31 32
     * @param mixed[][] $columns
     * @param mixed[]   $options
jsor's avatar
jsor committed
33
     */
34
    public function __construct(Table $table, array $columns, array $options, AbstractPlatform $platform)
35
    {
36 37 38 39
        $this->table    = $table;
        $this->columns  = $columns;
        $this->options  = $options;
        $this->platform = $platform;
40 41 42
    }

    /**
43
     * @return Table
44 45 46
     */
    public function getTable()
    {
47
        return $this->table;
48 49
    }

50
    /**
Sergei Morozov's avatar
Sergei Morozov committed
51
     * @return mixed[][]
52 53 54
     */
    public function getColumns()
    {
55
        return $this->columns;
56 57 58
    }

    /**
59
     * @return mixed[]
60 61 62
     */
    public function getOptions()
    {
63
        return $this->options;
64 65
    }

66
    /**
67
     * @return AbstractPlatform
68 69 70
     */
    public function getPlatform()
    {
71
        return $this->platform;
72
    }
jsor's avatar
jsor committed
73 74

    /**
75
     * @param string|string[] $sql
Benjamin Morel's avatar
Benjamin Morel committed
76
     *
77
     * @return \Doctrine\DBAL\Event\SchemaCreateTableEventArgs
jsor's avatar
jsor committed
78 79 80 81
     */
    public function addSql($sql)
    {
        if (is_array($sql)) {
82
            $this->sql = array_merge($this->sql, $sql);
jsor's avatar
jsor committed
83
        } else {
84
            $this->sql[] = $sql;
jsor's avatar
jsor committed
85 86 87 88 89 90
        }

        return $this;
    }

    /**
91
     * @return string[]
jsor's avatar
jsor committed
92 93 94
     */
    public function getSql()
    {
95
        return $this->sql;
jsor's avatar
jsor committed
96
    }
97
}