AddSettingMigration::up() - Code Metrics - Inspection of "Merge pull request #336 from Jalle19/hoa-update" - Jalle19/xbmc-video-server - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d021a5...a13070 )

by Sam

created 2023-08-12 13:44 UTC

AddSettingMigration::up() A

↳ Parent: AddSettingMigration

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	1

Metric	Value
cc	2
eloc	8
c	2
b	1
f	1
nc	2
nop	0
dl	0
loc	14
rs	10

<?php

/**
 * Base class for migrations whose only purpose is to add a setting to the 
 * settings table. Implementations only have to implement the getName() and 
 * getDefaultValue() methods, the actual migration is handled here.
 *
 * @author Sam Stenvall <[email protected]>
 * @copyright Copyright &copy; Sam Stenvall 2014-
 * @license https://www.gnu.org/licenses/gpl.html The GNU General Public License v3.0
 */
abstract class AddSettingMigration extends CDbMigration
{

	/**
	 * @return string the name of the new setting
	 */
	abstract public function getName();

	/**
	 * @return string the default value of the new setting
	 */
	abstract public function getDefaultValue();

	/**
	 * Adds the setting with its default value to the settings table. Nothing 
	 * is done if the setting already exists.
	 * @return type
	 */
	public function up()
	{
		$name = $this->getName();
		
		// Check if the setting exists
		$command = $this->dbConnection->createCommand('SELECT * FROM settings WHERE name = :name');
		$settingExists = $command->queryRow(true, array(':name' => $name)) !== false;

		if ($settingExists)
			return true;


		$this->insert('settings', array(
			'name'=>$name,
			'value'=>(string)$this->getDefaultValue()));
	}

	/**
	 * Removes the setting
	 */
	public function down()
	{
		$this->delete('settings', 'name = :name', array(
			':name'=>$this->getName()));
	}

}

1			<?php
2
3			/**
4			* Base class for migrations whose only purpose is to add a setting to the
5			* settings table. Implementations only have to implement the getName() and
6			* getDefaultValue() methods, the actual migration is handled here.
7			*
8			* @author Sam Stenvall <[email protected]>
9			* @copyright Copyright © Sam Stenvall 2014-
10			* @license https://www.gnu.org/licenses/gpl.html The GNU General Public License v3.0
11			*/
12			abstract class AddSettingMigration extends CDbMigration
13			{
14
15			/**
16			* @return string the name of the new setting
17			*/
18			abstract public function getName();
19
20			/**
21			* @return string the default value of the new setting
22			*/
23			abstract public function getDefaultValue();
24
25			/**
26			* Adds the setting with its default value to the settings table. Nothing
27			* is done if the setting already exists.
28			* @return type
29			*/
30			public function up()
31			{
32			$name = $this->getName();
33
34			// Check if the setting exists
35			$command = $this->dbConnection->createCommand('SELECT * FROM settings WHERE name = :name');
36			$settingExists = $command->queryRow(true, array(':name' => $name)) !== false;
37
38			if ($settingExists)
39			return true;
			0 ignored issues – show Bug Best Practice introduced 2023-08-12 13:21 UTC by Report Bug Copy Issue Report The expression `return true` returns the type `true` which is incompatible with the documented return type `type`. Loading history...
40
41			$this->insert('settings', array(
42			'name'=>$name,
43			'value'=>(string)$this->getDefaultValue()));
44			}
45
46			/**
47			* Removes the setting
48			*/
49			public function down()
50			{
51			$this->delete('settings', 'name = :name', array(
52			':name'=>$this->getName()));
53			}
54
55			}

Jalle19 / xbmc-video-server

Push — master ( d021a5...a13070 )

AddSettingMigration::up() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like