122 lines
3.1 KiB
PHP
122 lines
3.1 KiB
PHP
<?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\Connection;
|
|
use Doctrine\DBAL\Schema\Index;
|
|
|
|
/**
|
|
* Event Arguments used when the portable index definition is generated inside Doctrine\DBAL\Schema\AbstractSchemaManager.
|
|
*
|
|
* @link www.doctrine-project.org
|
|
* @since 2.2
|
|
* @author Jan Sorgalla <jsorgalla@googlemail.com>
|
|
*/
|
|
class SchemaIndexDefinitionEventArgs extends SchemaEventArgs
|
|
{
|
|
/**
|
|
* @var \Doctrine\DBAL\Schema\Index|null
|
|
*/
|
|
private $_index = null;
|
|
|
|
/**
|
|
* Raw index data as fetched from the database.
|
|
*
|
|
* @var array
|
|
*/
|
|
private $_tableIndex;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $_table;
|
|
|
|
/**
|
|
* @var \Doctrine\DBAL\Connection
|
|
*/
|
|
private $_connection;
|
|
|
|
/**
|
|
* @param array $tableIndex
|
|
* @param string $table
|
|
* @param \Doctrine\DBAL\Connection $connection
|
|
*/
|
|
public function __construct(array $tableIndex, $table, Connection $connection)
|
|
{
|
|
$this->_tableIndex = $tableIndex;
|
|
$this->_table = $table;
|
|
$this->_connection = $connection;
|
|
}
|
|
|
|
/**
|
|
* Allows to clear the index which means the index will be excluded from tables index list.
|
|
*
|
|
* @param null|\Doctrine\DBAL\Schema\Index $index
|
|
*
|
|
* @return SchemaIndexDefinitionEventArgs
|
|
*/
|
|
public function setIndex(Index $index = null)
|
|
{
|
|
$this->_index = $index;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return \Doctrine\DBAL\Schema\Index|null
|
|
*/
|
|
public function getIndex()
|
|
{
|
|
return $this->_index;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function getTableIndex()
|
|
{
|
|
return $this->_tableIndex;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getTable()
|
|
{
|
|
return $this->_table;
|
|
}
|
|
|
|
/**
|
|
* @return \Doctrine\DBAL\Connection
|
|
*/
|
|
public function getConnection()
|
|
{
|
|
return $this->_connection;
|
|
}
|
|
|
|
/**
|
|
* @return \Doctrine\DBAL\Platforms\AbstractPlatform
|
|
*/
|
|
public function getDatabasePlatform()
|
|
{
|
|
return $this->_connection->getDatabasePlatform();
|
|
}
|
|
}
|