DB_Delta_Engine::create_table() - Code Metrics - Pink-Crab/WPDB-Table-Builder - Measure and Improve Code Quality continuously with Scrutinizer

DB_Delta_Engine::create_table() A
last analyzed 2023-03-02 13:53 UTC

↳ Parent: DB_Delta_Engine

Complexity

Conditions	4
Paths	3

Size

Total Lines	23
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

/**
 * WPDB DB_Delta table builder.
 *
 * 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.
 *
 * @since 0.3.0
 * @author Glynn Quelch <[email protected]>
 * @license http://www.opensource.org/licenses/mit-license.html  MIT License
 * @package PinkCrab\Table_Builder
 */

namespace PinkCrab\Table_Builder\Engines\WPDB_DB_Delta;

use PinkCrab\Table_Builder\Schema;
use PinkCrab\Table_Builder\Engines\Engine;
use PinkCrab\Table_Builder\Exception\Engine_Exception;
use PinkCrab\Table_Builder\Engines\WPDB_DB_Delta\DB_Delta_Validator;
use PinkCrab\Table_Builder\Engines\WPDB_DB_Delta\DB_Delta_Translator;
use PinkCrab\Table_Builder\Exception\WPDB_DB_Delta\WPDB_Validator_Exception;

class DB_Delta_Engine implements Engine {

	/**
	 * The engines validator class name.
	 *
	 * @var DB_Delta_Validator
	 */
	protected $validator;

	/**
	 * The WPDB Translator for SQL
	 *
	 * @var DB_Delta_Translator
	 */
	protected $translator;

	/**
	 * Access to wpdb
	 *
	 * @var \wpdb
	 */
	protected $wpdb;


	/**
	 * Holds access to the Schema definition
	 *
	 * @var Schema
	 */
	protected $schema;

	public function __construct( \wpdb $wpdb ) {
		$this->wpdb = $wpdb;

		// Set the translator and valiator
		$this->translator = new DB_Delta_Translator();
		$this->validator  = new DB_Delta_Validator();
	}

	/**
	 * Validate and set the schema
	 *
	 * @param \PinkCrab\Table_Builder\Schema $schema
	 * @return void
	 * @throws WPDB_Validator_Exception if fails validation (code 201)
	 */
	private function set_query_for_create( Schema $schema ): void {
		$this->schema = $schema;

		if ( ! $this->validator->validate( $schema ) ) {
			throw WPDB_Validator_Exception::failed_validation(
				$schema,
				$this->validator->get_errors()
			);
		}

	}

	/**
	 * Create the table based on the schema passed.
	 *
	 * @param \PinkCrab\Table_Builder\Schema $schema
	 * @return bool
	 * @throws WPDB_Validator_Exception if fails validation (code 201)
	 * @throws Engine_Exception If errors thrown creating table (code 101)
	 */
	public function create_table( Schema $schema ): bool {

		// Generate the query from the passed schema.
		$query = $this->create_table_query( $schema );

		// Include WP dbDelta.
		require_once ABSPATH . 'wp-admin/includes/upgrade.php';

		\ob_start();
		dbDelta( $query );
		$output = \ob_get_clean();

		// If output captured, throw.
		if ( '' !== $output ) {
			throw Engine_Exception::create_table( $schema, $output ?: '' );
		}

		// Throw if WPDB has errors.
		if ( '' !== $this->wpdb->last_error ) {
			throw Engine_Exception::create_table( $schema, $this->wpdb->last_error );
		}

		return true;
	}

	/**
	 * Returns the table query generated for creating a table
	 *
	 * @param \PinkCrab\Table_Builder\Schema $schema
	 * @return string
	 * @throws WPDB_Validator_Exception if fails validation (code 201)
	 */
	public function create_table_query( Schema $schema ): string {
		$this->set_query_for_create( $schema );
		return $this->compile_create_sql_query();
	}

	/**
	 * Validate and set the schema
	 *
	 * @param \PinkCrab\Table_Builder\Schema $schema
	 * @return void
	 * @throws WPDB_Validator_Exception If fails schema validation (code 201)
	 */
	private function set_query_for_drop( Schema $schema ): void {
		$this->schema = $schema;

		if ( ! $this->validator->validate( $schema ) ) {
			throw WPDB_Validator_Exception::failed_validation( $schema, $this->validator->get_errors() );
		}
	}

	/**
	 * Drops the table
	 *
	 * @param \PinkCrab\Table_Builder\Schema $schema
	 * @return bool
	 * @throws WPDB_Validator_Exception If fails schema validation (code 201)
	 * @throws Engine_Exception If error thrown dropping table. (code 102)
	 */
	public function drop_table( Schema $schema ): bool {

		$query = $this->drop_table_query( $schema );

		\ob_start();
		$this->wpdb->get_results( $query ); // phpcs:disable WordPress.DB.PreparedSQL.NotPrepared
		$output = \ob_get_clean();

		// If output captured, throw.
		if ( '' !== $output ) {
			throw Engine_Exception::drop_table( $schema, $output ?: '' );
		}

		// Throw if WPDB has errors.
		if ( '' !== $this->wpdb->last_error ) {
			throw Engine_Exception::drop_table( $schema, $this->wpdb->last_error );
		}

		return true;
	}

	/**
	 * Returns the query for dropping the curren table.
	 *
	 * @param \PinkCrab\Table_Builder\Schema $schema
	 * @return string
	 * @throws WPDB_Validator_Exception If fails schema validation (code 201)
	 */
	public function drop_table_query( Schema $schema ): string {
		$this->set_query_for_drop( $schema );
		return "DROP TABLE IF EXISTS {$this->schema->get_table_name()};";
	}

	/**
	 * Compiles the SQL query used to create a table.
	 *
	 * @return string
	 */
	protected function compile_create_sql_query(): string {

		// Compile query partials.
		$table   = $this->schema->get_table_name();
		$body    = join(
			',' . PHP_EOL,
			array_merge(
				$this->translator->translate_columns( $this->schema ),
				$this->translator->translate_indexes( $this->schema )
			)
		);
		$collate = $this->wpdb->collate;

		return <<<SQL
CREATE TABLE $table (
$body ) COLLATE $collate 
SQL;
	}
}


1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* WPDB DB_Delta table builder.
7			*
8			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
9			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
10			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
11			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
12			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
13			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
14			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
15			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
16			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
17			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
18			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
19			*
20			* @since 0.3.0
21			* @author Glynn Quelch <[email protected]>
22			* @license http://www.opensource.org/licenses/mit-license.html MIT License
23			* @package PinkCrab\Table_Builder
24			*/
25
26			namespace PinkCrab\Table_Builder\Engines\WPDB_DB_Delta;
27
28			use PinkCrab\Table_Builder\Schema;
29			use PinkCrab\Table_Builder\Engines\Engine;
30			use PinkCrab\Table_Builder\Exception\Engine_Exception;
31			use PinkCrab\Table_Builder\Engines\WPDB_DB_Delta\DB_Delta_Validator;
32			use PinkCrab\Table_Builder\Engines\WPDB_DB_Delta\DB_Delta_Translator;
33			use PinkCrab\Table_Builder\Exception\WPDB_DB_Delta\WPDB_Validator_Exception;
34
35			class DB_Delta_Engine implements Engine {
36
37			/**
38			* The engines validator class name.
39			*
40			* @var DB_Delta_Validator
41			*/
42			protected $validator;
43
44			/**
45			* The WPDB Translator for SQL
46			*
47			* @var DB_Delta_Translator
48			*/
49			protected $translator;
50
51			/**
52			* Access to wpdb
53			*
54			* @var \wpdb
55			*/
56			protected $wpdb;
57
58
59			/**
60			* Holds access to the Schema definition
61			*
62			* @var Schema
63			*/
64			protected $schema;
65
66			public function __construct( \wpdb $wpdb ) {
67			$this->wpdb = $wpdb;
68
69			// Set the translator and valiator
70			$this->translator = new DB_Delta_Translator();
71			$this->validator = new DB_Delta_Validator();
72			}
73
74			/**
75			* Validate and set the schema
76			*
77			* @param \PinkCrab\Table_Builder\Schema $schema
78			* @return void
79			* @throws WPDB_Validator_Exception if fails validation (code 201)
80			*/
81			private function set_query_for_create( Schema $schema ): void {
82			$this->schema = $schema;
83
84			if ( ! $this->validator->validate( $schema ) ) {
85			throw WPDB_Validator_Exception::failed_validation(
86			$schema,
87			$this->validator->get_errors()
88			);
89			}
90
91			}
92
93			/**
94			* Create the table based on the schema passed.
95			*
96			* @param \PinkCrab\Table_Builder\Schema $schema
97			* @return bool
98			* @throws WPDB_Validator_Exception if fails validation (code 201)
99			* @throws Engine_Exception If errors thrown creating table (code 101)
100			*/
101			public function create_table( Schema $schema ): bool {
102
103			// Generate the query from the passed schema.
104			$query = $this->create_table_query( $schema );
105
106			// Include WP dbDelta.
107			require_once ABSPATH . 'wp-admin/includes/upgrade.php';
108
109			\ob_start();
110			dbDelta( $query );
111			$output = \ob_get_clean();
112
113			// If output captured, throw.
114			if ( '' !== $output ) {
115			throw Engine_Exception::create_table( $schema, $output ?: '' );
116			}
117
118			// Throw if WPDB has errors.
119			if ( '' !== $this->wpdb->last_error ) {
120			throw Engine_Exception::create_table( $schema, $this->wpdb->last_error );
121			}
122
123			return true;
124			}
125
126			/**
127			* Returns the table query generated for creating a table
128			*
129			* @param \PinkCrab\Table_Builder\Schema $schema
130			* @return string
131			* @throws WPDB_Validator_Exception if fails validation (code 201)
132			*/
133			public function create_table_query( Schema $schema ): string {
134			$this->set_query_for_create( $schema );
135			return $this->compile_create_sql_query();
136			}
137
138			/**
139			* Validate and set the schema
140			*
141			* @param \PinkCrab\Table_Builder\Schema $schema
142			* @return void
143			* @throws WPDB_Validator_Exception If fails schema validation (code 201)
144			*/
145			private function set_query_for_drop( Schema $schema ): void {
146			$this->schema = $schema;
147
148			if ( ! $this->validator->validate( $schema ) ) {
149			throw WPDB_Validator_Exception::failed_validation( $schema, $this->validator->get_errors() );
150			}
151			}
152
153			/**
154			* Drops the table
155			*
156			* @param \PinkCrab\Table_Builder\Schema $schema
157			* @return bool
158			* @throws WPDB_Validator_Exception If fails schema validation (code 201)
159			* @throws Engine_Exception If error thrown dropping table. (code 102)
160			*/
161			public function drop_table( Schema $schema ): bool {
162
163			$query = $this->drop_table_query( $schema );
164
165			\ob_start();
166			$this->wpdb->get_results( $query ); // phpcs:disable WordPress.DB.PreparedSQL.NotPrepared
167			$output = \ob_get_clean();
168
169			// If output captured, throw.
170			if ( '' !== $output ) {
171			throw Engine_Exception::drop_table( $schema, $output ?: '' );
172			}
173
174			// Throw if WPDB has errors.
175			if ( '' !== $this->wpdb->last_error ) {
176			throw Engine_Exception::drop_table( $schema, $this->wpdb->last_error );
177			}
178
179			return true;
180			}
181
182			/**
183			* Returns the query for dropping the curren table.
184			*
185			* @param \PinkCrab\Table_Builder\Schema $schema
186			* @return string
187			* @throws WPDB_Validator_Exception If fails schema validation (code 201)
188			*/
189			public function drop_table_query( Schema $schema ): string {
190			$this->set_query_for_drop( $schema );
191			return "DROP TABLE IF EXISTS {$this->schema->get_table_name()};";
192			}
193
194			/**
195			* Compiles the SQL query used to create a table.
196			*
197			* @return string
198			*/
199			protected function compile_create_sql_query(): string {
200
201			// Compile query partials.
202			$table = $this->schema->get_table_name();
203			$body = join(
204			',' . PHP_EOL,
205			array_merge(
206			$this->translator->translate_columns( $this->schema ),
207			$this->translator->translate_indexes( $this->schema )
208			)
209			);
210			$collate = $this->wpdb->collate;
211
212			return <<<SQL
213			CREATE TABLE $table (
214			$body ) COLLATE $collate
215			SQL;
216			}
217			}
218

Pink-Crab / WPDB-Table-Builder

DB_Delta_Engine::create_table() A last analyzed 2023-03-02 13:53 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

DB_Delta_Engine::create_table() A
last analyzed 2023-03-02 13:53 UTC