gggeek / db-3v4l

app/src/Command/DatabaseManagingCommand.php

<?php

Missing file doc comment

namespace Db3v4l\Command;

use Db3v4l\Core\DatabaseSchemaManager;

The type Db3v4l\Core\DatabaseSchemaManager was not found. Maybe you did not declare it correctly or list all dependencies?

abstract class DatabaseManagingCommand extends SQLExecutingCommand

Missing doc comment for class DatabaseManagingCommand

{
    /**

Missing short description in doc comment

     * @param string[][] $instanceList

Missing parameter comment

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

     * @param array[] $dbSpecList key: db name (as used to identify configured databases), value: array('user': mandatory, 'dbname': mandatory, 'password': mandatory)

Expected 4 spaces after parameter type; 1 found

Expected 3 spaces after parameter name; 1 found

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

     * @return array 'succeeded': int, 'failed': int, 'results': same format as dbConfigurationManager::getInstanceConfiguration

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

     * @throws \Exception

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

     *
     * @todo make it easier to report back to the caller the errors that prevented creation of any DB
     */
    protected function createDatabases($instanceList, $dbSpecList)
    {
        // Sadly, psql does not allow to create a db and a user using a multiple-sql-commands string,
        // and we have to resort to using temp files
        /// @todo can we make this safer? Ideally the new user name and pwd should neither hit disk nor the process list...
        $results = $this->executeSqlAction(
            $instanceList,
            'Creating new database & user',
            function ($schemaManager, $instanceName) use ($dbSpecList) {
                $dbConnectionSpec = $dbSpecList[$instanceName];
                /** @var DatabaseSchemaManager $schemaManager */

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 $schemaManager->getCreateDatabaseSqlAction(
                    $dbConnectionSpec['dbname'],
                    isset($dbConnectionSpec['user']) ? $dbConnectionSpec['user'] : null,
                    isset($dbConnectionSpec['password']) ? $dbConnectionSpec['password'] : null,
                    (isset($dbConnectionSpec['charset']) && $dbConnectionSpec['charset'] != '') ? $dbConnectionSpec['charset'] : null
                );
            }
        );

        /// @todo the new connection spec should be generated by the schemaManager for each instance. This would allow
        ///       f.e. connection specs for Oracle to be different when using PDBs vs when using schemas
        ///       (this could be achieved by copying the 'dbname' member over the 'servicename' one, or unsetting 'servicename'...)
        $finalData = [];
        foreach($results['data'] as $instanceName => $data) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            // check for failure in creation of temp db
            // @todo how can we tell apart correctly errors that actually prevented the db from being created from other errors?
            if (is_array($data) && isset($data['exitcode']) && $data['exitcode'] != 0) {
                continue;
            }
            $dbConnectionSpec = $dbSpecList[$instanceName];
            $finalData[$instanceName] = $instanceList[$instanceName];
            $finalData[$instanceName]['dbname'] = $dbConnectionSpec['dbname'];
            if (isset($dbConnectionSpec['user'])) {
                $finalData[$instanceName]['user'] = $dbConnectionSpec['user'];
            }
            if (isset($dbConnectionSpec['password'])) {
                $finalData[$instanceName]['password'] = $dbConnectionSpec['password'];
            }
            if (isset($dbConnectionSpec['charset'])) {
                $finalData[$instanceName]['charset'] = $dbConnectionSpec['charset'];
            }
        }

        $results['data'] = $finalData;
        return $results;
    }

    /**

Missing short description in doc comment

     * @param string[][] $instanceList

Missing parameter comment

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

     * @param array[] $dbSpecList key: db name (as used to identify configured databases), value: array('user': mandatory, 'dbname': mandatory, if unspecified assumed same as user)

Expected 4 spaces after parameter type; 1 found

Expected 8 spaces after parameter name; 1 found

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

     * @param bool $ifExists

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

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

     * @param string $executionStrategy

Missing parameter comment

Expected 5 spaces after parameter type; 1 found

Superfluous parameter comment

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

     * @return array 'succeeded': int, 'failed': int, 'results': string[]

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

     * @throws \Exception

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

     */
    protected function dropDatabases($instanceList, $dbSpecList, $ifExists = false)
    {
        return $this->executeSqlAction(
            $instanceList,
            'Dropping of database & user',
            function ($schemaManager, $instanceName) use ($dbSpecList, $ifExists) {
                $dbConnectionSpec = $dbSpecList[$instanceName];
                /** @var DatabaseSchemaManager $schemaManager */

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 $schemaManager->getDropDatabaseSqlAction(
                    $dbConnectionSpec['dbname'],
                    isset($dbConnectionSpec['user']) ? $dbConnectionSpec['user'] : null,
                    $ifExists
                );
            }
        );
    }
}