SchemaHandler - Code Metrics - Jitamin/jitamin - Measure and Improve Code Quality continuously with Scrutinizer

SchemaHandler A
last analyzed 2017-12-27 06:16 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	0
loc	110
rs	10
c	0
b	0
f	0
wmc	9
lcom	1
cbo	1

6 Methods

Rating	Name	Size	Complexity
A	getSchemaFilename()	4	1
A	hasSchema()	4	1
A	loadSchema()	5	1
B	migrateSchema()	27	4
A	getSchemaVersion()	4	1
A	setSchemaVersion()	8	1

<?php

/*
 * This file is part of Jitamin.
 *
 * Copyright (C) Jitamin Team
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Jitamin\Foundation\Plugin;

use PDOException;
use RuntimeException;

/**
 * Class SchemaHandler.
 */
class SchemaHandler extends \Jitamin\Foundation\Base
{
    /**
     * Schema version table for plugins.
     *
     * @var string
     */
    const TABLE_SCHEMA = 'plugin_schema_versions';

    /**
     * Get schema filename.
     *
     * @static
     *
     * @param string $pluginName
     *
     * @return string
     */
    public static function getSchemaFilename($pluginName)
    {
        return PLUGINS_DIR.'/'.$pluginName.'/Schema/'.ucfirst(DB_DRIVER).'.php';
    }

    /**
     * Return true if the plugin has schema.
     *
     * @static
     *
     * @param string $pluginName
     *
     * @return bool
     */
    public static function hasSchema($pluginName)
    {
        return file_exists(self::getSchemaFilename($pluginName));
    }

    /**
     * Load plugin schema.
     *
     * @param string $pluginName
     */
    public function loadSchema($pluginName)
    {
        require_once self::getSchemaFilename($pluginName);
        $this->migrateSchema($pluginName);
    }

    /**
     * Execute plugin schema migrations.
     *
     * @param string $pluginName
     */
    public function migrateSchema($pluginName)
    {
        $lastVersion = constant('\Jitamin\Plugin\\'.$pluginName.'\Schema\VERSION');
        $currentVersion = $this->getSchemaVersion($pluginName);

        try {
            $this->db->startTransaction();
<?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.");
        }
    }

}
            $this->db->getDriver()->disableForeignKeys();
<?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.");
        }
    }

}

            for ($i = $currentVersion + 1; $i <= $lastVersion; $i++) {
                $functionName = '\Jitamin\Plugin\\'.$pluginName.'\Schema\version_'.$i;

                if (function_exists($functionName)) {
                    call_user_func($functionName, $this->db->getConnection());
<?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.");
        }
    }

}
                }
            }

            $this->db->getDriver()->enableForeignKeys();
<?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.");
        }
    }

}
            $this->db->closeTransaction();
<?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.");
        }
    }

}
            $this->setSchemaVersion($pluginName, $i - 1);
        } catch (PDOException $e) {
            $this->db->cancelTransaction();
<?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.");
        }
    }

}
            $this->db->getDriver()->enableForeignKeys();
<?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.");
        }
    }

}

            throw new RuntimeException('Unable to migrate schema for the plugin: '.$pluginName.' => '.$e->getMessage());
        }
    }

    /**
     * Get current plugin schema version.
     *
     * @param string $plugin
     *
     * @return int
     */
    public function getSchemaVersion($plugin)
    {
        return (int) $this->db->table(self::TABLE_SCHEMA)->eq('plugin', strtolower($plugin))->findOneColumn('version');
<?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.");
        }
    }

}
    }

    /**
     * Save last plugin schema version.
     *
     * @param string $plugin
     * @param int    $version
     *
     * @return bool
     */
    public function setSchemaVersion($plugin, $version)
    {
        $dictionary = [
            strtolower($plugin) => $version,
        ];

        return $this->db->getDriver()->upsert(self::TABLE_SCHEMA, 'plugin', 'version', $dictionary);
<?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.");
        }
    }

}
    }
}


1			<?php
2
3			/*
4			* This file is part of Jitamin.
5			*
6			* Copyright (C) Jitamin Team
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Jitamin\Foundation\Plugin;
13
14			use PDOException;
15			use RuntimeException;
16
17			/**
18			* Class SchemaHandler.
19			*/
20			class SchemaHandler extends \Jitamin\Foundation\Base
21			{
22			/**
23			* Schema version table for plugins.
24			*
25			* @var string
26			*/
27			const TABLE_SCHEMA = 'plugin_schema_versions';
28
29			/**
30			* Get schema filename.
31			*
32			* @static
33			*
34			* @param string $pluginName
35			*
36			* @return string
37			*/
38			public static function getSchemaFilename($pluginName)
39			{
40			return PLUGINS_DIR.'/'.$pluginName.'/Schema/'.ucfirst(DB_DRIVER).'.php';
41			}
42
43			/**
44			* Return true if the plugin has schema.
45			*
46			* @static
47			*
48			* @param string $pluginName
49			*
50			* @return bool
51			*/
52			public static function hasSchema($pluginName)
53			{
54			return file_exists(self::getSchemaFilename($pluginName));
55			}
56
57			/**
58			* Load plugin schema.
59			*
60			* @param string $pluginName
61			*/
62			public function loadSchema($pluginName)
63			{
64			require_once self::getSchemaFilename($pluginName);
65			$this->migrateSchema($pluginName);
66			}
67
68			/**
69			* Execute plugin schema migrations.
70			*
71			* @param string $pluginName
72			*/
73			public function migrateSchema($pluginName)
74			{
75			$lastVersion = constant('\Jitamin\Plugin\\'.$pluginName.'\Schema\VERSION');
76			$currentVersion = $this->getSchemaVersion($pluginName);
77
78			try {
79			$this->db->startTransaction();
			0 ignored issues – show Documentation introduced 2017-01-10 05:03 UTC by Report Bug Copy Issue Report The property `db` does not exist on `object<Jitamin\Foundation\Plugin\SchemaHandler>`. 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...
80			$this->db->getDriver()->disableForeignKeys();
			0 ignored issues – show Documentation introduced 2017-01-10 05:03 UTC by Report Bug Copy Issue Report The property `db` does not exist on `object<Jitamin\Foundation\Plugin\SchemaHandler>`. 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...
81
82			for ($i = $currentVersion + 1; $i <= $lastVersion; $i++) {
83			$functionName = '\Jitamin\Plugin\\'.$pluginName.'\Schema\version_'.$i;
84
85			if (function_exists($functionName)) {
86			call_user_func($functionName, $this->db->getConnection());
			0 ignored issues – show Documentation introduced 2017-01-10 05:03 UTC by Report Bug Copy Issue Report The property `db` does not exist on `object<Jitamin\Foundation\Plugin\SchemaHandler>`. 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...
87			}
88			}
89
90			$this->db->getDriver()->enableForeignKeys();
			0 ignored issues – show Documentation introduced 2017-01-10 05:03 UTC by Report Bug Copy Issue Report The property `db` does not exist on `object<Jitamin\Foundation\Plugin\SchemaHandler>`. 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...
91			$this->db->closeTransaction();
			0 ignored issues – show Documentation introduced 2017-01-10 05:03 UTC by Report Bug Copy Issue Report The property `db` does not exist on `object<Jitamin\Foundation\Plugin\SchemaHandler>`. 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...
92			$this->setSchemaVersion($pluginName, $i - 1);
93			} catch (PDOException $e) {
94			$this->db->cancelTransaction();
			0 ignored issues – show Documentation introduced 2017-01-10 05:03 UTC by Report Bug Copy Issue Report The property `db` does not exist on `object<Jitamin\Foundation\Plugin\SchemaHandler>`. 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...
95			$this->db->getDriver()->enableForeignKeys();
			0 ignored issues – show Documentation introduced 2017-01-10 05:03 UTC by Report Bug Copy Issue Report The property `db` does not exist on `object<Jitamin\Foundation\Plugin\SchemaHandler>`. 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...
96
97			throw new RuntimeException('Unable to migrate schema for the plugin: '.$pluginName.' => '.$e->getMessage());
98			}
99			}
100
101			/**
102			* Get current plugin schema version.
103			*
104			* @param string $plugin
105			*
106			* @return int
107			*/
108			public function getSchemaVersion($plugin)
109			{
110			return (int) $this->db->table(self::TABLE_SCHEMA)->eq('plugin', strtolower($plugin))->findOneColumn('version');
			0 ignored issues – show Documentation introduced 2017-01-10 05:03 UTC by Report Bug Copy Issue Report The property `db` does not exist on `object<Jitamin\Foundation\Plugin\SchemaHandler>`. 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...
111			}
112
113			/**
114			* Save last plugin schema version.
115			*
116			* @param string $plugin
117			* @param int $version
118			*
119			* @return bool
120			*/
121			public function setSchemaVersion($plugin, $version)
122			{
123			$dictionary = [
124			strtolower($plugin) => $version,
125			];
126
127			return $this->db->getDriver()->upsert(self::TABLE_SCHEMA, 'plugin', 'version', $dictionary);
			0 ignored issues – show Documentation introduced 2017-01-10 05:03 UTC by Report Bug Copy Issue Report The property `db` does not exist on `object<Jitamin\Foundation\Plugin\SchemaHandler>`. 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...
128			}
129			}
130

Jitamin / jitamin

SchemaHandler A last analyzed 2017-12-27 06:16 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

Duplication Side-by-Side

Filter issues like

SchemaHandler A
last analyzed 2017-12-27 06:16 UTC