App\Controller\Base

Complexity

Total Complexity

5

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	loginRequired()	0	4	1
	process()	0	1	?
	validateRequest()	0	1	?
	preProcess()	0	1	?
	postProcess()	0	1	?
	preProcessAjax()	0	1	?
	postProcessAjax()	0	1	?
A	sendHeaders()	0	4	1
A	exceptionErrorHandler()	0	4	1

<?php
/**
 * Base controller class.
 *
 * @copyright YetiForce Sp. z o.o.
 * @license   YetiForce Public License 3.0 (licenses/LicenseEN.txt or yetiforce.com)
 * @author    Mariusz Krzaczkowski <m.krzaczkowski@yetiforce.com>
 */

namespace App\Controller;

use App\Request;

abstract class Base

Base does not seem to conform to the naming convention (^Abstract|Factory$).

{
	/** @var \App\Headers Headers instance. */
	public $headers;

	/** @var Request Request object. */
	protected $request;

	/** @var string Module name. */
	protected $moduleName;

	/**
	 * Construct.
	 *
	 * @param \App\Request $request
	 */
	public function __construct(Request $request)
	{
		$this->headers = \App\Controller\Headers::getInstance();

It seems like \App\Controller\Headers::getInstance() of type object<App\Controller\Headers> is incompatible with the declared type object<App\Headers> of property $headers.

		if (\App\Config::get('csrfProtection')) {
			require_once ROOT_DIRECTORY . '/config/csrf_config.php';
			\CsrfMagic\Csrf::init();
		}
		$this->request = $request;
		$this->moduleName = $request->getModule();
	}

	/**
	 * Login required.
	 *
	 * @return bool
	 */
	public function loginRequired(): bool

function loginRequired() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

	{
		return true;
	}

	/**
	 * Main action.
	 *
	 * @return void
	 */
	abstract public function process();

	/**
	 * Validates request. Checks type of request.
	 *
	 * @return void
	 */
	abstract public function validateRequest();

	/**
	 * Action invoke before process.
	 *
	 * @return void
	 */
	abstract public function preProcess();

	/**
	 * Action invoke after process.
	 *
	 * @return void
	 */
	abstract public function postProcess();

	/**
	 * Action invoke before process for AJAX.
	 *
	 * @return void
	 */
	abstract public function preProcessAjax();

	/**
	 * Action invoke after process for AJAX.
	 *
	 * @return void
	 */
	abstract public function postProcessAjax();

	/**
	 * Send headers.
	 */
	public function sendHeaders()
	{
		$this->headers->send();
	}

	/**
	 * Error handler.
	 *
	 * @param string $errno

Should the type for parameter $errno not be integer?

	 * @param string $errstr
	 * @param string $errfile
	 * @param string $errline
	 * @param string $errcontext
	 *
	 * @return void

Consider making the return type a bit more specific; maybe use NoType.

	 */
	public static function exceptionErrorHandler(int $errno, string $errstr, $errfile, $errline, $errcontext)

The parameter $errfile is not used and could be removed.

The parameter $errline is not used and could be removed.

The parameter $errcontext is not used and could be removed.

	{
		throw new \App\Exceptions\AppException($errstr, $errno);
	}
}