hgraca / explicit-architecture-php

src/Core/Component/Blog/Application/Query/DQL/FindLatestPostsQuery.php

Doc Comments +1 added lines, -1 removed lines

@@ -54,7 +54,7 @@
      * to code readability.
      * However, by using `__invoke()` we lose code completion, so in the end I prefer to use this `execute()` method.
      *
-     * @return LatestPostWithAuthorAndTagsDto[]
+     * @return ResultCollectionInterface
      */
     public function execute(int $limit = self::NUM_ITEMS): ResultCollectionInterface
     {

src/Core/Component/Blog/Application/Query/DQL/FindPostsBySearchRequestQuery.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
     /**
      * @throws \Exception
      *
-     * @return PostsBySearchRequestDto[]
+     * @return ResultCollectionInterface
      */
     public function execute(string $queryString, int $limit = self::NUM_ITEMS): ResultCollectionInterface
     {

src/Core/Component/User/Application/Repository/DQL/UserRepository.php

Doc Comments +1 added lines, -1 removed lines

@@ -71,7 +71,7 @@
     }
 
     /**
-     * @return User[]
+     * @return ResultCollectionInterface
      */
     public function findAll(array $orderByList = ['id' => 'DESC'], int $maxResults = null): ResultCollectionInterface
     {

src/Infrastructure/TemplateEngine/Twig/Extension/SourceCode/SourceCodeExtension.php

Doc Comments +3 added lines

@@ -37,6 +37,9 @@
      */
     private $controller;
 
+    /**
+     * @param callable $controller
+     */
     public function setController(?callable $controller): void
     {
         $this->controller = $controller;

src/Core/Component/Blog/Domain/Post/Post.php

Doc Comments +4 added lines

@@ -272,6 +272,9 @@ 
             : $this->tags->clear();
     }
 
+    /**
+     * @param Comment[] $list
+     */
     private function contains($item, $list): bool
     {
         // we need to cast the list to array because it might just actually be a doctrine collection
@@ -279,6 +282,7 @@ 
     }
 
     /**
+     * @param Comment[] $list
      * @return false|int|string
      */
     private function getKey($item, $list)

src/Presentation/Console/Component/User/AddUserCommand.php

Doc Comments -24 removed lines

@@ -238,27 +238,3 @@
     private function getCommandHelp(): string
     {
         return <<<'HELP'
-            The <info>%command.name%</info> command creates new users and saves them in the database:
-
-              <info>php %command.full_name%</info> <comment>username password email</comment>
-
-            By default the command creates regular users. To create administrator users,
-            add the <comment>--admin</comment> option:
-
-              <info>php %command.full_name%</info> username password email mobile <comment>--admin</comment>
-
-            If you omit any of the three required arguments, the command will ask you to
-            provide the missing values:
-
-              # command will ask you for the email
-              <info>php %command.full_name%</info> <comment>username password</comment>
-
-              # command will ask you for the email and password
-              <info>php %command.full_name%</info> <comment>username</comment>
-
-              # command will ask you for all arguments
-              <info>php %command.full_name%</info>
-
-            HELP;
-    }
-}

Unused Use Statements -24 removed lines

@@ -238,27 +238,3 @@
     private function getCommandHelp(): string
     {
         return <<<'HELP'
-            The <info>%command.name%</info> command creates new users and saves them in the database:
-
-              <info>php %command.full_name%</info> <comment>username password email</comment>
-
-            By default the command creates regular users. To create administrator users,
-            add the <comment>--admin</comment> option:
-
-              <info>php %command.full_name%</info> username password email mobile <comment>--admin</comment>
-
-            If you omit any of the three required arguments, the command will ask you to
-            provide the missing values:
-
-              # command will ask you for the email
-              <info>php %command.full_name%</info> <comment>username password</comment>
-
-              # command will ask you for the email and password
-              <info>php %command.full_name%</info> <comment>username</comment>
-
-              # command will ask you for all arguments
-              <info>php %command.full_name%</info>
-
-            HELP;
-    }
-}

src/Presentation/Console/Component/User/DeleteUserCommand.php

Doc Comments -52 removed lines

@@ -83,55 +83,3 @@
             ->setDescription('Deletes users from the database')
             ->addArgument('username', InputArgument::REQUIRED, 'The username of an existing user')
             ->setHelp(<<<'HELP'
-                The <info>%command.name%</info> command deletes users from the database:
-
-                  <info>php %command.full_name%</info> <comment>username</comment>
-
-                If you omit the argument, the command will ask you to
-                provide the missing value:
-
-                  <info>php %command.full_name%</info>
-                HELP
-            );
-    }
-
-    protected function initialize(InputInterface $input, OutputInterface $output): void
-    {
-        // SymfonyStyle is an optional feature that Symfony provides so you can
-        // apply a consistent look to the commands of your application.
-        // See https://symfony.com/doc/current/console/style.html
-        $this->io = new SymfonyStyle($input, $output);
-    }
-
-    protected function interact(InputInterface $input, OutputInterface $output): void
-    {
-        if ($input->getArgument('username') !== null) {
-            return;
-        }
-
-        $this->io->title('Delete User Command Interactive Wizard');
-        $this->io->text([
-            'If you prefer to not use this interactive wizard, provide the',
-            'arguments required by this command as follows:',
-            '',
-            ' $ php bin/console app:delete-user username',
-            '',
-            'Now we\'ll ask you for the value of all the missing command arguments.',
-            '',
-        ]);
-
-        $username = $this->io->ask('Username', null, [$this->validator, 'validateUsername']);
-        $input->setArgument('username', $username);
-    }
-
-    protected function execute(InputInterface $input, OutputInterface $output): void
-    {
-        $username = $input->getArgument('username');
-
-        $this->userService->deleteUser($username);
-
-        $this->entityManager->flush();
-
-        $this->io->success(sprintf('User "%s" was successfully deleted.', $username));
-    }
-}

Unused Use Statements -52 removed lines

@@ -83,55 +83,3 @@
             ->setDescription('Deletes users from the database')
             ->addArgument('username', InputArgument::REQUIRED, 'The username of an existing user')
             ->setHelp(<<<'HELP'
-                The <info>%command.name%</info> command deletes users from the database:
-
-                  <info>php %command.full_name%</info> <comment>username</comment>
-
-                If you omit the argument, the command will ask you to
-                provide the missing value:
-
-                  <info>php %command.full_name%</info>
-                HELP
-            );
-    }
-
-    protected function initialize(InputInterface $input, OutputInterface $output): void
-    {
-        // SymfonyStyle is an optional feature that Symfony provides so you can
-        // apply a consistent look to the commands of your application.
-        // See https://symfony.com/doc/current/console/style.html
-        $this->io = new SymfonyStyle($input, $output);
-    }
-
-    protected function interact(InputInterface $input, OutputInterface $output): void
-    {
-        if ($input->getArgument('username') !== null) {
-            return;
-        }
-
-        $this->io->title('Delete User Command Interactive Wizard');
-        $this->io->text([
-            'If you prefer to not use this interactive wizard, provide the',
-            'arguments required by this command as follows:',
-            '',
-            ' $ php bin/console app:delete-user username',
-            '',
-            'Now we\'ll ask you for the value of all the missing command arguments.',
-            '',
-        ]);
-
-        $username = $this->io->ask('Username', null, [$this->validator, 'validateUsername']);
-        $input->setArgument('username', $username);
-    }
-
-    protected function execute(InputInterface $input, OutputInterface $output): void
-    {
-        $username = $input->getArgument('username');
-
-        $this->userService->deleteUser($username);
-
-        $this->entityManager->flush();
-
-        $this->io->success(sprintf('User "%s" was successfully deleted.', $username));
-    }
-}

src/Presentation/Console/Component/User/ListUsersCommand.php

Doc Comments -78 removed lines

@@ -83,81 +83,3 @@
         $this
             ->setDescription('Lists all the existing users')
             ->setHelp(<<<'HELP'
-                The <info>%command.name%</info> command lists all the users registered in the application:
-
-                  <info>php %command.full_name%</info>
-
-                By default the command only displays the 50 most recent users. Set the number of
-                results to display with the <comment>--max-results</comment> option:
-
-                  <info>php %command.full_name%</info> <comment>--max-results=2000</comment>
-
-                In addition to displaying the user list, you can also send this information to
-                the email address specified in the <comment>--send-to</comment> option:
-
-                  <info>php %command.full_name%</info> <comment>--send-to=fabien@symfony.com</comment>
-
-                HELP
-            )
-            // commands can optionally define arguments and/or options (mandatory and optional)
-            // see https://symfony.com/doc/current/components/console/console_arguments.html
-            ->addOption('max-results', null, InputOption::VALUE_OPTIONAL, 'Limits the number of users listed', 50)
-            ->addOption('send-to', null, InputOption::VALUE_OPTIONAL, 'If set, the result is sent to the given email address');
-    }
-
-    /**
-     * This method is executed after initialize(). It usually contains the logic
-     * to execute to complete this command task.
-     */
-    protected function execute(InputInterface $input, OutputInterface $output): void
-    {
-        $maxResults = $input->getOption('max-results');
-        $allUsers = $this->userRepository->findAll(['id' => 'DESC'], $maxResults);
-
-        // Doctrine query returns an array of objects and we need an array of plain arrays
-        $usersAsPlainArrays = array_map(function (User $user) {
-            return [
-                $user->getId(),
-                $user->getFullName(),
-                $user->getUsername(),
-                $user->getEmail(),
-                implode(', ', $user->getRoles()),
-            ];
-        }, $allUsers);
-
-        // In your console commands you should always use the regular output type,
-        // which outputs contents directly in the console window. However, this
-        // command uses the BufferedOutput type instead, to be able to get the output
-        // contents before displaying them. This is needed because the command allows
-        // to send the list of users via email with the '--send-to' option
-        $bufferedOutput = new BufferedOutput();
-        $io = new SymfonyStyle($input, $bufferedOutput);
-        $io->table(
-            ['ID', 'Full Name', 'Username', 'Email', 'Roles'],
-            $usersAsPlainArrays
-        );
-
-        // instead of just displaying the table of users, store its contents in a variable
-        $usersAsATable = $bufferedOutput->fetch();
-        $output->write($usersAsATable);
-
-        if (null !== $email = $input->getOption('send-to')) {
-            $this->sendReport($usersAsATable, $email);
-        }
-    }
-
-    /**
-     * Sends the given $contents to the $recipient email address.
-     */
-    private function sendReport(string $contents, string $recipient): void
-    {
-        // See https://symfony.com/doc/current/cookbook/email/email.html
-        $message = $this->mailer->createMessage()
-            ->setSubject(sprintf('app:list-users report (%s)', date('Y-m-d H:i:s')))
-            ->setFrom($this->emailSender)
-            ->setTo($recipient)
-            ->setBody($contents, 'text/plain');
-
-        $this->mailer->send($message);
-    }
-}

Unused Use Statements -78 removed lines

@@ -83,81 +83,3 @@
         $this
             ->setDescription('Lists all the existing users')
             ->setHelp(<<<'HELP'
-                The <info>%command.name%</info> command lists all the users registered in the application:
-
-                  <info>php %command.full_name%</info>
-
-                By default the command only displays the 50 most recent users. Set the number of
-                results to display with the <comment>--max-results</comment> option:
-
-                  <info>php %command.full_name%</info> <comment>--max-results=2000</comment>
-
-                In addition to displaying the user list, you can also send this information to
-                the email address specified in the <comment>--send-to</comment> option:
-
-                  <info>php %command.full_name%</info> <comment>--send-to=fabien@symfony.com</comment>
-
-                HELP
-            )
-            // commands can optionally define arguments and/or options (mandatory and optional)
-            // see https://symfony.com/doc/current/components/console/console_arguments.html
-            ->addOption('max-results', null, InputOption::VALUE_OPTIONAL, 'Limits the number of users listed', 50)
-            ->addOption('send-to', null, InputOption::VALUE_OPTIONAL, 'If set, the result is sent to the given email address');
-    }
-
-    /**
-     * This method is executed after initialize(). It usually contains the logic
-     * to execute to complete this command task.
-     */
-    protected function execute(InputInterface $input, OutputInterface $output): void
-    {
-        $maxResults = $input->getOption('max-results');
-        $allUsers = $this->userRepository->findAll(['id' => 'DESC'], $maxResults);
-
-        // Doctrine query returns an array of objects and we need an array of plain arrays
-        $usersAsPlainArrays = array_map(function (User $user) {
-            return [
-                $user->getId(),
-                $user->getFullName(),
-                $user->getUsername(),
-                $user->getEmail(),
-                implode(', ', $user->getRoles()),
-            ];
-        }, $allUsers);
-
-        // In your console commands you should always use the regular output type,
-        // which outputs contents directly in the console window. However, this
-        // command uses the BufferedOutput type instead, to be able to get the output
-        // contents before displaying them. This is needed because the command allows
-        // to send the list of users via email with the '--send-to' option
-        $bufferedOutput = new BufferedOutput();
-        $io = new SymfonyStyle($input, $bufferedOutput);
-        $io->table(
-            ['ID', 'Full Name', 'Username', 'Email', 'Roles'],
-            $usersAsPlainArrays
-        );
-
-        // instead of just displaying the table of users, store its contents in a variable
-        $usersAsATable = $bufferedOutput->fetch();
-        $output->write($usersAsATable);
-
-        if (null !== $email = $input->getOption('send-to')) {
-            $this->sendReport($usersAsATable, $email);
-        }
-    }
-
-    /**
-     * Sends the given $contents to the $recipient email address.
-     */
-    private function sendReport(string $contents, string $recipient): void
-    {
-        // See https://symfony.com/doc/current/cookbook/email/email.html
-        $message = $this->mailer->createMessage()
-            ->setSubject(sprintf('app:list-users report (%s)', date('Y-m-d H:i:s')))
-            ->setFrom($this->emailSender)
-            ->setTo($recipient)
-            ->setBody($contents, 'text/plain');
-
-        $this->mailer->send($message);
-    }
-}