console-helpers / jira-cli

src/JiraCLI/Command/AbstractCommand.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\Config\ConfigEditor;
use ConsoleHelpers\ConsoleKit\Command\AbstractCommand as BaseCommand;
use ConsoleHelpers\JiraCLI\JiraApi;
use Doctrine\Common\Cache\CacheProvider;
use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;

/**
 * Base command class.
 */
abstract class AbstractCommand extends BaseCommand
{

	/**
	 * Config editor.
	 *
	 * @var ConfigEditor
	 */
	private $_configEditor;

	/**
	 * Jira REST client.
	 *
	 * @var JiraApi
	 */
	protected $jiraApi;

	/**
	 * Cache.
	 *
	 * @var CacheProvider
	 */
	protected $cache;

	/**
	 * Statistics.
	 *
	 * @var array
	 */
	protected $statistics = array();

	/**
	 * Prepare dependencies.
	 *
	 * @return void
	 */
	protected function prepareDependencies()
	{
		$container = $this->getContainer();

		$this->_configEditor = $container['config_editor'];
		$this->jiraApi = $container['jira_api'];
		$this->cache = $container['cache'];
	}

	/**
	 * Returns command setting value.
	 *
	 * @param string $name Name.
	 *
	 * @return mixed
	 */
	protected function getSetting($name)
	{
		return $this->_configEditor->get($name);
	}

	/**
	 * Checks if an issue key is valid.
	 *
	 * @param string $issue_key Issue key.
	 *
	 * @return boolean
	 */
	public function isValidIssueKey($issue_key)
	{
		return preg_match('/^([A-Z]+-[0-9]+)$/', $issue_key);

The expression return preg_match('/^([A-Z]+-[0-9]+)$/', $issue_key) returns the type integer which is incompatible with the documented return type boolean.

	}

	/**
	 * Return possible values for the named argument
	 *
	 * @param string            $argumentName Argument name.
	 * @param CompletionContext $context      Completion context.
	 *
	 * @return array
	 */
	public function completeArgumentValues($argumentName, CompletionContext $context)
	{
		$ret = parent::completeArgumentValues($argumentName, $context);

		if ( $argumentName === 'project_key' || $argumentName === 'project_keys' ) {
			return $this->jiraApi->getProjectKeys();
		}

		return $ret;
	}

	/**
	 * Shows statistics.
	 *
	 * @return void
	 */
	protected function showStatistics()
	{
		if ( !$this->io->isVerbose() ) {
			return;
		}

		$request_count = $this->jiraApi->getRequestCount();

		if ( $request_count ) {
			$this->statistics[] = 'API Requests Made: ' . $request_count;
		}

		if ( $this->statistics ) {

The expression $this->statistics of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

			$this->io->writeln('===============');
			$this->io->writeln($this->statistics);
		}
	}

}