Db3v4l\Core\DatabaseManager\SQLite

Complexity

Total Complexity

10

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getListDatabasesSqlAction()	0	11	2
A	getDropUserSqlAction()	0	5	1
A	getListUsersSqlAction()	0	7	1
A	getDropDatabaseSqlAction()	0	11	3
A	getListCollationsSqlAction()	0	7	1
A	getCreateDatabaseSqlAction()	0	11	1
A	getRetrieveVersionInfoSqlAction()	0	7	1

<?php

Missing file doc comment

namespace Db3v4l\Core\DatabaseManager;

use Db3v4l\API\Interfaces\DatabaseManager;
use Db3v4l\API\Interfaces\SqlExecutor\Executor;
use Db3v4l\Core\SqlAction\Command;

class SQLite extends BaseManager implements DatabaseManager

Missing doc comment for class SQLite

{
    /**
     * Returns the sql 'action' used to list all available databases
     * @return Command

There must be exactly one blank line before the tags in a doc comment

     * @todo for each database, retrieve the charset/collation

Tag value for @todo tag indented incorrectly; expected 3 spaces but found 1

     */
    public function getListDatabasesSqlAction()
    {
        $fileGlob = dirname($this->databaseConfiguration['path']) . '/*.sqlite';
        return new Command(
            null,
            function() use ($fileGlob) {

Expected 1 space after FUNCTION keyword; 0 found

                $out = [];
                foreach (glob($fileGlob) as $filename) {
                    $out[] =  basename($filename);
                }
                return $out;
            }
        );
    }

    /**
     * Returns the sql 'action' used to create a new db and accompanying user
     * @param string $dbName

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $userName

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $password

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $charset charset/collation name

Expected 2 spaces after parameter name; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return Command

Tag @return cannot be grouped with parameter tags in a doc comment

     * @todo prevent sql injection!

Tag @todo cannot be grouped with parameter tags in a doc comment

Tag value for @todo tag indented incorrectly; expected 3 spaces but found 1

     */
    public function getCreateDatabaseSqlAction($dbName, $userName, $password, $charset = null)
    {
        //$collation = $this->getCollationName($charset);

        /// @todo throw if $charset is not supported

        /// @todo this does not support creation of the new db with a different character encoding...
        ///       see https://stackoverflow.com/questions/21348459/set-pragma-encoding-utf-16-for-main-database-in-sqlite
        $filename = dirname($this->databaseConfiguration['path']) . '/' . $dbName . '.sqlite';
        return new Command(
            "ATTACH '$filename' AS \"$dbName\";"
        );
    }

    /**
     * Returns the sql 'action' used to drop a db and associated user account
     * @param string $dbName

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $userName

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return Command

Tag @return cannot be grouped with parameter tags in a doc comment

     * @param bool $ifExists

Tags must be grouped together in a doc comment

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @todo prevent sql injection!

Tag @todo cannot be grouped with parameter tags in a doc comment

Tag value for @todo tag indented incorrectly; expected 3 spaces but found 1

     */
    public function getDropDatabaseSqlAction($dbName, $userName, $ifExists = false)
    {
        $filename = dirname($this->databaseConfiguration['path']) . '/' . $dbName . '.sqlite';
        return new Command(
            null,
            function() use($filename, $dbName, $ifExists) {

Expected 1 space after FUNCTION keyword; 0 found

Expected 1 space after USE keyword; found 0

                if (is_file($filename)) {
                    unlink($filename);
                } else {
                    if (!$ifExists) {
                        throw new \Exception("Can not drop database '$dbName': file not found");
                    }
                }
            }
        );
    }

    /**
     * Returns the sql 'action' used to list all existing db users
     * @return Command

There must be exactly one blank line before the tags in a doc comment

     */
    public function getListUsersSqlAction()
    {
        return new Command(
            null,
            function () {
                // since sqlite does not support users, null seems more appropriate than an empty array...
                return null;
            }
        );
    }

    /**

Missing short description in doc comment

     * @param string $userName

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param bool $ifExists

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return Command

Tag @return cannot be grouped with parameter tags in a doc comment

     * @todo prevent sql injection!

Tag @todo cannot be grouped with parameter tags in a doc comment

Tag value for @todo tag indented incorrectly; expected 3 spaces but found 1

     */
    public function getDropUserSqlAction($userName, $ifExists = false)
    {
        return new Command(
            null,
            function() {

Expected 1 space after FUNCTION keyword; 0 found

                /// @todo should we return something ?
            }
        );
    }

    /**
     * Returns the sql 'action' used to list all available collations
     * @return Command

There must be exactly one blank line before the tags in a doc comment

     */
    public function getListCollationsSqlAction()
    {
        return new Command(
            null,
            /// @todo list the supported utf16 variants as soon as allow using them
            function () {
                return [];
            }
        );
        /*return [
            // q: are these comparable to other databases ? we probably should instead list the values for https://www.sqlite.org/pragma.html#pragma_encoding
            'PRAGMA collation_list;',
            function ($output, $executor) {
                $out = [];
                foreach(explode("\n", $output) as $line) {
                    $out[] = explode("|", $line, 2)[1];
                }
                sort($out);
                return implode("\n", $out);
            }
        ];*/
    }

    /**
     * Returns the sql 'action' used to retrieve the db instance version info
     * @return Command

There must be exactly one blank line before the tags in a doc comment

     */
    public function getRetrieveVersionInfoSqlAction()
    {
        return new Command(
            "select sqlite_version();",
            function ($output, $executor) {
                /** @var Executor $executor */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                return $executor->resultSetToArray($output)[0];
            }
        );
    }

    /**
     * Transform collation name into a supported one
     * @param null|string $charset so far only 'utf8' is supported...

There must be exactly one blank line before the tags in a doc comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return null|string

Tag @return cannot be grouped with parameter tags in a doc comment

     * @todo what shall we accept as valid input, ie. 'generic' charset names ? maybe do 2 passes: known-db-charset => generic => specific for each db ?

Tag @todo cannot be grouped with parameter tags in a doc comment

Tag value for @todo tag indented incorrectly; expected 3 spaces but found 1

     *       see: https://www.iana.org/assignments/character-sets/character-sets.xhtml for IANA names
     */
    /*protected function getCollationName($charset)
    {
        if ($charset == null) {
            return null;
        }

        $charset = trim(strtolower($charset));

        // accept official iana charset name, but most dbs prefer 'utf8'...
        if ($charset == 'utf-8') {
            $charset = 'utf8';
        }

        return $charset;
    }*/
}