<?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 * and is licensed under the MIT license. For more information, see * <http://www.doctrine-project.org>. */ namespace Doctrine\DBAL\Event; use Doctrine\DBAL\Platforms\AbstractPlatform; use Doctrine\DBAL\Schema\Column; use Doctrine\DBAL\Schema\TableDiff; use function array_merge; use function is_array; /** * Event Arguments used when SQL queries for renaming table columns are generated inside Doctrine\DBAL\Platform\*Platform. * * @link www.doctrine-project.org * @since 2.2 * @author Jan Sorgalla <jsorgalla@googlemail.com> */ class SchemaAlterTableRenameColumnEventArgs extends SchemaEventArgs { /** * @var string */ private $_oldColumnName; /** * @var \Doctrine\DBAL\Schema\Column */ private $_column; /** * @var \Doctrine\DBAL\Schema\TableDiff */ private $_tableDiff; /** * @var \Doctrine\DBAL\Platforms\AbstractPlatform */ private $_platform; /** * @var array */ private $_sql = []; /** * @param string $oldColumnName * @param \Doctrine\DBAL\Schema\Column $column * @param \Doctrine\DBAL\Schema\TableDiff $tableDiff * @param \Doctrine\DBAL\Platforms\AbstractPlatform $platform */ public function __construct($oldColumnName, Column $column, TableDiff $tableDiff, AbstractPlatform $platform) { $this->_oldColumnName = $oldColumnName; $this->_column = $column; $this->_tableDiff = $tableDiff; $this->_platform = $platform; } /** * @return string */ public function getOldColumnName() { return $this->_oldColumnName; } /** * @return \Doctrine\DBAL\Schema\Column */ public function getColumn() { return $this->_column; } /** * @return \Doctrine\DBAL\Schema\TableDiff */ public function getTableDiff() { return $this->_tableDiff; } /** * @return \Doctrine\DBAL\Platforms\AbstractPlatform */ public function getPlatform() { return $this->_platform; } /** * @param string|array $sql * * @return \Doctrine\DBAL\Event\SchemaAlterTableRenameColumnEventArgs */ 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; } }