hgraca / explicit-architecture-php

declare(strict_types=1);

/*

 * This file is part of the Explicit Architecture POC,

 * which is created on top of the Symfony Demo application.

 *

 * (c) Herberto Graça <[email protected]>

 *

 * For the full copyright and license information, please view the LICENSE

 * file that was distributed with this source code.

 */

namespace Acme\App\Presentation\Console\Component\User;

use Acme\App\Core\Component\User\Application\Repository\UserRepositoryInterface;

use Acme\App\Core\Component\User\Domain\User\User;

use Swift_Mailer;

use Symfony\Component\Console\Command\Command;

use Symfony\Component\Console\Input\InputInterface;

use Symfony\Component\Console\Input\InputOption;

use Symfony\Component\Console\Output\BufferedOutput;

use Symfony\Component\Console\Output\OutputInterface;

use Symfony\Component\Console\Style\SymfonyStyle;

/**

 * A console command that lists all the existing users.

 *

 * To use this command, open a terminal window, enter into your project directory

 * and execute the following:

 *

 *     $ php bin/console app:list-users

 *

 * See https://symfony.com/doc/current/cookbook/console/console_command.html

 * For more advanced uses, commands can be defined as services too. See

 * https://symfony.com/doc/current/console/commands_as_services.html

 *

 * @author Javier Eguiluz <[email protected]>

 * @author Herberto Graca <[email protected]>

 */

class ListUsersCommand extends Command

{

    /**

     * A good practice is to use the 'app:' prefix to group all your custom application commands.

     *

     * @var string

     */

    protected static $defaultName = 'app:list-users';

    /**

     * @var Swift_Mailer

     */

    private $mailer;

    /**

     * @var string

     */

    private $emailSender;

    /**

     * @var UserRepositoryInterface

     */

    private $userRepository;

    public function __construct(

        Swift_Mailer $mailer,

        string $defaultFromEmailAddress,

        UserRepositoryInterface $userRepository

    ) {

        parent::__construct();

        $this->mailer = $mailer;

        $this->emailSender = $defaultFromEmailAddress;

        $this->userRepository = $userRepository;

    }

    /**

     * {@inheritdoc}

     */

    protected function configure(): void

    {

                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>[email protected]</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);

    }

}