Column::fetchExistingColumnOptions() - Code Metrics - Inspection of "Fixed Bug 596 - changeColumn resets the nullable o..." - cakephp/phinx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1524)

unknown

created 2019-04-26 01:23 UTC

Column::fetchExistingColumnOptions() A

↳ Parent: Column

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	24
rs	9.536
c	0
b	0
f	0
ccs	0
cts	0
cp	0
cc	1
nc	1
nop	2
crap	2

<?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 Phinx\Db\Table;

use Phinx\Db\Adapter\AdapterInterface;

/**
 *
 * This object is based loosely on: http://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/Table.html.
 */
class Column
{
    /**
     * @var string
     */
    protected $name;

    /**
     * @var string|\Phinx\Util\Literal
     */
    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 $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 = [];

    /**
     * @var string
     */
    protected $collation;

    /**
     * @var string
     */
    protected $encoding;

    /**
     * @var array
     */
    protected $values;

    /**
     * Sets the column name.
     *
     * @param string $name
     * @return \Phinx\Db\Table\Column
     */
    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Gets the column name.
     *
     * @return string|null
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Sets the column type.
     *
     * @param string|\Phinx\Util\Literal $type Column type
     * @return \Phinx\Db\Table\Column
     */
    public function setType($type)
    {
        $this->type = $type;

        return $this;
    }

    /**
     * Gets the column type.
     *
     * @return string|\Phinx\Util\Literal
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Sets the column limit.
     *
     * @param int $limit
     * @return \Phinx\Db\Table\Column
     */
    public function setLimit($limit)
    {
        $this->limit = $limit;

        return $this;
    }

    /**
     * Gets the column limit.
     *
     * @return int
     */
    public function getLimit()
    {
        return $this->limit;
    }

    /**
     * Sets whether the column allows nulls.
     *
     * @param bool $null
     * @return \Phinx\Db\Table\Column
     */
    public function setNull($null)
    {
        $this->null = (bool)$null;

        return $this;
    }

    /**
     * Gets whether the column allows nulls.
     *
     * @return bool
     */
    public function getNull()
    {
        return $this->null;
    }

    /**
     * Does the column allow nulls?
     *
     * @return bool
     */
    public function isNull()
    {
        return $this->getNull();
    }

    /**
     * Sets the default column value.
     *
     * @param mixed $default
     * @return \Phinx\Db\Table\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 bool $identity
     * @return \Phinx\Db\Table\Column
     */
    public function setIdentity($identity)
    {
        $this->identity = $identity;

        return $this;
    }

    /**
     * Gets whether or not the column is an identity column.
     *
     * @return bool
     */
    public function getIdentity()
    {
        return $this->identity;
    }

    /**
     * Is the column an identity column?
     *
     * @return bool
     */
    public function isIdentity()
    {
        return $this->getIdentity();
    }

    /**
     * Sets the name of the column to add this column after.
     *
     * @param string $after After
     * @return \Phinx\Db\Table\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 \Phinx\Db\Table\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 number precision for decimal or float column.
     *
     * For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale,
     * and the column could store value from -999.99 to 999.99.
     *
     * @param int $precision Number precision
     * @return \Phinx\Db\Table\Column
     */
    public function setPrecision($precision)
    {
        $this->setLimit($precision);

        return $this;
    }

    /**
     * Gets the number precision for decimal or float column.
     *
     * For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale,
     * and the column could store value from -999.99 to 999.99.
     *
     * @return int
     */
    public function getPrecision()
    {
        return $this->limit;
    }

    /**
     * Sets the number scale for decimal or float column.
     *
     * For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale,
     * and the column could store value from -999.99 to 999.99.
     *
     * @param int $scale Number scale
     * @return \Phinx\Db\Table\Column
     */
    public function setScale($scale)
    {
        $this->scale = $scale;

        return $this;
    }

    /**
     * Gets the number scale for decimal or float column.
     *
     * For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale,
     * and the column could store value from -999.99 to 999.99.
     *
     * @return int
     */
    public function getScale()
    {
        return $this->scale;
    }

    /**
     * Sets the number precision and scale for decimal or float column.
     *
     * For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale,
     * and the column could store value from -999.99 to 999.99.
     *
     * @param int $precision Number precision
     * @param int $scale Number scale
     * @return \Phinx\Db\Table\Column
     */
    public function setPrecisionAndScale($precision, $scale)
    {
        $this->setLimit($precision);
        $this->scale = $scale;

        return $this;
    }

    /**
     * Sets the column comment.
     *
     * @param string $comment
     * @return \Phinx\Db\Table\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 \Phinx\Db\Table\Column
     */
    public function setSigned($signed)
    {
        $this->signed = (bool)$signed;

        return $this;
    }

    /**
     * Gets whether field should be signed.
     *
     * @return bool
     */
    public function getSigned()
    {
        return $this->signed;
    }

    /**
     * Should the column be signed?
     *
     * @return bool
     */
    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 \Phinx\Db\Table\Column
     */
    public function setTimezone($timezone)
    {
        $this->timezone = (bool)$timezone;

        return $this;
    }

    /**
     * Gets whether field has a timezone identifier.
     *
     * @return bool
     */
    public function getTimezone()
    {
        return $this->timezone;
    }

    /**
     * Should the column have a timezone?
     *
     * @return bool
     */
    public function isTimezone()
    {
        return $this->getTimezone();
    }

    /**
     * Sets field properties.
     *
     * @param array $properties
     *
     * @return \Phinx\Db\Table\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 array|string $values
     *
     * @return \Phinx\Db\Table\Column
     */
    public function setValues($values)
    {
        if (!is_array($values)) {
            $values = preg_split('/,\s*/', $values);
        }
        $this->values = $values;

        return $this;
    }

    /**
     * Gets field values
     *
     * @return array
     */
    public function getValues()
    {
        return $this->values;
    }

    /**
     * Sets the column collation.
     *
     * @param string $collation
     *
     * @throws \UnexpectedValueException If collation not allowed for type
     * @return $this
     */
    public function setCollation($collation)

    {
        $allowedTypes = [
            AdapterInterface::PHINX_TYPE_CHAR,
            AdapterInterface::PHINX_TYPE_STRING,
            AdapterInterface::PHINX_TYPE_TEXT,
        ];
        if (!in_array($this->getType(), $allowedTypes)) {
            throw new \UnexpectedValueException('Collation may be set only for types: ' . implode(', ', $allowedTypes));
        }

        $this->collation = $collation;

        return $this;
    }

    /**
     * Gets the column collation.
     *
     * @return string
     */
    public function getCollation()
    {
        return $this->collation;
    }

    /**
     * Sets the column character set.
     *
     * @param string $encoding
     *
     * @throws \UnexpectedValueException If character set not allowed for type
     * @return $this
     */
    public function setEncoding($encoding)

    {
        $allowedTypes = [
            AdapterInterface::PHINX_TYPE_CHAR,
            AdapterInterface::PHINX_TYPE_STRING,
            AdapterInterface::PHINX_TYPE_TEXT,
        ];
        if (!in_array($this->getType(), $allowedTypes)) {
            throw new \UnexpectedValueException('Character set may be set only for types: ' . implode(', ', $allowedTypes));
        }

        $this->encoding = $encoding;

        return $this;
    }

    /**
     * Gets the column character set.
     *
     * @return string
     */
    public function getEncoding()
    {
        return $this->encoding;
    }

    /**
     * Gets all allowed options. Each option must have a corresponding `setFoo` method.
     *
     * @return array
     */
    protected function getValidOptions()
    {
        return [
            'limit',
            'default',
            'null',
            'identity',
            'scale',
            'after',
            'update',
            'comment',
            'signed',
            'timezone',
            'properties',
            'values',
            'collation',
            'encoding',
        ];
    }

    /**
     * Gets all aliased options. Each alias must reference a valid option.
     *
     * @return array
     */
    protected function getAliasedOptions()
    {
        return [
            'length' => 'limit',
            'precision' => 'limit',
        ];
    }

    /**
     * Fetch Existing Column Options, and can be used to change column schema
     *
     * @param string $tableName of current column
     * @param AdapterInterface current adapter for accessing db
     * @return $this
     */
    public function fetchExistingColumnOptions($tableName, $adapter) 
    {
        $table = new \Phinx\Db\Table($tableName, [], $adapter);
        $retrievedColumnDetails = $table->getColumn($this->name);

        $this->type = $retrievedColumnDetails->type;
        $this->limit = $retrievedColumnDetails->limit;
        $this->null = $retrievedColumnDetails->null;
        $this->default = $retrievedColumnDetails->default;
        $this->identity = $retrievedColumnDetails->identity;
        $this->scale = $retrievedColumnDetails->scale;
        $this->after = $retrievedColumnDetails->after;
        $this->update = $retrievedColumnDetails->update;
        $this->comment = $retrievedColumnDetails->comment;

        $this->signed = $retrievedColumnDetails->signed;
        $this->timezone = $retrievedColumnDetails->timezone;
        $this->properties = $retrievedColumnDetails->properties;
        $this->collation = $retrievedColumnDetails->collation;
        $this->encoding = $retrievedColumnDetails->encoding;
        $this->values = $retrievedColumnDetails->values;    
    
        return $this;
    }

    /**
     * Utility method that maps an array of column options to this objects methods.
     *
     * @param array $options Options
     * @return \Phinx\Db\Table\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;
    }
}


1			<?php
2			/**
3			* Phinx
4			*
5			* (The MIT license)
6			* Copyright (c) 2015 Rob Morgan
7			*
8			* Permission is hereby granted, free of charge, to any person obtaining a copy
9			* of this software and associated * documentation files (the "Software"), to
10			* deal in the Software without restriction, including without limitation the
11			* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
12			* sell copies of the Software, and to permit persons to whom the Software is
13			* furnished to do so, subject to the following conditions:
14			*
15			* The above copyright notice and this permission notice shall be included in
16			* all copies or substantial portions of the Software.
17			*
18			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23			* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24			* IN THE SOFTWARE.
25			*
26			* @package Phinx
27			* @subpackage Phinx\Db
28			*/
29			namespace Phinx\Db\Table;
30
31			use Phinx\Db\Adapter\AdapterInterface;
32
33			/**
34			*
35			* This object is based loosely on: http://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/Table.html.
36			*/
37			class Column
38			{
39			/**
40			* @var string
41			*/
42			protected $name;
43
44			/**
45			* @var string\|\Phinx\Util\Literal
46			*/
47			protected $type;
48
49			/**
50			* @var integer
51			*/
52			protected $limit = null;
53
54			/**
55			* @var boolean
56			*/
57			protected $null = false;
58
59			/**
60			* @var mixed
61			*/
62			protected $default = null;
63
64			/**
65			* @var boolean
66			*/
67			protected $identity = false;
68
69			/**
70			* @var integer
71			*/
72			protected $scale;
73
74			/**
75			* @var string
76			*/
77			protected $after;
78
79			/**
80			* @var string
81			*/
82			protected $update;
83
84			/**
85			* @var string
86			*/
87			protected $comment;
88
89			/**
90			* @var boolean
91			*/
92			protected $signed = true;
93
94			/**
95			* @var boolean
96			*/
97			protected $timezone = false;
98
99			/**
100			* @var array
101			*/
102			protected $properties = [];
103
104			/**
105			* @var string
106			*/
107			protected $collation;
108
109			/**
110			* @var string
111			*/
112			protected $encoding;
113
114			/**
115			* @var array
116			*/
117			protected $values;
118
119			/**
120			* Sets the column name.
121			*
122			* @param string $name
123			* @return \Phinx\Db\Table\Column
124			*/
125			public function setName($name)
126			{
127			$this->name = $name;
128
129			return $this;
130	215		}
131
132	215		/**
133	215		* Gets the column name.
134			*
135			* @return string\|null
136			*/
137			public function getName()
138			{
139			return $this->name;
140			}
141	212
142			/**
143	212		* Sets the column type.
144			*
145			* @param string\|\Phinx\Util\Literal $type Column type
146			* @return \Phinx\Db\Table\Column
147			*/
148			public function setType($type)
149			{
150			$this->type = $type;
151
152	214		return $this;
153			}
154	214
155	214		/**
156			* Gets the column type.
157			*
158			* @return string\|\Phinx\Util\Literal
159			*/
160			public function getType()
161			{
162			return $this->type;
163	212		}
164
165	212		/**
166			* Sets the column limit.
167			*
168			* @param int $limit
169			* @return \Phinx\Db\Table\Column
170			*/
171			public function setLimit($limit)
172			{
173			$this->limit = $limit;
174	192
175			return $this;
176	192		}
177	192
178			/**
179			* Gets the column limit.
180			*
181			* @return int
182			*/
183			public function getLimit()
184			{
185	192		return $this->limit;
186			}
187	192
188			/**
189			* Sets whether the column allows nulls.
190			*
191			* @param bool $null
192			* @return \Phinx\Db\Table\Column
193			*/
194			public function setNull($null)
195			{
196	208		$this->null = (bool)$null;
197
198	208		return $this;
199	208		}
200
201			/**
202			* Gets whether the column allows nulls.
203			*
204			* @return bool
205			*/
206			public function getNull()
207	215		{
208			return $this->null;
209	215		}
210
211			/**
212			* Does the column allow nulls?
213			*
214			* @return bool
215			*/
216			public function isNull()
217	214		{
218			return $this->getNull();
219	214		}
220
221			/**
222			* Sets the default column value.
223			*
224			* @param mixed $default
225			* @return \Phinx\Db\Table\Column
226			*/
227			public function setDefault($default)
228	207		{
229			$this->default = $default;
230	207
231	207		return $this;
232			}
233
234			/**
235			* Gets the default column value.
236			*
237			* @return mixed
238			*/
239	215		public function getDefault()
240			{
241	215		return $this->default;
242			}
243
244			/**
245			* Sets whether or not the column is an identity column.
246			*
247			* @param bool $identity
248			* @return \Phinx\Db\Table\Column
249			*/
250	158		public function setIdentity($identity)
251			{
252	158		$this->identity = $identity;
253	158
254			return $this;
255			}
256
257			/**
258			* Gets whether or not the column is an identity column.
259			*
260			* @return bool
261	199		*/
262			public function getIdentity()
263	199		{
264			return $this->identity;
265			}
266
267			/**
268			* Is the column an identity column?
269			*
270			* @return bool
271	198		*/
272			public function isIdentity()
273	198		{
274			return $this->getIdentity();
275			}
276
277			/**
278			* Sets the name of the column to add this column after.
279			*
280			* @param string $after After
281			* @return \Phinx\Db\Table\Column
282	1		*/
283			public function setAfter($after)
284	1		{
285	1		$this->after = $after;
286
287			return $this;
288			}
289
290			/**
291			* Returns the name of the column to add this column after.
292			*
293	20		* @return string
294			*/
295	20		public function getAfter()
296			{
297			return $this->after;
298			}
299
300			/**
301			* Sets the 'ON UPDATE' mysql column function.
302			*
303			* @param string $update On Update function
304	15		* @return \Phinx\Db\Table\Column
305			*/
306	15		public function setUpdate($update)
307	15		{
308			$this->update = $update;
309
310			return $this;
311			}
312
313			/**
314			* Returns the value of the ON UPDATE column function.
315	145		*
316			* @return string
317	145		*/
318			public function getUpdate()
319			{
320			return $this->update;
321			}
322
323			/**
324			* Sets the number precision for decimal or float column.
325			*
326	9		* For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale,
327			* and the column could store value from -999.99 to 999.99.
328	9		*
329	9		* @param int $precision Number precision
330			* @return \Phinx\Db\Table\Column
331			*/
332			public function setPrecision($precision)
333			{
334			$this->setLimit($precision);
335
336			return $this;
337	131		}
338
339	131		/**
340			* Gets the number precision for decimal or float column.
341			*
342			* For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale,
343			* and the column could store value from -999.99 to 999.99.
344			*
345			* @return int
346			*/
347			public function getPrecision()
348	9		{
349			return $this->limit;
350	9		}
351	9
352			/**
353			* Sets the number scale for decimal or float column.
354			*
355			* For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale,
356			* and the column could store value from -999.99 to 999.99.
357			*
358			* @param int $scale Number scale
359	2		* @return \Phinx\Db\Table\Column
360			*/
361	2		public function setScale($scale)
362			{
363			$this->scale = $scale;
364
365			return $this;
366			}
367
368			/**
369			* Gets the number scale for decimal or float column.
370	9		*
371			* For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale,
372	9		* and the column could store value from -999.99 to 999.99.
373	9		*
374			* @return int
375			*/
376			public function getScale()
377			{
378			return $this->scale;
379			}
380
381	198		/**
382			* Sets the number precision and scale for decimal or float column.
383	198		*
384			* For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale,
385			* and the column could store value from -999.99 to 999.99.
386			*
387			* @param int $precision Number precision
388			* @param int $scale Number scale
389			* @return \Phinx\Db\Table\Column
390			*/
391			public function setPrecisionAndScale($precision, $scale)
392	68		{
393			$this->setLimit($precision);
394	68		$this->scale = $scale;
395	68
396			return $this;
397			}
398
399			/**
400			* Sets the column comment.
401			*
402			* @param string $comment
403	89		* @return \Phinx\Db\Table\Column
404			*/
405	89		public function setComment($comment)
406			{
407			$this->comment = $comment;
408
409			return $this;
410			}
411
412			/**
413	89		* Gets the column comment.
414			*
415	89		* @return string
416			*/
417			public function getComment()
418			{
419			return $this->comment;
420			}
421
422			/**
423			* Sets whether field should be signed.
424			*
425	1		* @param bool $signed
426			* @return \Phinx\Db\Table\Column
427	1		*/
428	1		public function setSigned($signed)
429			{
430			$this->signed = (bool)$signed;
431
432			return $this;
433			}
434
435			/**
436	68		* Gets whether field should be signed.
437			*
438	68		* @return bool
439			*/
440			public function getSigned()
441			{
442			return $this->signed;
443			}
444
445			/**
446	68		* Should the column be signed?
447			*
448	68		* @return bool
449			*/
450			public function isSigned()
451			{
452			return $this->getSigned();
453			}
454
455			/**
456			* Sets whether the field should have a timezone identifier.
457			* Used for date/time columns only!
458			*
459			* @param bool $timezone
460			* @return \Phinx\Db\Table\Column
461			*/
462			public function setTimezone($timezone)
463			{
464			$this->timezone = (bool)$timezone;
465
466			return $this;
467			}
468
469			/**
470			* Gets whether field has a timezone identifier.
471			*
472			* @return bool
473			*/
474			public function getTimezone()
475			{
476			return $this->timezone;
477			}
478
479			/**
480			* Should the column have a timezone?
481	9		*
482			* @return bool
483	9		*/
484	2		public function isTimezone()
485	2		{
486	9		return $this->getTimezone();
487	9		}
488
489			/**
490			* Sets field properties.
491			*
492			* @param array $properties
493			*
494			* @return \Phinx\Db\Table\Column
495	131		*/
496			public function setProperties($properties)
497	131		{
498			$this->properties = $properties;
499
500			return $this;
501			}
502
503			/**
504			* Gets field properties
505			*
506			* @return array
507			*/
508	1		public function getProperties()
509			{
510			return $this->properties;
511	1		}
512	1
513	1		/**
514	1		* Sets field values.
515	1		*
516			* @param array\|string $values
517			*
518			* @return \Phinx\Db\Table\Column
519	1		*/
520			public function setValues($values)
521	1		{
522			if (!is_array($values)) {
523			$values = preg_split('/,\s*/', $values);
524			}
525			$this->values = $values;
526
527			return $this;
528			}
529	89
530			/**
531	89		* Gets field values
532			*
533			* @return array
534			*/
535			public function getValues()
536			{
537			return $this->values;
538			}
539
540			/**
541			* Sets the column collation.
542			*
543			* @param string $collation
544			*
545			* @throws \UnexpectedValueException If collation not allowed for type
546			* @return $this
547			*/
548		View Code Duplication	public function setCollation($collation)
			0 ignored issues – show Duplication introduced 2017-09-15 20:49 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
549			{
550			$allowedTypes = [
551			AdapterInterface::PHINX_TYPE_CHAR,
552			AdapterInterface::PHINX_TYPE_STRING,
553			AdapterInterface::PHINX_TYPE_TEXT,
554			];
555			if (!in_array($this->getType(), $allowedTypes)) {
556			throw new \UnexpectedValueException('Collation may be set only for types: ' . implode(', ', $allowedTypes));
557			}
558
559			$this->collation = $collation;
560
561			return $this;
562			}
563	89
564			/**
565	89		* Gets the column collation.
566			*
567			* @return string
568			*/
569			public function getCollation()
570			{
571			return $this->collation;
572			}
573	209
574			/**
575			* Sets the column character set.
576	209		*
577	209		* @param string $encoding
578	209		*
579	209		* @throws \UnexpectedValueException If character set not allowed for type
580	209		* @return $this
581	209		*/
582	209	View Code Duplication	public function setEncoding($encoding)
			0 ignored issues – show Duplication introduced 2017-09-15 20:49 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
583	209		{
584	209		$allowedTypes = [
585	209		AdapterInterface::PHINX_TYPE_CHAR,
586	209		AdapterInterface::PHINX_TYPE_STRING,
587	209		AdapterInterface::PHINX_TYPE_TEXT,
588	209		];
589	209		if (!in_array($this->getType(), $allowedTypes)) {
590	209		throw new \UnexpectedValueException('Character set may be set only for types: ' . implode(', ', $allowedTypes));
591	209		}
592
593			$this->encoding = $encoding;
594
595			return $this;
596			}
597
598			/**
599	209		* Gets the column character set.
600			*
601			* @return string
602	209		*/
603	209		public function getEncoding()
604			{
605			return $this->encoding;
606			}
607
608			/**
609			* Gets all allowed options. Each option must have a corresponding `setFoo` method.
610			*
611			* @return array
612	209		*/
613			protected function getValidOptions()
614	209		{
615	209		return [
616			'limit',
617	209		'default',
618	208		'null',
619			'identity',
620			'scale',
621			'after',
622			'update',
623	208		'comment',
624	1		'signed',
625			'timezone',
626			'properties',
627	207		'values',
628	207		'collation',
629	208		'encoding',
630	208		];
631			}
632
633			/**
634			* Gets all aliased options. Each alias must reference a valid option.
635			*
636			* @return array
637			*/
638			protected function getAliasedOptions()
639			{
640			return [
641			'length' => 'limit',
642			'precision' => 'limit',
643			];
644			}
645
646			/**
647			* Fetch Existing Column Options, and can be used to change column schema
648			*
649			* @param string $tableName of current column
650			* @param AdapterInterface current adapter for accessing db
651			* @return $this
652			*/
653			public function fetchExistingColumnOptions($tableName, $adapter)
654			{
655			$table = new \Phinx\Db\Table($tableName, [], $adapter);
656			$retrievedColumnDetails = $table->getColumn($this->name);
657
658			$this->type = $retrievedColumnDetails->type;
659			$this->limit = $retrievedColumnDetails->limit;
660			$this->null = $retrievedColumnDetails->null;
661			$this->default = $retrievedColumnDetails->default;
662			$this->identity = $retrievedColumnDetails->identity;
663			$this->scale = $retrievedColumnDetails->scale;
664			$this->after = $retrievedColumnDetails->after;
665			$this->update = $retrievedColumnDetails->update;
666			$this->comment = $retrievedColumnDetails->comment;
667
668			$this->signed = $retrievedColumnDetails->signed;
669			$this->timezone = $retrievedColumnDetails->timezone;
670			$this->properties = $retrievedColumnDetails->properties;
671			$this->collation = $retrievedColumnDetails->collation;
672			$this->encoding = $retrievedColumnDetails->encoding;
673			$this->values = $retrievedColumnDetails->values;
674
675			return $this;
676			}
677
678			/**
679			* Utility method that maps an array of column options to this objects methods.
680			*
681			* @param array $options Options
682			* @return \Phinx\Db\Table\Column
683			*/
684			public function setOptions($options)
685			{
686			$validOptions = $this->getValidOptions();
687			$aliasOptions = $this->getAliasedOptions();
688
689			foreach ($options as $option => $value) {
690
691			if (isset($aliasOptions[$option])) {
692			// proxy alias -> option
693			$option = $aliasOptions[$option];
694			}
695
696			if (!in_array($option, $validOptions, true)) {
697			throw new \RuntimeException(sprintf('"%s" is not a valid column option.', $option));
698			}
699
700			$method = 'set' . ucfirst($option);
701			$this->$method($value);
702			}
703
704			return $this;
705			}
706			}
707

cakephp / phinx

Pull Request — master (#1524)

Column::fetchExistingColumnOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like