N98\Magento\Command\System\Url\ListCommand

Complexity

Total Complexity

16

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	5
Bugs	2	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	configure()	0	29	1
C	execute()	0	61	11
A	getUrls()	0	12	3
A	inject()	0	11	1

<?php

namespace N98\Magento\Command\System\Url;

use Magento\Sitemap\Model\ResourceModel\Catalog\Category;
use Magento\Sitemap\Model\ResourceModel\Catalog\Product;
use Magento\Sitemap\Model\ResourceModel\Cms\Page;
use Magento\Store\Model\StoreManager;
use Magento\Store\Model\StoreManagerInterface;
use N98\Magento\Command\AbstractMagentoCommand;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

class ListCommand extends AbstractMagentoCommand
{
    /**
     * @var StoreManagerInterface
     */
    protected $storeManager;

    /**
     * @var Category
     */
    protected $sitemapCategoryCollection;

    /**
     * @var Product
     */
    protected $sitemapProductCollection;

    /**
     * @var \Magento\Sitemap\Model\Resource\Cms\Page
     */
    protected $sitemapPageCollection;

    protected function configure()
    {
        $this
            ->setName('sys:url:list')
            ->addOption('add-categories', null, InputOption::VALUE_NONE, 'Adds categories')
            ->addOption('add-products', null, InputOption::VALUE_NONE, 'Adds products')
            ->addOption('add-cmspages', null, InputOption::VALUE_NONE, 'Adds cms pages')
            ->addOption('add-all', null, InputOption::VALUE_NONE, 'Adds categories, products and cms pages')
            ->addArgument('stores', InputArgument::OPTIONAL, 'Stores (comma-separated list of store ids)')
            ->addArgument('linetemplate', InputArgument::OPTIONAL, 'Line template', '{url}')
            ->setDescription('Get all urls.');

        $help = <<<HELP
Examples:

- Create a list of product urls only:

   $ n98-magerun.phar sys:url:list --add-products 4

- Create a list of all products, categories and cms pages of store 4 
  and 5 separating host and path (e.g. to feed a jmeter csv sampler):

   $ n98-magerun.phar sys:url:list --add-all 4,5 '{host},{path}' > urls.csv

- The "linetemplate" can contain all parts "parse_url" return wrapped 
  in '{}'. '{url}' always maps the complete url and is set by default
HELP;
        $this->setHelp($help);
    }

    /**
     * Execute command
     *
     * @param StoreManager $storeManager

Should the type for parameter $storeManager not be StoreManagerInterface?

     * @param Category $sitemapCategoryCollection
     * @param Product $sitemapProductCollection
     * @param Page $sitemapPageCollection
     */
    public function inject(
        StoreManagerInterface $storeManager,
        Category $sitemapCategoryCollection,
        Product $sitemapProductCollection,
        Page $sitemapPageCollection
    ) {
        $this->storeManager = $storeManager;
        $this->sitemapCategoryCollection = $sitemapCategoryCollection;
        $this->sitemapProductCollection = $sitemapProductCollection;
        $this->sitemapPageCollection = $sitemapPageCollection;

It seems like $sitemapPageCollection of type object<Magento\Sitemap\Model\ResourceModel\Cms\Page> is incompatible with the declared type object<Magento\Sitemap\Model\Resource\Cms\Page> of property $sitemapPageCollection.

    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $this->detectMagento($output, true);
        if (!$this->initMagento()) {
            return;
        }

        if ($input->getOption('add-all')) {
            $input->setOption('add-categories', true);
            $input->setOption('add-products', true);
            $input->setOption('add-cmspages', true);
        }

        $stores = explode(',', $input->getArgument('stores'));

        $urls = array();

        foreach ($stores as $storeId) {
            try {
                $currentStore = $this->storeManager->getStore($storeId);
            } catch (\Exception $e) {
                throw new \RuntimeException("Store with id {$storeId} doesn´t exist");
            }

            // base url
            $urls[] = $currentStore->getBaseUrl(\Magento\Framework\UrlInterface::URL_TYPE_WEB);

            $linkBaseUrl = $currentStore->getBaseUrl(\Magento\Framework\UrlInterface::URL_TYPE_LINK);

            if ($input->getOption('add-categories')) {
                $urls = $this->getUrls($this->sitemapCategoryCollection, $linkBaseUrl, $storeId, $urls);
            }

            if ($input->getOption('add-products')) {
                $urls = $this->getUrls($this->sitemapProductCollection, $linkBaseUrl, $storeId, $urls);
            }

            if ($input->getOption('add-cmspages')) {
                $urls = $this->getUrls($this->sitemapPageCollection, $linkBaseUrl, $storeId, $urls);
            }
        } // foreach ($stores as $storeId)

60% of this comment could be valid code. Did you maybe forget this after debugging?

        if (count($urls) === 0) {
            return;
        }

        foreach ($urls as $url) {

            // pre-process
            $line = $input->getArgument('linetemplate');
            $line = str_replace('{url}', $url, $line);

            $parts = parse_url($url);
            foreach ($parts as $key => $value) {

The expression $parts of type array<string,string>|false is not guaranteed to be traversable. How about adding an additional type check?

                $line = str_replace('{' . $key . '}', $value, $line);
            }

            // ... and output
            $output->writeln($line);
        }
    }

    /**
     * @param string $linkBaseUrl
     * @param string $storeId
     * @param array  $urls
     *
     * @return array
     */
    protected function getUrls($entityCollection, $linkBaseUrl, $storeId, array $urls)
    {
        $collection = $entityCollection->getCollection($storeId);
        if (!$collection) {
            return $urls;
        }
        foreach ($collection as $item) {
            /* @var $item \Magento\Framework\Object */
            $urls[] = $linkBaseUrl . $item->getUrl();
        }
        return $urls;
    }
}