Db3v4l\Core\DatabaseManager\PostgreSQL

Complexity

Total Complexity

15

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getCollationName()	0	14	3
A	getListUsersSqlAction()	0	7	1
A	getRetrieveVersionInfoSqlAction()	0	7	1
A	getDropUserSqlAction()	0	9	2
A	getListCollationsSqlAction()	0	7	1
A	getListDatabasesSqlAction()	0	7	1
A	getCreateDatabaseSqlAction()	0	15	3
A	getDropDatabaseSqlAction()	0	14	3

<?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 PostgreSQL extends BaseManager implements DatabaseManager

Missing doc comment for class PostgreSQL

{
    /**
     * 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()
    {
        return new Command(
            'SELECT datname AS "Database" FROM pg_database ORDER BY datname;',
            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);
            }
        );
    }

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

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

Expected 3 spaces after parameter name; 1 found

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);

        $statements = [
            // q: do we need to add 'TEMPLATE template0' ?
            //    see f.e. https://www.vertabelo.com/blog/collations-in-postgresql/
            "CREATE DATABASE \"$dbName\"" . ($collation !== null ? " ENCODING $collation" : '') . ';',
        ];
        if ($userName != '') {
            $statements[] = "COMMIT;";
            $statements[] = "CREATE USER \"$userName\" WITH PASSWORD '$password'" . ';';
            $statements[] = "GRANT ALL ON DATABASE \"$dbName\" TO \"$userName\""; // q: should we avoid granting CREATE?
        }
        return new Command($statements);
    }

    /**
     * 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)
    {
        $ifClause = '';
        if ($ifExists) {
            $ifClause = 'IF EXISTS';
        }

        $statements = [
            "DROP DATABASE {$ifClause} \"$dbName\";",
        ];
        if ($userName != '') {
            $statements[] = "DROP USER {$ifClause} \"$userName\";";
        }
        return new Command($statements);
    }

    /**
     * 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(
            'SELECT usename AS "User" FROM pg_catalog.pg_user ORDER BY usename;',
            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);
            }
        );
    }

    /**

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)
    {
        $ifClause = '';
        if ($ifExists) {
            $ifClause = 'IF EXISTS';
        }

        return new Command([

The opening parenthesis of a multi-line function call should be the last content on the line.

            "DROP USER {$ifClause} \"$userName\";"
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * 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(
            'SELECT collname AS Collation FROM pg_collation ORDER BY collname',
            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);
            }
        );
    }

    /**
     * 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(
            'SHOW server_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) {

It seems like you are loosely comparing $charset of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            return null;
        }

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

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

        return $charset;
    }
}