551 lines
10 KiB
PHP
551 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* Phinx
|
|
*
|
|
* (The MIT license)
|
|
* Copyright (c) 2015 Rob Morgan
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated * documentation files (the "Software"), to
|
|
* deal in the Software without restriction, including without limitation the
|
|
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
* sell copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
* IN THE SOFTWARE.
|
|
*
|
|
* @package Phinx
|
|
* @subpackage Phinx\Db
|
|
*/
|
|
namespace DDLWrapper\Db\Table;
|
|
|
|
/**
|
|
*
|
|
* This object is based loosely on: http://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/Table.html.
|
|
*/
|
|
class Column
|
|
{
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $name;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $type;
|
|
|
|
/**
|
|
* @var integer
|
|
*/
|
|
protected $limit = null;
|
|
|
|
/**
|
|
* @var boolean
|
|
*/
|
|
protected $null = false;
|
|
|
|
/**
|
|
* @var mixed
|
|
*/
|
|
protected $default = null;
|
|
|
|
/**
|
|
* @var boolean
|
|
*/
|
|
protected $identity = false;
|
|
|
|
/**
|
|
* @var integer
|
|
*/
|
|
protected $precision;
|
|
|
|
/**
|
|
* @var integer
|
|
*/
|
|
protected $scale;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $after;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $update;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $comment;
|
|
|
|
/**
|
|
* @var boolean
|
|
*/
|
|
protected $signed = true;
|
|
|
|
/**
|
|
* @var boolean
|
|
*/
|
|
protected $timezone = false;
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $properties = array();
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $values;
|
|
|
|
/**
|
|
* Sets the column name.
|
|
*
|
|
* @param string $name
|
|
* @return Column
|
|
*/
|
|
public function setName($name)
|
|
{
|
|
$this->name = $name;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the column name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getName()
|
|
{
|
|
return $this->name;
|
|
}
|
|
|
|
/**
|
|
* Sets the column type.
|
|
*
|
|
* @param string $type
|
|
* @return Column
|
|
*/
|
|
public function setType($type)
|
|
{
|
|
$this->type = $type;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the column type.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getType()
|
|
{
|
|
return $this->type;
|
|
}
|
|
|
|
/**
|
|
* Sets the column limit.
|
|
*
|
|
* @param integer $limit
|
|
* @return Column
|
|
*/
|
|
public function setLimit($limit)
|
|
{
|
|
$this->limit = $limit;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the column limit.
|
|
*
|
|
* @return integer
|
|
*/
|
|
public function getLimit()
|
|
{
|
|
return $this->limit;
|
|
}
|
|
|
|
/**
|
|
* Sets whether the column allows nulls.
|
|
*
|
|
* @param boolean $null
|
|
* @return Column
|
|
*/
|
|
public function setNull($null)
|
|
{
|
|
$this->null = (bool) $null;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets whether the column allows nulls.
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function getNull()
|
|
{
|
|
return $this->null;
|
|
}
|
|
|
|
/**
|
|
* Does the column allow nulls?
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function isNull()
|
|
{
|
|
return $this->getNull();
|
|
}
|
|
|
|
/**
|
|
* Sets the default column value.
|
|
*
|
|
* @param mixed $default
|
|
* @return Column
|
|
*/
|
|
public function setDefault($default)
|
|
{
|
|
$this->default = $default;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the default column value.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getDefault()
|
|
{
|
|
return $this->default;
|
|
}
|
|
|
|
/**
|
|
* Sets whether or not the column is an identity column.
|
|
*
|
|
* @param boolean $identity
|
|
* @return Column
|
|
*/
|
|
public function setIdentity($identity)
|
|
{
|
|
$this->identity = $identity;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets whether or not the column is an identity column.
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function getIdentity()
|
|
{
|
|
return $this->identity;
|
|
}
|
|
|
|
/**
|
|
* Is the column an identity column?
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function isIdentity()
|
|
{
|
|
return $this->getIdentity();
|
|
}
|
|
|
|
/**
|
|
* Sets the name of the column to add this column after.
|
|
*
|
|
* @param string $after After
|
|
* @return Column
|
|
*/
|
|
public function setAfter($after)
|
|
{
|
|
$this->after = $after;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Returns the name of the column to add this column after.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getAfter()
|
|
{
|
|
return $this->after;
|
|
}
|
|
|
|
/**
|
|
* Sets the 'ON UPDATE' mysql column function.
|
|
*
|
|
* @param string $update On Update function
|
|
* @return Column
|
|
*/
|
|
public function setUpdate($update)
|
|
{
|
|
$this->update = $update;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Returns the value of the ON UPDATE column function.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getUpdate()
|
|
{
|
|
return $this->update;
|
|
}
|
|
|
|
/**
|
|
* Sets the column precision for decimal.
|
|
*
|
|
* @param integer $precision
|
|
* @return Column
|
|
*/
|
|
public function setPrecision($precision)
|
|
{
|
|
$this->precision = $precision;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the column precision for decimal.
|
|
*
|
|
* @return integer
|
|
*/
|
|
public function getPrecision()
|
|
{
|
|
return $this->precision;
|
|
}
|
|
|
|
/**
|
|
* Sets the column scale for decimal.
|
|
*
|
|
* @param integer $scale
|
|
* @return Column
|
|
*/
|
|
public function setScale($scale)
|
|
{
|
|
$this->scale = $scale;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the column scale for decimal.
|
|
*
|
|
* @return integer
|
|
*/
|
|
public function getScale()
|
|
{
|
|
return $this->scale;
|
|
}
|
|
|
|
/**
|
|
* Sets the column comment.
|
|
*
|
|
* @param string $comment
|
|
* @return Column
|
|
*/
|
|
public function setComment($comment)
|
|
{
|
|
$this->comment = $comment;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the column comment.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getComment()
|
|
{
|
|
return $this->comment;
|
|
}
|
|
|
|
/**
|
|
* Sets whether field should be signed.
|
|
*
|
|
* @param bool $signed
|
|
* @return Column
|
|
*/
|
|
public function setSigned($signed)
|
|
{
|
|
$this->signed = (bool) $signed;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets whether field should be signed.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getSigned()
|
|
{
|
|
return $this->signed;
|
|
}
|
|
|
|
/**
|
|
* Should the column be signed?
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function isSigned()
|
|
{
|
|
return $this->getSigned();
|
|
}
|
|
|
|
/**
|
|
* Sets whether the field should have a timezone identifier.
|
|
* Used for date/time columns only!
|
|
*
|
|
* @param bool $timezone
|
|
* @return Column
|
|
*/
|
|
public function setTimezone($timezone)
|
|
{
|
|
$this->timezone = (bool) $timezone;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets whether field has a timezone identifier.
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function getTimezone()
|
|
{
|
|
return $this->timezone;
|
|
}
|
|
|
|
/**
|
|
* Should the column have a timezone?
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function isTimezone()
|
|
{
|
|
return $this->getTimezone();
|
|
}
|
|
|
|
/**
|
|
* Sets field properties.
|
|
*
|
|
* @param array $properties
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setProperties($properties)
|
|
{
|
|
$this->properties = $properties;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets field properties
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getProperties()
|
|
{
|
|
return $this->properties;
|
|
}
|
|
|
|
/**
|
|
* Sets field values.
|
|
*
|
|
* @param mixed (array|string) $values
|
|
*
|
|
* @return Column
|
|
*/
|
|
public function setValues($values)
|
|
{
|
|
if (!is_array($values)) {
|
|
$values = preg_split('/,\s*/', $values);
|
|
}
|
|
$this->values = $values;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets field values
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getValues()
|
|
{
|
|
return $this->values;
|
|
}
|
|
|
|
/**
|
|
* Gets all allowed options. Each option must have a corresponding `setFoo` method.
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function getValidOptions()
|
|
{
|
|
return array(
|
|
'limit',
|
|
'default',
|
|
'null',
|
|
'identity',
|
|
'precision',
|
|
'scale',
|
|
'after',
|
|
'update',
|
|
'comment',
|
|
'signed',
|
|
'timezone',
|
|
'properties',
|
|
'values',
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Gets all aliased options. Each alias must reference a valid option.
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function getAliasedOptions()
|
|
{
|
|
return array(
|
|
'length' => 'limit',
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Utility method that maps an array of column options to this objects methods.
|
|
*
|
|
* @param array $options Options
|
|
* @return Column
|
|
*/
|
|
public function setOptions($options)
|
|
{
|
|
$validOptions = $this->getValidOptions();
|
|
$aliasOptions = $this->getAliasedOptions();
|
|
|
|
foreach ($options as $option => $value) {
|
|
if (isset($aliasOptions[$option])) {
|
|
// proxy alias -> option
|
|
$option = $aliasOptions[$option];
|
|
}
|
|
|
|
if (!in_array($option, $validOptions, true)) {
|
|
throw new \RuntimeException(sprintf('"%s" is not a valid column option.', $option));
|
|
}
|
|
|
|
$method = 'set' . ucfirst($option);
|
|
$this->$method($value);
|
|
}
|
|
return $this;
|
|
}
|
|
}
|