SES\DataChecker

Complexity

Total Complexity

10

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getError()	0	3	1
A	run()	0	11	2
A	getUserDataValue()	0	9	3
A	addCheck()	0	3	1
A	runChecks()	0	6	2
A	error()	0	3	1
	populateData()	0	1	?

<?php

namespace SES;

use Exception;

/**
 * An abstract data getter and checker class.
 * Its concrete subclasses should incapsulate all the necessary data getting
 * and environment checks.
 *
 * @license GNU GPL v3+
 * @since 1.0
 *
 * @author Serhii Kutnii
 */
abstract class DataChecker {

	private $mError = null;

	// Checks
	private $mEnvCheckCalls = array();

	public function getError() {
		return $this->mError;
	}

	public function run() {
		try
		{
			$this->populateData();
			$this->runChecks();
		}
		catch ( Exception $e )
		{
			$this->mError = $e->getMessage();
		}
	}

 	/*

There is some trailing whitespace on this line which should be avoided as per coding-style.

 	 * Get a value from the request.
 	 * $err_message_id specifies an error that should be thrown
 	 * if the value is empty
 	 */
 	protected function getUserDataValue( $id, $err_message_id = null ) {
 		global $wgRequest;
 		$value = $wgRequest->getText( $id );

 		if ( $err_message_id && !$value )
 			$this->error( wfMessage( $err_message_id )->plain() );

 		return $value;
 	}

	protected function addCheck( $method_callback, array $args ) {
		$this->mEnvCheckCalls[] = array( $method_callback, $args );
	}

	protected function runChecks() {
		foreach ( $this->mEnvCheckCalls as $call_array )
		{
			call_user_func_array( $call_array[0], $call_array[1] );
		}
	}

	// Abstracting error calls in order to make this functionality changeable in subclasses
	protected function error( $message ) {
		throw new Exception( $message );
	}

	abstract protected function populateData();

}