console-helpers / jira-cli

src/JiraCLI/Command/DownloadAttachmentCommand.php

<?php
/**
 * This file is part of the Jira-CLI library.
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 *
 * @copyright Alexander Obuhovich <aik.bold@gmail.com>
 * @link      https://github.com/console-helpers/jira-cli
 */

namespace ConsoleHelpers\JiraCLI\Command;


use ConsoleHelpers\ConsoleKit\Exception\CommandException;
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 DownloadAttachmentCommand extends AbstractCommand
{

	/**
	 * {@inheritdoc}
	 */
	protected function configure()
	{
		$this
			->setName('download-attachment')
			->setDescription('Downloads issue attachments')
			->addArgument('issue', InputArgument::REQUIRED, 'Issue key or url')
			->addOption(
				'index',
				'i',
				InputOption::VALUE_IS_ARRAY + InputOption::VALUE_OPTIONAL,
				'Attachment index to download'
			);
	}

	/**
	 * {@inheritdoc}
	 */
	protected function execute(InputInterface $input, OutputInterface $output)
	{
		$issue_key = $this->getIssueKey();
		$issue_data = $this->jiraApi->getIssue($issue_key)->getResult();

		$attachments = $issue_data['fields']['attachment'];

		// Show attachments.
		$this->io->writeln('<info>Issue ' . $issue_key . ' attachments:</info>');

		foreach ( $attachments as $index => $attachment_data ) {
			$this->io->writeln($index . '. ' . $attachment_data['filename']);
		}

		$indexes = $this->io->getOption('index');

		if ( count($indexes) === 0 ) {

It seems like $indexes can also be of type boolean and null and string; however, parameter $value of count() does only seem to accept Countable|array, maybe add an additional type check?

			$indexes = array_keys($attachments);
		}

		// Download attachments.
		$this->io->writeln('');
		$this->io->writeln('Downloading all attachments to <info>' . getcwd() . '</info>');

		foreach ( $attachments as $index => $attachment_data ) {
			if ( !in_array($index, $indexes) ) {

It seems like $indexes can also be of type boolean and null and string; however, parameter $haystack of in_array() does only seem to accept array, maybe add an additional type check?

				continue;
			}

			$this->io->write('- ' . $attachment_data['filename'] . ' ... ');
			file_put_contents(
				$attachment_data['filename'],
				$this->jiraApi->downloadAttachment($attachment_data['content'])
			);
			$this->io->writeln('done');
		}

		$this->showStatistics();
	}

	/**
	 * Returns issue key.
	 *
	 * @return string
	 * @throws CommandException When issue key is invalid.
	 */
	protected function getIssueKey()
	{
		$issue = $this->io->getArgument('issue');

		if ( $this->isValidIssueKey($issue) ) {

It seems like $issue can also be of type string[]; however, parameter $issue_key of ConsoleHelpers\JiraCLI\Command\AbstractCommand::isValidIssueKey() does only seem to accept string, maybe add an additional type check?

			return $issue;

The expression return $issue also could return the type string[] which is incompatible with the documented return type string.

		}

		throw new CommandException('The issue key is invalid');
	}

}