BrightNucleus\Shortcode\ShortcodeUI

Complexity

Total Complexity

6

Size/Duplication

Total Lines	87
Duplicated Lines	28.74 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes	3
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	10	2
A	__construct()	12	12	1
A	is_needed()	13	13	3

<?php
/**
 * ShortcodeUI Class.
 *
 * @package   BrightNucleus\Shortcode
 * @author    Alain Schlesser <alain.schlesser@gmail.com>
 * @license   GPL-2.0+
 * @link      http://www.brightnucleus.com/
 * @copyright 2015-2016 Alain Schlesser, Bright Nucleus
 */

namespace BrightNucleus\Shortcode;

use Assert;
use BrightNucleus\Config\ConfigInterface;
use BrightNucleus\Config\ConfigTrait;
use BrightNucleus\Dependency\DependencyManagerInterface as DependencyManager;
use BrightNucleus\Exception\RuntimeException;

/**
 * Shortcode UI Class.
 *
 * @since   0.1.0
 *
 * @package BrightNucleus\Shortcode
 * @author  Alain Schlesser <alain.schlesser@gmail.com>
 */
class ShortcodeUI implements ShortcodeUIInterface {

	use ConfigTrait;

	/**
	 * Name of the shortcode handler.
	 *
	 * @since 0.1.0
	 *
	 * @var string
	 */
	protected $shortcode_tag;

	/**
	 * Dependencies to be enqueued.
	 *
	 * @since 0.1.0
	 *
	 * @var DependencyManagerInterface
	 */
	protected $dependencies;

	/**
	 * Instantiate Basic Shortcode UI.
	 *
	 * @since 1.0.
	 *
	 * @param string                 $shortcode_tag Tag of the Shortcode.
	 * @param ConfigInterface        $config        Configuration settings.
	 * @param DependencyManager|null $dependencies  Optional. Dependencies that
	 *                                              need to be enqueued.
	 * @throws RuntimeException If the config could not be processed.
	 */
	public function __construct(

This method seems to be duplicated in your project.

		$shortcode_tag,
		ConfigInterface $config,
		DependencyManager $dependencies = null
	) {
		Assert\that( $shortcode_tag )->string()->notEmpty();

		$this->processConfig( $config );

		$this->shortcode_tag = $shortcode_tag;
		$this->dependencies  = $dependencies;

It seems like $dependencies can also be of type object<BrightNucleus\Dependency\DependencyManagerInterface>. However, the property $dependencies is declared as type object<BrightNucleus\Shortcode\DependencyManagerInterface>. Maybe add an additional type check?

	}

	/**
	 * Register the shortcode UI handler function with WordPress.
	 *
	 * @since 0.1.0
	 *
	 * @param mixed $context Data about the context in which the call is made.
	 * @return void
	 */
	public function register( $context = null ) {
		if ( ! $this->is_needed() ) {
			return;
		}

		\shortcode_ui_register_for_shortcode(
			$this->shortcode_tag,
			$this->config
		);
	}

	/**
	 * Check whether the shortcode UI is needed.
	 *
	 * @since 0.1.0
	 *
	 * @param mixed $context Data about the context in which the call is made.
	 * @return boolean Whether the shortcode UI is needed or not.
	 */
	protected function is_needed( $context = null ) {

This method seems to be duplicated in your project.

		$is_needed = $this->hasConfigKey( 'is_needed' )
			? $this->getConfigKey( 'is_needed' )
			: false;

		// Return true if a callable 'is_needed' evaluates to true.
		if ( is_callable( $is_needed ) ) {
			return $is_needed( $context );
		}

		return (bool) $is_needed;
	}
}