Field::handleTableName() - Code Metrics - Inspection of "correcting instance checks" - flipboxfactory/craft-domains - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 44ffbd...b889cd )

by Nate

created 2018-03-01 17:21 UTC

Field::handleTableName() A

↳ Parent: Field

Complexity

Conditions	4
Paths	5

Size

Total Lines	18
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	0
cts	16
cp	0
rs	9.2
c	0
b	0
f	0
cc	4
eloc	12
nc	5
nop	2
crap	20

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://flipboxfactory.com/software/domains/license
 * @link       https://www.flipboxfactory.com/software/domains/
 */

namespace flipbox\domains\services;

use Craft;
use craft\helpers\MigrationHelper;
use craft\helpers\StringHelper;
use flipbox\domains\db\DomainsQuery;
use flipbox\domains\fields\Domains as DomainsField;
use flipbox\domains\migrations\CreateDomainsTable;
use yii\base\Component;
use yii\base\Exception;

/**
 * @author Flipbox Factory <[email protected]>
 * @since  1.0.0
 */
class Field extends Component
{
    /**
     * @param DomainsField $field
     * @return bool
     * @throws \yii\db\Exception
     */
    public function delete(DomainsField $field): bool
    {
        Craft::$app->getDb()->createCommand()
            ->dropTable(
                $this->getTableName($field)
            )
            ->execute();

        return true;
    }

    /**
     * @param DomainsField $field
     * @return bool
     * @throws Exception
     * @throws \Exception
     * @throws \Throwable
     */
    public function save(DomainsField $field): bool
    {
        // Create the content table first since the block type fields will need it
        $oldTable = $this->getTableName($field, true);
        $newTable = $this->getTableName($field);

        if (null === $newTable) {
            throw new Exception('There was a problem getting the new table name.');
        }

        if (true === Craft::$app->getDb()->tableExists($newTable)) {
            throw new Exception('The table name is already in use.');
        }

        if (false === $this->handleTableName($newTable, $oldTable)) {
            throw new Exception('There was a problem renaming the table.');
        }

        return true;
    }

    /**
     * @param string $newName
     * @param string|null $oldName
     * @return bool
     * @throws \Exception
     * @throws \Throwable
     */
    protected function handleTableName(string $newName, string $oldName = null): bool
    {
        $transaction = Craft::$app->getDb()->beginTransaction();
        try {
            if (null === $oldName && false === $this->createTable($newName)) {
                $transaction->rollBack();
                return false;
            }

            MigrationHelper::renameTable($oldName, $newName);
        } catch (\Exception $e) {
            $transaction->rollBack();
            throw $e;
        }

        $transaction->commit();
        return true;
    }

    /**
     * Returns the content table name for a given field.
     *
     * @param DomainsField $field The field.
     * @param bool $useOldHandle Whether the method should use the field’s old handle when determining the
     * table name (e.g. to get the existing table name, rather than the new one).
     *
     * @return string|null The table name, or `false` if $useOldHandle was set to `true` and there was no old handle.
     */
    public function getTableName(DomainsField $field, bool $useOldHandle = false)
    {
        return '{{%' . $this->getTableAlias($field, $useOldHandle) . '}}';
    }

    /**
     * Returns the content table alias for a given field.
     *
     * @param DomainsField $field The field.
     * @param bool $useOldHandle Whether the method should use the field’s old handle when determining the
     * table alias (e.g. to get the existing table alias, rather than the new one).
     *
     * @return string|null The table alias, or `false` if $useOldHandle was set to `true` and there was no old handle.
     */
    public function getTableAlias(DomainsField $field, bool $useOldHandle = false)
    {
        $name = '';

        if ($useOldHandle) {
            if (!$field->oldHandle) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                return null;
            }

            $handle = $field->oldHandle;
        } else {
            $handle = $field->handle;
        }

        return 'domains_' . StringHelper::toLowerCase($handle) . $name;
    }

    /**
     * @param string $tableName
     * @return bool
     * @throws \Throwable
     */
    private function createTable(string $tableName): bool
    {
        $migration = new CreateDomainsTable([
            'tableName' => $tableName
        ]);

        ob_start();
        $result = $migration->up();
        ob_end_clean();

        return false !== $result;
    }

    /**
     * @param DomainsField $field
     * @param DomainsQuery $query
     * @param bool $static
     * @return null|string
     * @throws Exception
     * @throws \Twig_Error_Loader
     */
    public function getTableHtml(DomainsField $field, DomainsQuery $query, bool $static)
    {
        $columns = [
            'domain' => [
                'heading' => 'Domain',
                'handle' => 'domain',
                'type' => 'singleline'
            ],
            'status' => [
                'heading' => 'Status',
                'handle' => 'status',
                'type' => 'select',
                'options' => $field->getStatuses()
            ]
        ];

        // Translate the column headings
        foreach ($columns as &$column) {
            if (!empty($column['heading'])) {
                $column['heading'] = Craft::t('site', $column['heading']);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            }
        }
        unset($column);

        return Craft::$app->getView()->renderTemplate(
            'domains/_components/fieldtypes/Domains/input',
            [
                'id' => Craft::$app->getView()->formatInputId($field->handle),
                'name' => $field->handle,
                'cols' => $columns,
                'rows' => $query->all(),
                'static' => $static
            ]
        );
    }
}


1			<?php
2
3			/**
4			* @copyright Copyright (c) Flipbox Digital Limited
5			* @license https://flipboxfactory.com/software/domains/license
6			* @link https://www.flipboxfactory.com/software/domains/
7			*/
8
9			namespace flipbox\domains\services;
10
11			use Craft;
12			use craft\helpers\MigrationHelper;
13			use craft\helpers\StringHelper;
14			use flipbox\domains\db\DomainsQuery;
15			use flipbox\domains\fields\Domains as DomainsField;
16			use flipbox\domains\migrations\CreateDomainsTable;
17			use yii\base\Component;
18			use yii\base\Exception;
19
20			/**
21			* @author Flipbox Factory <[email protected]>
22			* @since 1.0.0
23			*/
24			class Field extends Component
25			{
26			/**
27			* @param DomainsField $field
28			* @return bool
29			* @throws \yii\db\Exception
30			*/
31			public function delete(DomainsField $field): bool
32			{
33			Craft::$app->getDb()->createCommand()
34			->dropTable(
35			$this->getTableName($field)
36			)
37			->execute();
38
39			return true;
40			}
41
42			/**
43			* @param DomainsField $field
44			* @return bool
45			* @throws Exception
46			* @throws \Exception
47			* @throws \Throwable
48			*/
49			public function save(DomainsField $field): bool
50			{
51			// Create the content table first since the block type fields will need it
52			$oldTable = $this->getTableName($field, true);
53			$newTable = $this->getTableName($field);
54
55			if (null === $newTable) {
56			throw new Exception('There was a problem getting the new table name.');
57			}
58
59			if (true === Craft::$app->getDb()->tableExists($newTable)) {
60			throw new Exception('The table name is already in use.');
61			}
62
63			if (false === $this->handleTableName($newTable, $oldTable)) {
64			throw new Exception('There was a problem renaming the table.');
65			}
66
67			return true;
68			}
69
70			/**
71			* @param string $newName
72			* @param string\|null $oldName
73			* @return bool
74			* @throws \Exception
75			* @throws \Throwable
76			*/
77			protected function handleTableName(string $newName, string $oldName = null): bool
78			{
79			$transaction = Craft::$app->getDb()->beginTransaction();
80			try {
81			if (null === $oldName && false === $this->createTable($newName)) {
82			$transaction->rollBack();
83			return false;
84			}
85
86			MigrationHelper::renameTable($oldName, $newName);
87			} catch (\Exception $e) {
88			$transaction->rollBack();
89			throw $e;
90			}
91
92			$transaction->commit();
93			return true;
94			}
95
96			/**
97			* Returns the content table name for a given field.
98			*
99			* @param DomainsField $field The field.
100			* @param bool $useOldHandle Whether the method should use the field’s old handle when determining the
101			* table name (e.g. to get the existing table name, rather than the new one).
102			*
103			* @return string\|null The table name, or `false` if $useOldHandle was set to `true` and there was no old handle.
104			*/
105			public function getTableName(DomainsField $field, bool $useOldHandle = false)
106			{
107			return '{{%' . $this->getTableAlias($field, $useOldHandle) . '}}';
108			}
109
110			/**
111			* Returns the content table alias for a given field.
112			*
113			* @param DomainsField $field The field.
114			* @param bool $useOldHandle Whether the method should use the field’s old handle when determining the
115			* table alias (e.g. to get the existing table alias, rather than the new one).
116			*
117			* @return string\|null The table alias, or `false` if $useOldHandle was set to `true` and there was no old handle.
118			*/
119			public function getTableAlias(DomainsField $field, bool $useOldHandle = false)
120			{
121			$name = '';
122
123			if ($useOldHandle) {
124			if (!$field->oldHandle) {
			0 ignored issues – show Bug Best Practice introduced 2017-11-06 17:36 UTC by Report Bug Copy Issue Report The expression `$field->oldHandle` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
125			return null;
126			}
127
128			$handle = $field->oldHandle;
129			} else {
130			$handle = $field->handle;
131			}
132
133			return 'domains_' . StringHelper::toLowerCase($handle) . $name;
134			}
135
136			/**
137			* @param string $tableName
138			* @return bool
139			* @throws \Throwable
140			*/
141			private function createTable(string $tableName): bool
142			{
143			$migration = new CreateDomainsTable([
144			'tableName' => $tableName
145			]);
146
147			ob_start();
148			$result = $migration->up();
149			ob_end_clean();
150
151			return false !== $result;
152			}
153
154			/**
155			* @param DomainsField $field
156			* @param DomainsQuery $query
157			* @param bool $static
158			* @return null\|string
159			* @throws Exception
160			* @throws \Twig_Error_Loader
161			*/
162			public function getTableHtml(DomainsField $field, DomainsQuery $query, bool $static)
163			{
164			$columns = [
165			'domain' => [
166			'heading' => 'Domain',
167			'handle' => 'domain',
168			'type' => 'singleline'
169			],
170			'status' => [
171			'heading' => 'Status',
172			'handle' => 'status',
173			'type' => 'select',
174			'options' => $field->getStatuses()
175			]
176			];
177
178			// Translate the column headings
179			foreach ($columns as &$column) {
180			if (!empty($column['heading'])) {
181			$column['heading'] = Craft::t('site', $column['heading']);
			0 ignored issues – show Bug introduced 2017-11-06 17:36 UTC by Report Bug Copy Issue Report It seems like `$column['heading']` can also be of type `array`; however, `yii\BaseYii::t()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
182			}
183			}
184			unset($column);
185
186			return Craft::$app->getView()->renderTemplate(
187			'domains/_components/fieldtypes/Domains/input',
188			[
189			'id' => Craft::$app->getView()->formatInputId($field->handle),
190			'name' => $field->handle,
191			'cols' => $columns,
192			'rows' => $query->all(),
193			'static' => $static
194			]
195			);
196			}
197			}
198

flipboxfactory / craft-domains

Push — develop ( 44ffbd...b889cd )

Field::handleTableName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like