EventEspresso\core\services\progress_steps\ProgressStepManager

Complexity

Total Complexity

18

Size/Duplication

Total Lines	175
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes	2
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	17	3
B	setDisplayStrategy()	0	29	4
A	setDefaultStep()	0	6	2
B	setCurrentStep()	0	22	5
A	currentStep()	0	3	1
A	nextStep()	0	3	1
A	enqueueStylesAndScripts()	0	3	1
A	displaySteps()	0	7	1

<?php
namespace EventEspresso\core\services\progress_steps;

use EE_Request;
use EventEspresso\Core\Exceptions\InvalidClassException;
use EventEspresso\Core\Exceptions\InvalidDataTypeException;
use EventEspresso\Core\Exceptions\InvalidIdentifierException;
use EventEspresso\Core\Exceptions\InvalidInterfaceException;
use EventEspresso\core\services\collections\Collection;
use EventEspresso\core\services\collections\CollectionInterface;
use EventEspresso\core\services\progress_steps\display_strategies\ProgressStepsDisplayInterface;

if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
	exit( 'No direct script access allowed' );
}



/**
 * Class ProgressStepManager
 * Description
 *
 * @package       Event Espresso
 * @subpackage    core
 * @author        Brent Christensen
 * @since         $VID:$
 */
class ProgressStepManager {

	/**
	 * @var ProgressStepInterface[] $collection
	 */
	protected $collection;

	/**
	 * @var string $default_step
	 */
	protected $default_step;

	/**
	 * @var ProgressStepsDisplayInterface $display_strategy
	 */
	protected $display_strategy;

	/**
	 * @var EE_Request $request
	 */
	protected $request;



	/**
	 * ProgressStepManager constructor
	 *
	 * @param string              $display_strategy_name
	 * @param string              $default_step
	 * @param CollectionInterface $collection
	 * @param \EE_Request         $request
	 * @throws InvalidClassException
	 * @throws InvalidDataTypeException
	 * @throws InvalidInterfaceException
	 */
	public function __construct(
		$display_strategy_name = 'number_bubbles',
		$default_step = '',
		CollectionInterface $collection = null,
		EE_Request $request = null
	) {
		$this->setDisplayStrategy( $display_strategy_name );
		$this->setDefaultStep( $default_step );
		if ( ! $collection instanceof CollectionInterface ) {
			$collection = new Collection( '\EventEspresso\core\services\progress_steps\ProgressStepInterface' );
		}
		$this->collection = $collection;

It seems like $collection of type object<EventEspresso\core\services\collections\CollectionInterface> is incompatible with the declared type array<integer,object<EventEspresso\core\services\progress_steps\ProgressStepInterface>> of property $collection.

		if ( ! $request instanceof EE_Request ) {
			$request = \EE_Registry::instance()->load_core( 'Request' );
		}
		$this->request = $request;

It seems like $request can also be of type boolean. However, the property $request is declared as type object<EE_Request>. Maybe add an additional type check?

	}



	/**
	 * @param string $display_strategy_name
	 * @throws InvalidDataTypeException
	 * @throws InvalidClassException
	 */
	protected function setDisplayStrategy( $display_strategy_name = 'number_bubbles' ) {
		if ( ! is_string( $display_strategy_name ) ) {
			throw new InvalidDataTypeException( '$display_strategy_name', $display_strategy_name, 'string' );
		}
		// build up FQCN from incoming display strategy folder name
		$display_strategy_class = 'EventEspresso\core\services\progress_steps\display_strategies\\';
		$display_strategy_class .= $display_strategy_name . '\\';
		$display_strategy_class .= str_replace( ' ', '', ucwords( str_replace( '_', ' ', $display_strategy_name ) ) );
		$display_strategy_class .= 'ProgressStepsDisplay';
		$display_strategy_class = apply_filters(
			'FHEE__ProgressStepManager__setDisplayStrategy__display_strategy_class',
			$display_strategy_class
		);
		if ( ! class_exists( $display_strategy_class ) ) {
			throw new InvalidClassException( $display_strategy_class );
		}
		$display_strategy = new $display_strategy_class();
		if ( ! $display_strategy instanceof ProgressStepsDisplayInterface ) {
			throw new InvalidClassException(
				$display_strategy_class,
				sprintf(
					__( 'The "%1$s" Class needs to be an implementation of the "%1$s" Interface.', 'event_espresso' ),
					$display_strategy_class,
					'\EventEspresso\core\services\progress_steps\display_strategies\ProgressStepsDisplayInterface'
				)
			);
		}
		$this->display_strategy = $display_strategy;
	}



	/**
	 * @param string $default_step
	 * @throws InvalidDataTypeException
	 */
	public function setDefaultStep( $default_step ) {
		if ( ! is_string( $default_step ) ) {
			throw new InvalidDataTypeException( '$default_step', $default_step, 'string' );
		}
		$this->default_step = $default_step;
	}



	/**
	 * @param string $step
	 * @throws \EventEspresso\Core\Exceptions\InvalidIdentifierException
	 */
	public function setCurrentStep( $step = '' ) {
		// use incoming value if it's set, otherwise use request param if it's set, otherwise use default
		$step = ! empty( $step )
			? $step
			: $this->request->get( 'ee-step', $this->default_step );
		// grab the step previously known as current, in case we need to revert
		$current_current_step = $this->collection->current();

The method current cannot be called on $this->collection (of type array<integer,object<EventEspresso\core\services\progress_steps\ProgressStepInterface>>).

		// verify that requested step exists
		if ( ! $this->collection->has( $step ) ) {

The method has cannot be called on $this->collection (of type array<integer,object<EventEspresso\core\services\progress_steps\ProgressStepInterface>>).

			throw new InvalidIdentifierException( $step, $this->default_step );
		}
		if ( $this->collection->setCurrent( $step ) ) {

The method setCurrent cannot be called on $this->collection (of type array<integer,object<EventEspresso\core\services\progress_steps\ProgressStepInterface>>).

			// if the old boss is the same as the new boss, then nothing changes
			if ( $this->collection->current() !== $current_current_step ) {

The method current cannot be called on $this->collection (of type array<integer,object<EventEspresso\core\services\progress_steps\ProgressStepInterface>>).

				$current_current_step->setIsCurrent( false );
			}
			$this->collection->current()->setIsCurrent();

The method current cannot be called on $this->collection (of type array<integer,object<EventEspresso\core\services\progress_steps\ProgressStepInterface>>).

		} else {
			$this->collection->setCurrent( $current_current_step->id() );

The method setCurrent cannot be called on $this->collection (of type array<integer,object<EventEspresso\core\services\progress_steps\ProgressStepInterface>>).

			$current_current_step->setIsCurrent( true );
		}
	}



	/**
	 * @return ProgressStepInterface
	 */
	public function currentStep() {
		return $this->collection->current();

The method current cannot be called on $this->collection (of type array<integer,object<EventEspresso\core\services\progress_steps\ProgressStepInterface>>).

	}



	/**
	 * @return ProgressStepInterface
	 */
	public function nextStep() {
		return $this->collection->next();

The method next cannot be called on $this->collection (of type array<integer,object<EventEspresso\core\services\progress_steps\ProgressStepInterface>>).

	}



	/**
	 * @return void
	 */
	public function enqueueStylesAndScripts() {
		$this->display_strategy->enqueueStylesAndScripts();
	}



	/**
	 * echos out HTML
	 *
	 * @return void
	 */
	public function displaySteps() {
		echo \EEH_Template::display_template(
			$this->display_strategy->getTemplate(),
			array( 'progress_steps' => $this->collection ),
			true
		);
	}

}

// End of file ProgressStepManager.php
// Location: core/services/progress_steps/ProgressStepManager.php