AbstractCommand::getSetting() - Code Metrics - console-helpers/jira-cli - Measure and Improve Code Quality continuously with Scrutinizer

AbstractCommand::getSetting() A
last analyzed 2024-12-25 21:04 UTC

↳ Parent: AbstractCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?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 <[email protected]>
 * @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);

	}

	/**
	 * 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 ) {

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

}


1			<?php
2			/**
3			* This file is part of the Jira-CLI library.
4			* For the full copyright and license information, please view
5			* the LICENSE file that was distributed with this source code.
6			*
7			* @copyright Alexander Obuhovich <[email protected]>
8			* @link https://github.com/console-helpers/jira-cli
9			*/
10
11			namespace ConsoleHelpers\JiraCLI\Command;
12
13
14			use ConsoleHelpers\ConsoleKit\Config\ConfigEditor;
15			use ConsoleHelpers\ConsoleKit\Command\AbstractCommand as BaseCommand;
16			use ConsoleHelpers\JiraCLI\JiraApi;
17			use Doctrine\Common\Cache\CacheProvider;
18			use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
19
20			/**
21			* Base command class.
22			*/
23			abstract class AbstractCommand extends BaseCommand
24			{
25
26			/**
27			* Config editor.
28			*
29			* @var ConfigEditor
30			*/
31			private $_configEditor;
32
33			/**
34			* Jira REST client.
35			*
36			* @var JiraApi
37			*/
38			protected $jiraApi;
39
40			/**
41			* Cache.
42			*
43			* @var CacheProvider
44			*/
45			protected $cache;
46
47			/**
48			* Statistics.
49			*
50			* @var array
51			*/
52			protected $statistics = array();
53
54			/**
55			* Prepare dependencies.
56			*
57			* @return void
58			*/
59			protected function prepareDependencies()
60			{
61			$container = $this->getContainer();
62
63			$this->_configEditor = $container['config_editor'];
64			$this->jiraApi = $container['jira_api'];
65			$this->cache = $container['cache'];
66			}
67
68			/**
69			* Returns command setting value.
70			*
71			* @param string $name Name.
72			*
73			* @return mixed
74			*/
75			protected function getSetting($name)
76			{
77			return $this->_configEditor->get($name);
78			}
79
80			/**
81			* Checks if an issue key is valid.
82			*
83			* @param string $issue_key Issue key.
84			*
85			* @return boolean
86			*/
87			public function isValidIssueKey($issue_key)
88			{
89			return preg_match('/^([A-Z]+-[0-9]+)$/', $issue_key);
			0 ignored issues – show Bug Best Practice introduced 2021-10-16 18:17 UTC by Report Bug Copy Issue Report The expression `return preg_match('/^([A...[0-9]+)$/', $issue_key)` returns the type `integer` which is incompatible with the documented return type `boolean`. Loading history...
90			}
91
92			/**
93			* Return possible values for the named argument
94			*
95			* @param string $argumentName Argument name.
96			* @param CompletionContext $context Completion context.
97			*
98			* @return array
99			*/
100			public function completeArgumentValues($argumentName, CompletionContext $context)
101			{
102			$ret = parent::completeArgumentValues($argumentName, $context);
103
104			if ( $argumentName === 'project_key' \|\| $argumentName === 'project_keys' ) {
105			return $this->jiraApi->getProjectKeys();
106			}
107
108			return $ret;
109			}
110
111			/**
112			* Shows statistics.
113			*
114			* @return void
115			*/
116			protected function showStatistics()
117			{
118			if ( !$this->io->isVerbose() ) {
119			return;
120			}
121
122			$request_count = $this->jiraApi->getRequestCount();
123
124			if ( $request_count ) {
125			$this->statistics[] = 'API Requests Made: ' . $request_count;
126			}
127
128			if ( $this->statistics ) {
			0 ignored issues – show Bug Best Practice introduced 2024-12-25 21:04 UTC by Report Bug Copy Issue Report 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 check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
129			$this->io->writeln('===============');
130			$this->io->writeln($this->statistics);
131			}
132			}
133
134			}
135

console-helpers / jira-cli

AbstractCommand::getSetting() A last analyzed 2024-12-25 21:04 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

AbstractCommand::getSetting() A
last analyzed 2024-12-25 21:04 UTC