Blueprint::addColumn() - Code Metrics - Inspection of "Added basic data layer" - stfkolev/chaospelt - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c0b632...08da57 )

by Stf

created 2022-03-23 07:05 UTC

Blueprint::addColumn() A

↳ Parent: Blueprint

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	3
c	1
b	0
f	0
dl	0
loc	5
rs	10
cc	1
nc	1
nop	3

<?php

/**
 * Database query builder core, named Blueprint
 *
 * PHP version 7.4
 *
 * @category Database
 * @package  Chaospelt\Kernel\Database
 *
 * @author  Stf Kolev <[email protected]>
 * @license BSD-3-Clause https://opensource.org/licenses/BSD-3-Clause
 *
 * @link https://github.com/stfkolev/chaospelt
 */

namespace Chaospelt\Kernel\Database;

use Chaospelt\Kernel\Support\Vivid;
use Chaospelt\Kernel\Database\ColumnDefinition;

/**
 * Database query builder core, named Blueprint
 *
 * @category Database
 * @package  Chaospelt\Kernel\Database
 *
 * @author  Stf Kolev <[email protected]>
 * @license BSD-3-Clause https://opensource.org/licenses/BSD-3-Clause
 *
 * @link https://github.com/stfkolev/chaospelt
 */
class Blueprint
{
    /**
     * The table the blueprint describes.
     *
     * @var string
     */
    protected $table;

    /**
     * The prefix of the table.
     *
     * @var string
     */
    protected $prefix;

    /**
     * The columns that should be added to the table.
     *
     * @var \Chaospelt\Kernel\Database\ColumnDefinition[]
     */
    protected $columns = [];

    /**
     * The commands that should be run for the table.
     *
     * @var \Chaospelt\Kernel\Support\Fluent[]
     */
    protected $commands = [];

    /**
     * The storage engine that should be used for the table.
     *
     * @var string
     */
    public $engine;

    /**
     * The default character set that should be used for the table.
     *
     * @var string
     */
    public $charset;

    /**
     * The collation that should be used for the table.
     *
     * @var string
     */
    public $collation;

    /**
     * Whether to make the table temporary.
     *
     * @var bool
     */
    public $temporary = false;

    /**
     * The column to add new columns after.
     *
     * @var string
     */
    public $after;

    /**
     * Create a new schema blueprint.
     *
     * @param string        $table    
     * @param \Closure|null $callback 
     * @param string        $prefix  
     *  
     * @return void
     */
    public function __construct($table, Closure $callback = null, $prefix = '')

    {
        $this->table = $table;
        $this->prefix = $prefix;

        if (! is_null($callback)) {
            $callback($this);
        }
    }

    /**
     * Create a new string column on the table.
     *
     * @param string   $column 
     * @param int|null $length 
     * 
     * @return \Chaospelt\Kernel\Database\ColumnDefinition
     */
    public function string($column, $length = null)
    {
        $length = $length ?: \Chaospelt\Helpers\Schema::$defaultStringLength;

        return $this->addColumn('string', $column, compact('length'));
    }


    /**
     * Add a new column to the blueprint.
     *
     * @param string $type       Column Type
     * @param string $name       Column Name
     * @param array  $parameters Column Parameters List
     * 
     * @return \Chaospelt\Kernel\Database\ColumnDefinition
     */
    public function addColumn($type, $name, array $parameters = [])
    {
        return $this->addColumnDefinition(
            new ColumnDefinition(
                array_merge(compact('type', 'name'), $parameters)
            )
        );
    }

    /**
     * Add a new column definition to the blueprint.
     *
     * @param \Chaospelt\Kernel\Database\ColumnDefinition $definition 
     * 
     * @return \Chaospelt\Kernel\Database\ColumnDefinition
     */
    protected function addColumnDefinition($definition)
    {
        $this->columns[] = $definition;

        if ($this->after) {
            $definition->after($this->after);

            $this->after = $definition->name;

        }

        return $definition;
    }

    /**
     * Get the columns on the blueprint.
     *
     * @return \Chaospelt\Kernel\Database\ColumnDefinition[]
     */
    public function getColumns()
    {
        return $this->columns;
    }
}

1			<?php
2
3			/**
4			* Database query builder core, named Blueprint
5			*
6			* PHP version 7.4
7			*
8			* @category Database
9			* @package Chaospelt\Kernel\Database
10			*
11			* @author Stf Kolev <[email protected]>
12			* @license BSD-3-Clause https://opensource.org/licenses/BSD-3-Clause
13			*
14			* @link https://github.com/stfkolev/chaospelt
15			*/
16
17			namespace Chaospelt\Kernel\Database;
18
19			use Chaospelt\Kernel\Support\Vivid;
20			use Chaospelt\Kernel\Database\ColumnDefinition;
21
22			/**
23			* Database query builder core, named Blueprint
24			*
25			* @category Database
26			* @package Chaospelt\Kernel\Database
27			*
28			* @author Stf Kolev <[email protected]>
29			* @license BSD-3-Clause https://opensource.org/licenses/BSD-3-Clause
30			*
31			* @link https://github.com/stfkolev/chaospelt
32			*/
33			class Blueprint
34			{
35			/**
36			* The table the blueprint describes.
37			*
38			* @var string
39			*/
40			protected $table;
41
42			/**
43			* The prefix of the table.
44			*
45			* @var string
46			*/
47			protected $prefix;
48
49			/**
50			* The columns that should be added to the table.
51			*
52			* @var \Chaospelt\Kernel\Database\ColumnDefinition[]
53			*/
54			protected $columns = [];
55
56			/**
57			* The commands that should be run for the table.
58			*
59			* @var \Chaospelt\Kernel\Support\Fluent[]
60			*/
61			protected $commands = [];
62
63			/**
64			* The storage engine that should be used for the table.
65			*
66			* @var string
67			*/
68			public $engine;
69
70			/**
71			* The default character set that should be used for the table.
72			*
73			* @var string
74			*/
75			public $charset;
76
77			/**
78			* The collation that should be used for the table.
79			*
80			* @var string
81			*/
82			public $collation;
83
84			/**
85			* Whether to make the table temporary.
86			*
87			* @var bool
88			*/
89			public $temporary = false;
90
91			/**
92			* The column to add new columns after.
93			*
94			* @var string
95			*/
96			public $after;
97
98			/**
99			* Create a new schema blueprint.
100			*
101			* @param string $table
102			* @param \Closure\|null $callback
103			* @param string $prefix
104			*
105			* @return void
106			*/
107			public function __construct($table, Closure $callback = null, $prefix = '')
			0 ignored issues – show Bug introduced 2022-03-23 07:07 UTC by Report Bug Copy Issue Report The type `Chaospelt\Kernel\Database\Closure` was not found. Did you mean `Closure`? If so, make sure to prefix the type with `\`. Loading history...
108			{
109			$this->table = $table;
110			$this->prefix = $prefix;
111
112			if (! is_null($callback)) {
113			$callback($this);
114			}
115			}
116
117			/**
118			* Create a new string column on the table.
119			*
120			* @param string $column
121			* @param int\|null $length
122			*
123			* @return \Chaospelt\Kernel\Database\ColumnDefinition
124			*/
125			public function string($column, $length = null)
126			{
127			$length = $length ?: \Chaospelt\Helpers\Schema::$defaultStringLength;
128
129			return $this->addColumn('string', $column, compact('length'));
130			}
131
132
133			/**
134			* Add a new column to the blueprint.
135			*
136			* @param string $type Column Type
137			* @param string $name Column Name
138			* @param array $parameters Column Parameters List
139			*
140			* @return \Chaospelt\Kernel\Database\ColumnDefinition
141			*/
142			public function addColumn($type, $name, array $parameters = [])
143			{
144			return $this->addColumnDefinition(
145			new ColumnDefinition(
146			array_merge(compact('type', 'name'), $parameters)
147			)
148			);
149			}
150
151			/**
152			* Add a new column definition to the blueprint.
153			*
154			* @param \Chaospelt\Kernel\Database\ColumnDefinition $definition
155			*
156			* @return \Chaospelt\Kernel\Database\ColumnDefinition
157			*/
158			protected function addColumnDefinition($definition)
159			{
160			$this->columns[] = $definition;
161
162			if ($this->after) {
163			$definition->after($this->after);
164
165			$this->after = $definition->name;
			0 ignored issues – show Bug Best Practice introduced 2022-03-23 07:07 UTC by Report Bug Copy Issue Report The property `name` does not exist on `Chaospelt\Kernel\Database\ColumnDefinition`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
166			}
167
168			return $definition;
169			}
170
171			/**
172			* Get the columns on the blueprint.
173			*
174			* @return \Chaospelt\Kernel\Database\ColumnDefinition[]
175			*/
176			public function getColumns()
177			{
178			return $this->columns;
179			}
180			}

stfkolev / chaospelt

Push — master ( c0b632...08da57 )

Blueprint::addColumn() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like