Updated references to short code and replaced them to short URL where appropriate

2026-03-10 17:23:12 +08:00 · 2018-09-16 18:36:02 +02:00
parent 92858aebd6
commit 1eff9801e8
15 changed files with 58 additions and 58 deletions
--- a/module/CLI/src/Command/ShortUrl/GetVisitsCommand.php
+++ b/module/CLI/src/Command/ShortUrl/GetVisitsCommand.php
@@ -0,0 +1,116 @@
+<?php
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
+
+use Shlinkio\Shlink\Common\Util\DateRange;
+use Shlinkio\Shlink\Core\Service\VisitsTrackerInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Zend\I18n\Translator\TranslatorInterface;
+
+class GetVisitsCommand extends Command
+{
+    public const NAME = 'short-url:visits';
+    private const ALIASES = ['shortcode:visits', 'short-code:visits'];
+
+    /**
+     * @var VisitsTrackerInterface
+     */
+    private $visitsTracker;
+    /**
+     * @var TranslatorInterface
+     */
+    private $translator;
+
+    public function __construct(VisitsTrackerInterface $visitsTracker, TranslatorInterface $translator)
+    {
+        $this->visitsTracker = $visitsTracker;
+        $this->translator = $translator;
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setName(self::NAME)
+            ->setAliases(self::ALIASES)
+            ->setDescription(
+                $this->translator->translate('Returns the detailed visits information for provided short code')
+            )
+            ->addArgument(
+                'shortCode',
+                InputArgument::REQUIRED,
+                $this->translator->translate('The short code which visits we want to get')
+            )
+            ->addOption(
+                'startDate',
+                's',
+                InputOption::VALUE_OPTIONAL,
+                $this->translator->translate('Allows to filter visits, returning only those older than start date')
+            )
+            ->addOption(
+                'endDate',
+                'e',
+                InputOption::VALUE_OPTIONAL,
+                $this->translator->translate('Allows to filter visits, returning only those newer than end date')
+            );
+    }
+
+    protected function interact(InputInterface $input, OutputInterface $output): void
+    {
+        $shortCode = $input->getArgument('shortCode');
+        if (! empty($shortCode)) {
+            return;
+        }
+
+        $io = new SymfonyStyle($input, $output);
+        $shortCode = $io->ask(
+            $this->translator->translate('A short code was not provided. Which short code do you want to use?')
+        );
+        if (! empty($shortCode)) {
+            $input->setArgument('shortCode', $shortCode);
+        }
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): void
+    {
+        $io = new SymfonyStyle($input, $output);
+        $shortCode = $input->getArgument('shortCode');
+        $startDate = $this->getDateOption($input, 'startDate');
+        $endDate = $this->getDateOption($input, 'endDate');
+
+        $visits = $this->visitsTracker->info($shortCode, new DateRange($startDate, $endDate));
+        $rows = [];
+        foreach ($visits as $row) {
+            $rowData = $row->jsonSerialize();
+
+            // Unset location info and remote addr
+            unset($rowData['visitLocation'], $rowData['remoteAddr']);
+
+            $rowData['country'] = $row->getVisitLocation()->getCountryName();
+
+            $rows[] = \array_values($rowData);
+        }
+        $io->table([
+            $this->translator->translate('Referer'),
+            $this->translator->translate('Date'),
+            $this->translator->translate('User agent'),
+            $this->translator->translate('Country'),
+        ], $rows);
+    }
+
+    private function getDateOption(InputInterface $input, $key)
+    {
+        $value = $input->getOption($key);
+        if (! empty($value)) {
+            $value = new \DateTime($value);
+        }
+
+        return $value;
+    }
+}