Asparagus\UsageValidator

Complexity

Total Complexity

16

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	3
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	trackUsedVariables()	0	7	2
A	trackDefinedVariables()	0	7	2
A	trackUsedPrefixes()	0	7	2
A	trackDefinedPrefixes()	0	7	2
A	matchVariables()	0	3	1
A	matchPrefixes()	0	3	1
A	validate()	0	4	1
A	validatePrefixes()	0	6	2
A	validateVariables()	0	6	2

<?php

namespace Asparagus;

use RangeException;

/**
 * Package-private class to validate the usage of variables and prefixes.
 *
 * @license GNU GPL v2+
 * @author Bene* < benestar.wikimedia@gmail.com >
 */
class UsageValidator {

	/**
	 * @var string[] list of used variables without prefixes
	 */
	private $usedVariables = array();

	/**
	 * @var string[] list of defined variables without prefixes
	 */
	private $definedVariables = array();

	/**
	 * @var string[] list of used prefixes
	 */
	private $usedPrefixes = array();

	/**
	 * @var string[] list of defined prefixes
	 */
	private $definedPrefixes = array();

	/**
	 * @var RegexHelper
	 */
	private $regexHelper;

	public function __construct() {
		$this->regexHelper = new RegexHelper();
	}

	/**
	 * Trackes the list of variables as used.
	 *
	 * @param string[]|string $variables list of variables without prefixes
	 */
	public function trackUsedVariables( $variables ) {
		if ( !is_array( $variables ) ) {
			$variables = $this->matchVariables( $variables );
		}

		$this->usedVariables = array_unique( array_merge( $this->usedVariables, $variables ) );

It seems like array_unique(array_merge($this->usedVariables, $variables)) of type array is incompatible with the declared type array<integer,string> of property $usedVariables.

	}

	/**
	 * Trackes the list of variables as defined.
	 *
	 * @param string[]|string $variables list of variables without prefixes
	 */
	public function trackDefinedVariables( $variables )  {
		if ( !is_array( $variables ) ) {
			$variables = $this->matchVariables( $variables );
		}

		$this->definedVariables = array_unique( array_merge( $this->definedVariables, $variables ) );

It seems like array_unique(array_merge($this->definedVariables, $variables)) of type array is incompatible with the declared type array<integer,string> of property $definedVariables.

	}

	/**
	 * Trackes the list of prefixes as used.
	 *
	 * @param string[]|string $prefixes list of prefixes
	 */
	public function trackUsedPrefixes( $prefixes )  {
		if ( !is_array( $prefixes ) ) {
			$prefixes = $this->matchPrefixes( $prefixes );
		}

		$this->usedPrefixes = array_merge( $this->usedPrefixes, $prefixes );

It seems like array_merge($this->usedPrefixes, $prefixes) of type array is incompatible with the declared type array<integer,string> of property $usedPrefixes.

	}

	/**
	 * Trackes the list of prefixes as defined.
	 *
	 * @param string[]|string $prefixes list of prefixes
	 */
	public function trackDefinedPrefixes( $prefixes )  {
		if ( !is_array( $prefixes ) ) {
			$prefixes = $this->matchPrefixes( $prefixes );
		}

		$this->definedPrefixes = array_merge( $this->definedPrefixes, $prefixes );

It seems like array_merge($this->definedPrefixes, $prefixes) of type array is incompatible with the declared type array<integer,string> of property $definedPrefixes.

	}

	private function matchVariables( $expression ) {
		return $this->regexHelper->getMatches( '(^|\W)(?<!AS )\{variable}', $expression, 2 );
	}

	private function matchPrefixes( $expression ) {
		return $this->regexHelper->getMatches( '(^|\W)(\{prefix}):\{name}', $expression, 2 );
	}

	/**
	 * Validates the variables and prefixes tracked.
	 *
	 * @throws RangeException
	 */
	public function validate() {
		$this->validatePrefixes();
		$this->validateVariables();
	}

	private function validatePrefixes() {
		$diff = array_diff( $this->usedPrefixes, $this->definedPrefixes );
		if ( !empty( $diff ) ) {
			throw new RangeException( 'The prefixes ' . implode( ', ', $diff ) . ' aren\'t defined for this query.' );
		}
	}

	private function validateVariables() {
		$diff = array_diff( $this->usedVariables, $this->definedVariables );
		if ( !empty( $diff ) ) {
			throw new RangeException( 'The variables ?' . implode( ', ?', $diff ) . ' don\'t occur in this query.' );
		}
	}

}