502 lines
9.5 KiB
PHP
502 lines
9.5 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\Schema;
|
|
|
|
use Doctrine\DBAL\Types\Type;
|
|
use const E_USER_DEPRECATED;
|
|
use function array_merge;
|
|
use function is_numeric;
|
|
use function method_exists;
|
|
use function sprintf;
|
|
use function trigger_error;
|
|
|
|
/**
|
|
* Object representation of a database column.
|
|
*
|
|
* @link www.doctrine-project.org
|
|
* @since 2.0
|
|
* @author Benjamin Eberlei <kontakt@beberlei.de>
|
|
*/
|
|
class Column extends AbstractAsset
|
|
{
|
|
/**
|
|
* @var Type
|
|
*/
|
|
protected $_type;
|
|
|
|
/**
|
|
* @var int|null
|
|
*/
|
|
protected $_length = null;
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
protected $_precision = 10;
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
protected $_scale = 0;
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
protected $_unsigned = false;
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
protected $_fixed = false;
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
protected $_notnull = true;
|
|
|
|
/**
|
|
* @var string|null
|
|
*/
|
|
protected $_default = null;
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
protected $_autoincrement = false;
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $_platformOptions = [];
|
|
|
|
/**
|
|
* @var string|null
|
|
*/
|
|
protected $_columnDefinition = null;
|
|
|
|
/**
|
|
* @var string|null
|
|
*/
|
|
protected $_comment = null;
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $_customSchemaOptions = [];
|
|
|
|
/**
|
|
* Creates a new Column.
|
|
*
|
|
* @param string $columnName
|
|
* @param Type $type
|
|
* @param array $options
|
|
*/
|
|
public function __construct($columnName, Type $type, array $options=[])
|
|
{
|
|
$this->_setName($columnName);
|
|
$this->setType($type);
|
|
$this->setOptions($options);
|
|
}
|
|
|
|
/**
|
|
* @param array $options
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setOptions(array $options)
|
|
{
|
|
foreach ($options as $name => $value) {
|
|
$method = "set".$name;
|
|
if ( ! method_exists($this, $method)) {
|
|
// next major: throw an exception
|
|
@trigger_error(sprintf(
|
|
'The "%s" column option is not supported,'.
|
|
' setting it is deprecated and will cause an error in Doctrine 3.0',
|
|
$name
|
|
), E_USER_DEPRECATED);
|
|
|
|
continue;
|
|
}
|
|
$this->$method($value);
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param Type $type
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setType(Type $type)
|
|
{
|
|
$this->_type = $type;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param int|null $length
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setLength($length)
|
|
{
|
|
if ($length !== null) {
|
|
$this->_length = (int) $length;
|
|
} else {
|
|
$this->_length = null;
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param int $precision
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setPrecision($precision)
|
|
{
|
|
if (!is_numeric($precision)) {
|
|
$precision = 10; // defaults to 10 when no valid precision is given.
|
|
}
|
|
|
|
$this->_precision = (int) $precision;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param int $scale
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setScale($scale)
|
|
{
|
|
if (!is_numeric($scale)) {
|
|
$scale = 0;
|
|
}
|
|
|
|
$this->_scale = (int) $scale;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param bool $unsigned
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setUnsigned($unsigned)
|
|
{
|
|
$this->_unsigned = (bool) $unsigned;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param bool $fixed
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setFixed($fixed)
|
|
{
|
|
$this->_fixed = (bool) $fixed;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param bool $notnull
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setNotnull($notnull)
|
|
{
|
|
$this->_notnull = (bool) $notnull;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param mixed $default
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setDefault($default)
|
|
{
|
|
$this->_default = $default;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param array $platformOptions
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setPlatformOptions(array $platformOptions)
|
|
{
|
|
$this->_platformOptions = $platformOptions;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param mixed $value
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setPlatformOption($name, $value)
|
|
{
|
|
$this->_platformOptions[$name] = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param string $value
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setColumnDefinition($value)
|
|
{
|
|
$this->_columnDefinition = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return Type
|
|
*/
|
|
public function getType()
|
|
{
|
|
return $this->_type;
|
|
}
|
|
|
|
/**
|
|
* @return int|null
|
|
*/
|
|
public function getLength()
|
|
{
|
|
return $this->_length;
|
|
}
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
public function getPrecision()
|
|
{
|
|
return $this->_precision;
|
|
}
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
public function getScale()
|
|
{
|
|
return $this->_scale;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function getUnsigned()
|
|
{
|
|
return $this->_unsigned;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function getFixed()
|
|
{
|
|
return $this->_fixed;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function getNotnull()
|
|
{
|
|
return $this->_notnull;
|
|
}
|
|
|
|
/**
|
|
* @return string|null
|
|
*/
|
|
public function getDefault()
|
|
{
|
|
return $this->_default;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function getPlatformOptions()
|
|
{
|
|
return $this->_platformOptions;
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function hasPlatformOption($name)
|
|
{
|
|
return isset($this->_platformOptions[$name]);
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getPlatformOption($name)
|
|
{
|
|
return $this->_platformOptions[$name];
|
|
}
|
|
|
|
/**
|
|
* @return string|null
|
|
*/
|
|
public function getColumnDefinition()
|
|
{
|
|
return $this->_columnDefinition;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function getAutoincrement()
|
|
{
|
|
return $this->_autoincrement;
|
|
}
|
|
|
|
/**
|
|
* @param bool $flag
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setAutoincrement($flag)
|
|
{
|
|
$this->_autoincrement = $flag;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param string $comment
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setComment($comment)
|
|
{
|
|
$this->_comment = $comment;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return string|null
|
|
*/
|
|
public function getComment()
|
|
{
|
|
return $this->_comment;
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param mixed $value
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setCustomSchemaOption($name, $value)
|
|
{
|
|
$this->_customSchemaOptions[$name] = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function hasCustomSchemaOption($name)
|
|
{
|
|
return isset($this->_customSchemaOptions[$name]);
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getCustomSchemaOption($name)
|
|
{
|
|
return $this->_customSchemaOptions[$name];
|
|
}
|
|
|
|
/**
|
|
* @param array $customSchemaOptions
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setCustomSchemaOptions(array $customSchemaOptions)
|
|
{
|
|
$this->_customSchemaOptions = $customSchemaOptions;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function getCustomSchemaOptions()
|
|
{
|
|
return $this->_customSchemaOptions;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function toArray()
|
|
{
|
|
return array_merge([
|
|
'name' => $this->_name,
|
|
'type' => $this->_type,
|
|
'default' => $this->_default,
|
|
'notnull' => $this->_notnull,
|
|
'length' => $this->_length,
|
|
'precision' => $this->_precision,
|
|
'scale' => $this->_scale,
|
|
'fixed' => $this->_fixed,
|
|
'unsigned' => $this->_unsigned,
|
|
'autoincrement' => $this->_autoincrement,
|
|
'columnDefinition' => $this->_columnDefinition,
|
|
'comment' => $this->_comment,
|
|
], $this->_platformOptions, $this->_customSchemaOptions);
|
|
}
|
|
}
|