update_database.php ➔ executeBatchSql() - Code Metrics - Inspection of "Run PHPUnit from project root folder" - PowerKiKi/mqueue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 563916...ca1336 )

by Adrien

created 2016-08-08 09:56 UTC

update_database.php ➔ executeBatchSql() A

↳ Parent: Project

Complexity

Conditions	4
Paths	4

Size

Total Lines	19
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	4
eloc	12
c	3
b	0
f	0
nc	4
nop	1
dl	0
loc	19
rs	9.2

<?php


require_once __DIR__ . '/../public/index.php';

$settingName = 'databaseVersion'; // This is the setting name used in the database to store the version information
$sqlPath = __DIR__ . '/sql/'; // This is the path where all SQL patches resides

/**
 * Returns the last version available in SQL file
 * @return int last version of patches
 */
function getPatchVersion()
{
    global $sqlPath;
function myFunction($a, $b) {
    // Do something
}
    $lastVersion = 0;
    $d = dir($sqlPath);

    while (false !== ($entry = $d->read())) {
        if (preg_match('/^version\.(\d+)\.sql$/i', $entry, $a)) {

            if ((int) $a[1] > $lastVersion) {
                $lastVersion = (int) $a[1];
            }
        }
    }
    $d->close();

    return $lastVersion;
}

/**
 * Returns the whole SQL (enclosed in transaction) needed to update from
 * specified version to specified target version.
 * @param int $currentVersion the version currently found in database
 * @param int $targetVersion the target version to reach wich patches
 * @return string the SQL
 */
function buildSQL($currentVersion, $targetVersion)
{
    global $sqlPath;
function myFunction($a, $b) {
    // Do something
}

    if ($currentVersion > $targetVersion) {
        throw new Exception('Cannot downgrade versions. Target version must be higher than current version');
    }

    $sql = "START TRANSACTION;\n";

    $missingVersions = [];
    for ($v = $currentVersion + 1; $v <= $targetVersion; ++$v) {
        $file = $sqlPath . 'version.' . $v . '.sql';
        if (is_file($file)) {
            $sql .= "\n-- -------- VERSION $v BEGINS ------------------------\n";
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
            $sql .= file_get_contents($file);
            $sql .= "\n-- -------- VERSION $v ENDS --------------------------\n";
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
        } else {
            $missingVersions[] = $v;
        }
    }

    $sql .= "\nCOMMIT;\n";

    if (count($missingVersions)) {
        throw new Exception('Missing SQL file for versions: ' . implode(',', $missingVersions));
    }

    return $sql;
}

/**
 * Executes a batch of SQL commands.
 * (This is a workaround to Zend limitation to have only one command at once)
 * @param string $sql to be executed
 */
function executeBatchSql($sql)
{
    $affectedRows = 0;
    $queries = preg_split("/;+(?=([^'|^\\\']*['|\\\'][^'|^\\\']*['|\\\'])*[^'|^\\\']*[^'|^\\\']$)/", $sql);
    foreach ($queries as $query) {
        if (strlen(trim($query)) > 0) {
            try {
                $result = Zend_Registry::get('db')->query($query);
            } catch (\Exception $exception) {
                echo 'FAILED QUERY: ' . $query . PHP_EOL;
                throw $exception;
            }

            $affectedRows += $result->rowCount();
        }
    }

    echo "\n" . 'affected rows count: ' . $affectedRows . "\n";
}

/**
 * Do the actual update
 */
function doUpdate()
{
    global $settingName;
function myFunction($a, $b) {
    // Do something
}

    try {
        $currentVersion = (integer) \mQueue\Model\Setting::get($settingName, 0)->value;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    } catch (Exception $e) {
        if (strpos($e->getMessage(), 'SQLSTATE[42S02]') >= 0) {
            $currentVersion = -1;
        } else {
            die('Caught exception: ' . $e->getMessage() . "\n");

        }
    }

    $targetVersion = getPatchVersion();

    echo 'current version is: ' . $currentVersion . "\n";
    echo 'target version is : ' . $targetVersion . "\n";

    if ($currentVersion == $targetVersion) {
        echo "already up-to-date\n";

        return;
    }

    $sql = buildSQL($currentVersion, $targetVersion);
    echo $sql;
    echo "\n_________________________________________________\n";
    echo "updating...\n";
    executeBatchSql($sql);
    \mQueue\Model\Setting::set($settingName, $targetVersion);

    echo "\nsuccessful update to version $targetVersion !\n";
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
}

doUpdate();


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 12 and the first side effect is on line 3. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3			require_once __DIR__ . '/../public/index.php';
4
5			$settingName = 'databaseVersion'; // This is the setting name used in the database to store the version information
6			$sqlPath = __DIR__ . '/sql/'; // This is the path where all SQL patches resides
7
8			/**
9			* Returns the last version available in SQL file
10			* @return int last version of patches
11			*/
12			function getPatchVersion()
13			{
14			global $sqlPath;
			0 ignored issues – show Compatibility Best Practice introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
15			$lastVersion = 0;
16			$d = dir($sqlPath);
			0 ignored issues – show Comprehensibility introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report Avoid variables with short names like $d. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
17			while (false !== ($entry = $d->read())) {
18			if (preg_match('/^version\.(\d+)\.sql$/i', $entry, $a)) {
			0 ignored issues – show Comprehensibility introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report Avoid variables with short names like $a. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
19			if ((int) $a[1] > $lastVersion) {
20			$lastVersion = (int) $a[1];
21			}
22			}
23			}
24			$d->close();
25
26			return $lastVersion;
27			}
28
29			/**
30			* Returns the whole SQL (enclosed in transaction) needed to update from
31			* specified version to specified target version.
32			* @param int $currentVersion the version currently found in database
33			* @param int $targetVersion the target version to reach wich patches
34			* @return string the SQL
35			*/
36			function buildSQL($currentVersion, $targetVersion)
37			{
38			global $sqlPath;
			0 ignored issues – show Compatibility Best Practice introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
39
40			if ($currentVersion > $targetVersion) {
41			throw new Exception('Cannot downgrade versions. Target version must be higher than current version');
42			}
43
44			$sql = "START TRANSACTION;\n";
45
46			$missingVersions = [];
47			for ($v = $currentVersion + 1; $v <= $targetVersion; ++$v) {
48			$file = $sqlPath . 'version.' . $v . '.sql';
49			if (is_file($file)) {
50			$sql .= "\n-- -------- VERSION $v BEGINS ------------------------\n";
			0 ignored issues – show Coding Style Best Practice introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$v` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
51			$sql .= file_get_contents($file);
52			$sql .= "\n-- -------- VERSION $v ENDS --------------------------\n";
			0 ignored issues – show Coding Style Best Practice introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$v` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
53			} else {
54			$missingVersions[] = $v;
55			}
56			}
57
58			$sql .= "\nCOMMIT;\n";
59
60			if (count($missingVersions)) {
61			throw new Exception('Missing SQL file for versions: ' . implode(',', $missingVersions));
62			}
63
64			return $sql;
65			}
66
67			/**
68			* Executes a batch of SQL commands.
69			* (This is a workaround to Zend limitation to have only one command at once)
70			* @param string $sql to be executed
71			*/
72			function executeBatchSql($sql)
73			{
74			$affectedRows = 0;
75			$queries = preg_split("/;+(?=([^'\|^\\\']['\|\\\'][^'\|^\\\']['\|\\\'])[^'\|^\\\'][^'\|^\\\']$)/", $sql);
76			foreach ($queries as $query) {
77			if (strlen(trim($query)) > 0) {
78			try {
79			$result = Zend_Registry::get('db')->query($query);
80			} catch (\Exception $exception) {
81			echo 'FAILED QUERY: ' . $query . PHP_EOL;
82			throw $exception;
83			}
84
85			$affectedRows += $result->rowCount();
86			}
87			}
88
89			echo "\n" . 'affected rows count: ' . $affectedRows . "\n";
90			}
91
92			/**
93			* Do the actual update
94			*/
95			function doUpdate()
96			{
97			global $settingName;
			0 ignored issues – show Compatibility Best Practice introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
98
99			try {
100			$currentVersion = (integer) \mQueue\Model\Setting::get($settingName, 0)->value;
			0 ignored issues – show Documentation introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report The property `value` does not exist on `object<mQueue\Model\Setting>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
101			} catch (Exception $e) {
102			if (strpos($e->getMessage(), 'SQLSTATE[42S02]') >= 0) {
103			$currentVersion = -1;
104			} else {
105			die('Caught exception: ' . $e->getMessage() . "\n");
			0 ignored issues – show Coding Style Compatibility introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report The function doUpdate() contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
106			}
107			}
108
109			$targetVersion = getPatchVersion();
110
111			echo 'current version is: ' . $currentVersion . "\n";
112			echo 'target version is : ' . $targetVersion . "\n";
113
114			if ($currentVersion == $targetVersion) {
115			echo "already up-to-date\n";
116
117			return;
118			}
119
120			$sql = buildSQL($currentVersion, $targetVersion);
121			echo $sql;
122			echo "\n_________________________________________________\n";
123			echo "updating...\n";
124			executeBatchSql($sql);
125			\mQueue\Model\Setting::set($settingName, $targetVersion);
126
127			echo "\nsuccessful update to version $targetVersion !\n";
			0 ignored issues – show Coding Style Best Practice introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$targetVersion` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
128			}
129
130			doUpdate();
131

PowerKiKi / mqueue

Push — master ( 563916...ca1336 )

update_database.php ➔ executeBatchSql() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like