ConsoleHelpers\CodeInsight\BackwardsCompatibility\FunctionChecker

Complexity

Total Complexity

9

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getName()	0	4	1
B	doCheck()	0	28	3
A	getFunctionParameterSignature()	0	16	2
A	processFunction()	0	13	2

<?php
/**
 * This file is part of the Code-Insight 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/code-insight
 */

namespace ConsoleHelpers\CodeInsight\BackwardsCompatibility;


use Aura\Sql\ExtendedPdoInterface;

class FunctionChecker extends AbstractChecker
{

	/**
	 * Source function data.
	 *
	 * @var array
	 */
	protected $sourceFunctionData = array();

	/**
	 * Target function data.
	 *
	 * @var array
	 */
	protected $targetFunctionData = array();

	/**
	 * FunctionChecker constructor.
	 */
	public function __construct()
	{
		$this->defineIncidentGroups(array(
			'Function Deleted',
			'Function Signature Changed',
		));
	}

	/**
	 * Returns backwards compatibility checker name.
	 *
	 * @return string
	 */
	public function getName()
	{
		return 'function';
	}

	/**
	 * Collects backwards compatibility violations.
	 *
	 * @return void
	 */
	protected function doCheck()
	{
		$sql = 'SELECT Name, Id
				FROM Functions';
		$source_functions = $this->sourceDatabase->fetchAssoc($sql);
		$target_functions = $this->targetDatabase->fetchAssoc($sql);

		foreach ( $source_functions as $source_function_name => $source_function_data ) {
			if ( !isset($target_functions[$source_function_name]) ) {
				$this->addIncident('Function Deleted', $source_function_name);
				continue;
			}

			$this->sourceFunctionData = $source_function_data;
			$this->sourceFunctionData['ParameterSignature'] = $this->getFunctionParameterSignature(
				$this->sourceDatabase,
				$this->sourceFunctionData['Id']
			);

			$this->targetFunctionData = $target_functions[$source_function_name];
			$this->targetFunctionData['ParameterSignature'] = $this->getFunctionParameterSignature(
				$this->targetDatabase,
				$this->targetFunctionData['Id']
			);

			$this->processFunction();
		}
	}

	/**
	 * Calculates function parameter signature.
	 *
	 * @param ExtendedPdoInterface $db          Database.
	 * @param integer              $function_id Function ID.
	 *
	 * @return integer
	 */
	protected function getFunctionParameterSignature(ExtendedPdoInterface $db, $function_id)

Avoid variables with short names like $db. Configured minimum length is 3.

	{
		$sql = 'SELECT *
				FROM FunctionParameters
				WHERE FunctionId = :function_id
				ORDER BY Position ASC';
		$function_parameters = $db->fetchAll($sql, array('function_id' => $function_id));

		$hash_parts = array();

		foreach ( $function_parameters as $function_parameter_data ) {
			$hash_parts[] = $this->paramToString($function_parameter_data);
		}

		return implode(', ', $hash_parts);
	}

	/**
	 * Processes function.
	 *
	 * @return void
	 */
	protected function processFunction()
	{
		$function_name = $this->sourceFunctionData['Name'];

		if ( $this->sourceFunctionData['ParameterSignature'] !== $this->targetFunctionData['ParameterSignature'] ) {
			$this->addIncident(
				'Function Signature Changed',
				$function_name,
				$this->sourceFunctionData['ParameterSignature'],
				$this->targetFunctionData['ParameterSignature']
			);
		}
	}

}