gggeek / db-3v4l

app/src/Command/UserDrop.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?

use Symfony\Component\Console\Input\InputInterface;

The type Symfony\Component\Console\Input\InputInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Console\Input\InputOption;

The type Symfony\Component\Console\Input\InputOption was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Console\Output\OutputInterface;

The type Symfony\Component\Console\Output\OutputInterface was not found. Maybe you did not declare it correctly or list all dependencies?

class UserDrop extends DatabaseManagingCommand

Missing doc comment for class UserDrop

{
    protected static $defaultName = 'db3v4l:user:drop';

    protected function configure()

Missing doc comment for function configure()

    {
        $this
            ->setDescription('Drops a database user in parallel on all configured database instances')
            ->addOption('user', 'u', InputOption::VALUE_REQUIRED, 'The name of the user to drop')
            ->addCommonOptions()

Space after closing parenthesis of function call prohibited

        ;
    }

    /**

Missing short description in doc comment

     * @param InputInterface $input

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

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

     * @param OutputInterface $output

Missing parameter comment

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

     * @return int

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 execute(InputInterface $input, OutputInterface $output)
    {
        $start = microtime(true);

        // as per https://www.php.net/manual/en/function.ignore-user-abort.php: for cli scripts, it is probably a good idea
        // to use ignore_user_abort
        ignore_user_abort(true);

        $this->setOutput($output);
        $this->setVerbosity($output->getVerbosity());

        $instanceList = $this->parseCommonOptions($input);

        $userName = $input->getOption('user');

        if ($userName == null) {
            throw new \Exception("Please provide a username");
        }

        if ($this->outputFormat === 'text') {
            $this->writeln('<info>Dropping users...</info>');
        }

        $userToDropSpecs = [];
        foreach($instanceList as $instanceName => $instanceSpecs) {

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

            $userToDropSpecs[$instanceName] = [
                'user' => $userName
            ];
        }
        $results = $this->dropUsers($instanceList, $userToDropSpecs);

        // BC with versions < 0.8
        $results['data'] = null;

        $time = microtime(true) - $start;

        $this->writeResults($results, $time);

        return (int)$results['failed'];
    }

    /**

Missing short description in doc comment

     * @param $instanceList

Missing parameter comment

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

     * @param $userToDropSpecs

Missing parameter comment

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

     * @param bool $ifExists

Missing parameter comment

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

     * @return array

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 dropUsers($instanceList, $userToDropSpecs, $ifExists = false)
    {
        return $this->executeSqlAction(
            $instanceList,
            'Dropping of user',
            function ($schemaManager, $instanceName) use ($userToDropSpecs, $ifExists) {
                $dbConnectionSpec = $userToDropSpecs[$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->getDropUserSqlAction(
                    $dbConnectionSpec['user'],
                    $ifExists
                );
            }
        );
    }
}