CommonSqlQueries::isCachedSql() - Code Metrics - Inspection of "Type hinting pass on lots of other stuff and misc..." - Yapeal/yapeal-ng - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 598fe1...4a905b )

by Michael

created 2016-08-13 07:07 UTC

CommonSqlQueries::isCachedSql() A

↳ Parent: CommonSqlQueries

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	2

<?php
declare(strict_types = 1);
/**
 * Contains CommonSqlQueries class.
 *
 * PHP version 7.0+
 *
 * LICENSE:
 * This file is part of Yet Another Php Eve Api Library also know as Yapeal
 * which can be used to access the Eve Online API data and place it into a
 * database.
 * Copyright (C) 2014-2016 Michael Cummings
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see
 * <http://spdx.org/licenses/LGPL-3.0.html>.
 *
 * You should be able to find a copy of this license in the COPYING-LESSER.md
 * file. A copy of the GNU GPL should also be available in the COPYING.md file.
 *
 * @copyright 2014-2016 Michael Cummings
 * @license   http://www.gnu.org/copyleft/lesser.html GNU LGPL
 * @author    Michael Cummings <[email protected]>
 */
namespace Yapeal\Sql;

use Yapeal\DicAwareInterface;
use Yapeal\DicAwareTrait;
use Yapeal\Event\YEMAwareInterface;
use Yapeal\Event\YEMAwareTrait;
use Yapeal\FileSystem\CommonFileHandlingTrait;

/**
 * Class CommonSqlQueries
 *
 * @method string getAccountCorporationIDsExcludingCorporationKeys()
 * @method string getActiveApis()
 * @method string getActiveMailBodiesWithOwnerID($ownerID)
 * @method string getActiveRegisteredAccountStatus($mask)
 * @method string getActiveRegisteredCharacters($mask)
 * @method string getActiveRegisteredCorporations($mask)
 * @method string getActiveRegisteredKeys()
 * @method string getActiveStarbaseTowers($mask, $ownerID)
 * @method string getApiLock($hash)
 * @method string getApiLockRelease($hash)
 * @method string getCreateAddOrModifyColumnProcedure()
 * @method string getDeleteFromTable($tableName)
 * @method string getDeleteFromTableWithKeyID($tableName, $keyID)
 * @method string getDeleteFromTableWithOwnerID($tableName, $ownerID)
 * @method string getDropAddOrModifyColumnProcedure()
 * @method string getMemberCorporationIDsExcludingAccountCorporations()
 * @method string getUtilLatestDatabaseVersion()
 * @method string getUtilLatestDatabaseVersionUpdate()
 * @method string initialization()
 */
class CommonSqlQueries implements DicAwareInterface, YEMAwareInterface
{
    use CommonFileHandlingTrait, DicAwareTrait, SqlSubsTrait, YEMAwareTrait;
    /**
     * @param string $databaseName
     * @param string $tablePrefix
     */
    public function __construct($databaseName, $tablePrefix)
    {
        $this->databaseName = $databaseName;
        $this->tablePrefix = $tablePrefix;
    }
    /**
     * @param string $name
     * @param array  $arguments
     *
     * @return mixed
     * @throws \InvalidArgumentException
     * @throws \DomainException
     * @throws \BadMethodCallException
     * @throws \LogicException
     */
    public function __call(string $name, array $arguments = [])
    {
        $fileNames = explode(',',
            sprintf('%1$s%2$s.%3$s.sql,%1$s%2$s.sql',
                $this->getDic()['Yapeal.Sql.dir'] . 'queries/',
                $name,
                $this->getDic()['Yapeal.Sql.platform']));
        foreach ($fileNames as $fileName) {
            if ($this->isCachedSql($fileName)) {
                return $this->getCachedSql($fileName);
            }
            if (!is_readable($fileName) || !is_file($fileName)) {
                continue;
            }
            $sql = $this->safeFileRead($fileName);
            if (false === $sql) {
                continue;
            }
            return $this->processSql($fileName, $sql, $arguments);
        }
        $mess = 'Unknown method ' . $name;
        throw new \BadMethodCallException($mess);
    }
    /**
     * @param string   $tableName
     * @param string[] $columnNameList
     * @param int      $rowCount
     *
     * @return string
     * @throws \LogicException
     */
    public function getUpsert(string $tableName, array $columnNameList, int $rowCount): string
    {
        $replacements = $this->getReplacements();
        $replacements['{tableName}'] = $tableName;
        $replacements['{columnNames}'] = implode('","', $columnNameList);
        $rowPrototype = '(' . implode(',', array_fill(0, count($columnNameList), '?')) . ')';
        $replacements['{rowset}'] = implode(',', array_fill(0, $rowCount, $rowPrototype));
        $updates = [];
        foreach ($columnNameList as $column) {
            $updates[] = sprintf('"%1$s"=VALUES("%1$s")', $column);
        }
        $replacements['{updates}'] = implode(',', $updates);
        /** @noinspection SqlResolve */
        $sql = 'INSERT INTO "{schema}"."{tablePrefix}{tableName}" ("{columnNames}") VALUES {rowset} ON DUPLICATE KEY UPDATE {updates}';

        return str_replace(array_keys($replacements), array_values($replacements), $sql);
    }
    /**
     * @param array <string, string> $columns
     *
     * @return string
     * @throws \LogicException
     */
    public function getUtilCachedUntilExpires(array $columns): string
    {
        $replacements = $this->getReplacements();
        $where = [];
        // I.E. "apiName" = 'accountBalance'
        foreach ($columns as $key => $value) {
            $where[] = sprintf('"%1$s" = \'%2$s\'', $key, $value);
        }
        $replacements['{where}'] = implode(' AND ', $where);
        /** @noinspection SqlResolve */
        $sql = 'SELECT "expires" FROM "{schema}"."{tablePrefix}utilCachedUntil" WHERE {WHERE};';
        return str_replace(array_keys($replacements), array_values($replacements), $sql);
    }
    /**
     * @var string $databaseName
     */
    protected $databaseName;
    /**
     * @var string $tablePrefix
     */
    protected $tablePrefix;
    /**
     * @param string $fileName
     * @param string $sql
     */
    private function cacheSqlQuery(string $fileName, string $sql)
    {
        $this->sqlCache[$fileName] = $sql;
    }
    /**
     * @param string $fileName
     *
     * @return string
     */
    private function getCachedSql(string $fileName): string
    {
        return $this->sqlCache[$fileName];
    }
    /**
     * @return array
     * @throws \LogicException
     */
    private function getReplacements()
    {
        if (null === $this->replacements) {
            $this->replacements = $this->getSqlSubs($this->getDic());
        }
        return $this->replacements;
    }
    /**
     * @param string $fileName
     *
     * @return bool
     */
    private function isCachedSql(string $fileName): bool
    {
        return array_key_exists($fileName, $this->sqlCache);
    }
    /**
     * @param string $fileName
     *
     * @param string $sql
     * @param array  $arguments
     *
     * @return string
     * @throws \LogicException
     */
    private function processSql(string $fileName, string $sql, array $arguments)
    {
        $sql = $this->getCleanedUpSql($sql, $this->getReplacements());
        if (0 !== count($arguments)) {
            $sql = vsprintf($sql, $arguments);
        } else {
            $this->cacheSqlQuery($fileName, $sql);
        }
        return $sql;
    }
    /**
     * @var array $replacements Holds a list of Sql section replacement pairs.
     */
    private $replacements;
    /**
     * @var array sqlCache
     */
    private $sqlCache = [];
}


1			<?php
2			declare(strict_types = 1);
3			/**
4			* Contains CommonSqlQueries class.
5			*
6			* PHP version 7.0+
7			*
8			* LICENSE:
9			* This file is part of Yet Another Php Eve Api Library also know as Yapeal
10			* which can be used to access the Eve Online API data and place it into a
11			* database.
12			* Copyright (C) 2014-2016 Michael Cummings
13			*
14			* This program is free software: you can redistribute it and/or modify it
15			* under the terms of the GNU Lesser General Public License as published by the
16			* Free Software Foundation, either version 3 of the License, or (at your
17			* option) any later version.
18			*
19			* This program is distributed in the hope that it will be useful, but WITHOUT
20			* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21			* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
22			* for more details.
23			*
24			* You should have received a copy of the GNU Lesser General Public License
25			* along with this program. If not, see
26			* <http://spdx.org/licenses/LGPL-3.0.html>.
27			*
28			* You should be able to find a copy of this license in the COPYING-LESSER.md
29			* file. A copy of the GNU GPL should also be available in the COPYING.md file.
30			*
31			* @copyright 2014-2016 Michael Cummings
32			* @license http://www.gnu.org/copyleft/lesser.html GNU LGPL
33			* @author Michael Cummings <[email protected]>
34			*/
35			namespace Yapeal\Sql;
36
37			use Yapeal\DicAwareInterface;
38			use Yapeal\DicAwareTrait;
39			use Yapeal\Event\YEMAwareInterface;
40			use Yapeal\Event\YEMAwareTrait;
41			use Yapeal\FileSystem\CommonFileHandlingTrait;
42
43			/**
44			* Class CommonSqlQueries
45			*
46			* @method string getAccountCorporationIDsExcludingCorporationKeys()
47			* @method string getActiveApis()
48			* @method string getActiveMailBodiesWithOwnerID($ownerID)
49			* @method string getActiveRegisteredAccountStatus($mask)
50			* @method string getActiveRegisteredCharacters($mask)
51			* @method string getActiveRegisteredCorporations($mask)
52			* @method string getActiveRegisteredKeys()
53			* @method string getActiveStarbaseTowers($mask, $ownerID)
54			* @method string getApiLock($hash)
55			* @method string getApiLockRelease($hash)
56			* @method string getCreateAddOrModifyColumnProcedure()
57			* @method string getDeleteFromTable($tableName)
58			* @method string getDeleteFromTableWithKeyID($tableName, $keyID)
59			* @method string getDeleteFromTableWithOwnerID($tableName, $ownerID)
60			* @method string getDropAddOrModifyColumnProcedure()
61			* @method string getMemberCorporationIDsExcludingAccountCorporations()
62			* @method string getUtilLatestDatabaseVersion()
63			* @method string getUtilLatestDatabaseVersionUpdate()
64			* @method string initialization()
65			*/
66			class CommonSqlQueries implements DicAwareInterface, YEMAwareInterface
67			{
68			use CommonFileHandlingTrait, DicAwareTrait, SqlSubsTrait, YEMAwareTrait;
69			/**
70			* @param string $databaseName
71			* @param string $tablePrefix
72			*/
73			public function __construct($databaseName, $tablePrefix)
74			{
75			$this->databaseName = $databaseName;
76			$this->tablePrefix = $tablePrefix;
77			}
78			/**
79			* @param string $name
80			* @param array $arguments
81			*
82			* @return mixed
83			* @throws \InvalidArgumentException
84			* @throws \DomainException
85			* @throws \BadMethodCallException
86			* @throws \LogicException
87			*/
88			public function __call(string $name, array $arguments = [])
89			{
90			$fileNames = explode(',',
91			sprintf('%1$s%2$s.%3$s.sql,%1$s%2$s.sql',
92			$this->getDic()['Yapeal.Sql.dir'] . 'queries/',
93			$name,
94			$this->getDic()['Yapeal.Sql.platform']));
95			foreach ($fileNames as $fileName) {
96			if ($this->isCachedSql($fileName)) {
97			return $this->getCachedSql($fileName);
98			}
99			if (!is_readable($fileName) \|\| !is_file($fileName)) {
100			continue;
101			}
102			$sql = $this->safeFileRead($fileName);
103			if (false === $sql) {
104			continue;
105			}
106			return $this->processSql($fileName, $sql, $arguments);
107			}
108			$mess = 'Unknown method ' . $name;
109			throw new \BadMethodCallException($mess);
110			}
111			/**
112			* @param string $tableName
113			* @param string[] $columnNameList
114			* @param int $rowCount
115			*
116			* @return string
117			* @throws \LogicException
118			*/
119			public function getUpsert(string $tableName, array $columnNameList, int $rowCount): string
120			{
121			$replacements = $this->getReplacements();
122			$replacements['{tableName}'] = $tableName;
123			$replacements['{columnNames}'] = implode('","', $columnNameList);
124			$rowPrototype = '(' . implode(',', array_fill(0, count($columnNameList), '?')) . ')';
125			$replacements['{rowset}'] = implode(',', array_fill(0, $rowCount, $rowPrototype));
126			$updates = [];
127			foreach ($columnNameList as $column) {
128			$updates[] = sprintf('"%1$s"=VALUES("%1$s")', $column);
129			}
130			$replacements['{updates}'] = implode(',', $updates);
131			/** @noinspection SqlResolve */
132			$sql = 'INSERT INTO "{schema}"."{tablePrefix}{tableName}" ("{columnNames}") VALUES {rowset} ON DUPLICATE KEY UPDATE {updates}';
			0 ignored issues – show Coding Style introduced 2016-08-13 07:11 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 135 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
133			return str_replace(array_keys($replacements), array_values($replacements), $sql);
134			}
135			/**
136			* @param array <string, string> $columns
137			*
138			* @return string
139			* @throws \LogicException
140			*/
141			public function getUtilCachedUntilExpires(array $columns): string
142			{
143			$replacements = $this->getReplacements();
144			$where = [];
145			// I.E. "apiName" = 'accountBalance'
146			foreach ($columns as $key => $value) {
147			$where[] = sprintf('"%1$s" = \'%2$s\'', $key, $value);
148			}
149			$replacements['{where}'] = implode(' AND ', $where);
150			/** @noinspection SqlResolve */
151			$sql = 'SELECT "expires" FROM "{schema}"."{tablePrefix}utilCachedUntil" WHERE {WHERE};';
152			return str_replace(array_keys($replacements), array_values($replacements), $sql);
153			}
154			/**
155			* @var string $databaseName
156			*/
157			protected $databaseName;
158			/**
159			* @var string $tablePrefix
160			*/
161			protected $tablePrefix;
162			/**
163			* @param string $fileName
164			* @param string $sql
165			*/
166			private function cacheSqlQuery(string $fileName, string $sql)
167			{
168			$this->sqlCache[$fileName] = $sql;
169			}
170			/**
171			* @param string $fileName
172			*
173			* @return string
174			*/
175			private function getCachedSql(string $fileName): string
176			{
177			return $this->sqlCache[$fileName];
178			}
179			/**
180			* @return array
181			* @throws \LogicException
182			*/
183			private function getReplacements()
184			{
185			if (null === $this->replacements) {
186			$this->replacements = $this->getSqlSubs($this->getDic());
187			}
188			return $this->replacements;
189			}
190			/**
191			* @param string $fileName
192			*
193			* @return bool
194			*/
195			private function isCachedSql(string $fileName): bool
196			{
197			return array_key_exists($fileName, $this->sqlCache);
198			}
199			/**
200			* @param string $fileName
201			*
202			* @param string $sql
203			* @param array $arguments
204			*
205			* @return string
206			* @throws \LogicException
207			*/
208			private function processSql(string $fileName, string $sql, array $arguments)
209			{
210			$sql = $this->getCleanedUpSql($sql, $this->getReplacements());
211			if (0 !== count($arguments)) {
212			$sql = vsprintf($sql, $arguments);
213			} else {
214			$this->cacheSqlQuery($fileName, $sql);
215			}
216			return $sql;
217			}
218			/**
219			* @var array $replacements Holds a list of Sql section replacement pairs.
220			*/
221			private $replacements;
222			/**
223			* @var array sqlCache
224			*/
225			private $sqlCache = [];
226			}
227

Yapeal / yapeal-ng

Push — master ( 598fe1...4a905b )

CommonSqlQueries::isCachedSql() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like