MY_Controller

Complexity

Total Complexity

14

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

48.78%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	_render_json()	0	6	2
A	__construct()	0	20	3
A	_render_content()	0	8	2
A	_render_403()	0	7	1

<?php defined('BASEPATH') OR exit('No direct script access allowed');

class MY_Controller extends CI_Controller {
	protected $header_data = array();
	protected $body_data   = array();
	protected $footer_data = array();
	public    $global_data = array();

	public function __construct(){
		parent::__construct();

It seems like you code against a specific sub-type and not the parent class CI_Controller as the method __construct() does only exist in the following sub-classes of CI_Controller: AJAX_Controller, About, AdminCLI, AdminPanel, Admin_Controller, Auth_Controller, CLI_Controller, Dashboard, DashboardBeta, Favourites, Forgot_Password, FrontPage, GetKey, GetList, Help, History, Import_AMR, Login, Logout, MY_Controller, No_Auth_Controller, Options, PublicList, ReportIssue, Signup, Stats, TitleHistory, TrackerInline, UpdateStatus, User_Controller, UsernameCheck, Userscript, Welcome. Maybe you want to instanceof check for one of these explicitly?

		//FIXME: This is pretty much a phpUnit hack. Without it phpUnit fails here. We need a proper way to fake user/admin testing.
		$this->global_data['user'] = ($this->ion_auth->user() ? $this->ion_auth->user()->row() : ['username' => '']);
		$this->global_data['username'] = $this->User->username;

		$this->global_data['analytics_tracking_id'] = $this->config->item('tracking_id');

		$this->global_data['theme'] = $this->User_Options->get('theme');
		if(ENVIRONMENT === 'production') {
			$this->global_data['compiled_css_path'] = function () {
				$css_path = "css/main.{$this->global_data['theme']}";
				return asset_url() . $css_path . '.' . filemtime(APPPATH . "../public/assets/{$css_path}.css") . '.css';
			};

			$js_path = 'js/compiled.min';
			$this->global_data['compiled_js_path'] = asset_url() . $js_path . '.' . filemtime(APPPATH . "../public/assets/{$js_path}.js") . '.js';
		}
	}

	public function _render_page(/*(array) $paths*/) : void {
		$this->header_data['title'] = ($this->header_data['title'] !== 'Index' ? $this->header_data['title'].' - Manga Tracker' : 'Manga Tracker');

		//We could just use global, but this is the only var we need in both header+footer
		$this->footer_data['page'] = $this->header_data['page'];

		$this->header_data['show_header'] = (array_key_exists('show_header', $this->header_data) ? $this->header_data['show_header'] : TRUE);
		$this->footer_data['show_footer'] = (array_key_exists('show_footer', $this->footer_data) ? $this->footer_data['show_footer'] : TRUE);

		$this->global_data['notices'] = get_notices();

		//$this->output->enable_profiler(TRUE);

		$this->load->view('common/header', ($this->global_data + $this->header_data));
		foreach(func_get_args() as $path) {
			view_exists($path) or show_404(); //CHECK: Does this have a performance impact?

			$this->load->view($path, ($this->global_data + $this->body_data));
		}
		//using the union operator + makes sure global_data always takes priority
		//SEE: http://stackoverflow.com/a/2140094/1168377
		$this->load->view('common/footer', ($this->global_data + $this->footer_data));
	}
	public function _render_json($json_input, bool $download = FALSE, string $filenamePrefix = 'tracker') : void {
		$json = is_array($json_input) ? json_encode($json_input) : $json_input;

		$this->output->set_content_type('application/json', 'utf-8');
		$this->_render_content($json ?? '{}','json', $download, $filenamePrefix);
	}
	public function _render_content(string $content, string $filenameExt, bool $download = FALSE, string $filenamePrefix = 'tracker') : void {
		if($download) {
			$date = date('Ymd_Hi');
			$this->output->set_header('Content-Disposition: attachment; filename="'.$filenamePrefix.'-'.$date.'.'.$filenameExt.'"');
			$this->output->set_header('Content-Length: '.strlen($content));
		}
		$this->output->set_output($content);
	}
	public function _render_403(string $errorMessage = 'The user has insufficient permissions to perform that action.') : void {
		$this->output->set_status_header(403);

		$this->body_data['error_message'] = htmlspecialchars($errorMessage, ENT_QUOTES, 'UTF-8');

		$this->_render_page('common/403');
	}
}

class CLI_Controller extends CI_Controller {
	public function __construct() {
		parent::__construct();

It seems like you code against a specific sub-type and not the parent class CI_Controller as the method __construct() does only exist in the following sub-classes of CI_Controller: AJAX_Controller, About, AdminCLI, AdminPanel, Admin_Controller, Auth_Controller, CLI_Controller, Dashboard, DashboardBeta, Favourites, Forgot_Password, FrontPage, GetKey, GetList, Help, History, Import_AMR, Login, Logout, MY_Controller, No_Auth_Controller, Options, PublicList, ReportIssue, Signup, Stats, TitleHistory, TrackerInline, UpdateStatus, User_Controller, UsernameCheck, Userscript, Welcome. Maybe you want to instanceof check for one of these explicitly?

		//NOTE: This should fail, assuming routes.php does handles things properly.
		//      It's good to have "just in case" fallbacks though.
		is_cli() or exit('ERROR: This controller can only be called via command line: php index.php ...');
	}
}

/**** AUTH CONTROLLERS ****/
class User_Controller extends MY_Controller {
	public function __construct() {
		parent::__construct();

		$this->load->database();
	}
}

class Auth_Controller extends User_Controller {
	public function __construct(bool $redirect = TRUE) {
		parent::__construct();

		if(!$this->ion_auth->logged_in()) {
			if($redirect || $_SERVER['REQUEST_METHOD'] === 'GET') {
				$this->User->login_redirect();
				redirect('user/login');
			} else {
				$this->output->set_status_header(401, 'Session has expired, please re-log to continue.');
				exit_ci();
			}
		}
	}
}

class No_Auth_Controller extends User_Controller {
	public function __construct() {
		parent::__construct();

		if($this->ion_auth->logged_in()) redirect('/');
	}
}

class Admin_Controller extends Auth_Controller {
	public function __construct() {
		parent::__construct();

		if(!$this->ion_auth->is_admin()) {
			//user is not an admin, redirect them to front page
			//TODO (CHECK): Should we note that "you must be an admin to view this page"?

			redirect('/');
		}
	}
}

/**** AJAX CONTROLLERS ****/
class AJAX_Controller extends CI_Controller {
	public function __construct() {
		parent::__construct();

It seems like you code against a specific sub-type and not the parent class CI_Controller as the method __construct() does only exist in the following sub-classes of CI_Controller: AJAX_Controller, About, AdminCLI, AdminPanel, Admin_Controller, Auth_Controller, CLI_Controller, Dashboard, DashboardBeta, Favourites, Forgot_Password, FrontPage, GetKey, GetList, Help, History, Import_AMR, Login, Logout, MY_Controller, No_Auth_Controller, Options, PublicList, ReportIssue, Signup, Stats, TitleHistory, TrackerInline, UpdateStatus, User_Controller, UsernameCheck, Userscript, Welcome. Maybe you want to instanceof check for one of these explicitly?

		//TODO: general security stuff
	}

	public function _render_json($json_input) : void {
		$json = is_array($json_input) ? json_encode($json_input) : $json_input;

		$this->output->set_content_type('application/json', 'utf-8');
		$this->output->set_output($json);
	}
}