Epesi\Core\UI

Complexity

Total Complexity

19

Size/Duplication

Total Lines	278
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	renderException()	0	14	3
A	packageInfo()	0	5	1
A	jsRedirectConfirm()	0	5	1
A	jsRedirectHomepage()	0	15	2
A	addCsrfToken()	0	5	1
A	addFavIcon()	0	3	1
A	enablePjax()	0	32	1
A	render()	0	15	1
A	__construct()	0	8	1
A	initIncludes()	0	41	1
A	module()	0	3	1
A	response()	0	3	1
A	setLocation()	0	5	1
A	addJs()	0	3	1
A	requireJs()	0	13	2

<?php 

namespace Epesi\Core;

use Epesi\Core\System\Modules\Concerns\HasLinks;
use Epesi\Core\System\Modules\ModuleManager;
use Illuminate\Session\TokenMismatchException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

class UI extends \atk4\ui\App
{
	use HasLinks;
	
	public $version = '2.0.0-alpha1';
	
	public $cdn = [
			'semantic-ui'      => 'https://cdn.jsdelivr.net/npm/fomantic-ui@2.7.2/dist',
	];
	
	public $always_run = false;
	
	protected $url_building_ext = '';
	
	public function __construct($defaults = [])
	{
		parent::__construct([
				'title' => config('epesi.ui.title', 'EPESI'),
		        'cdn' => array_merge($this->cdn, (array) config('epesi.ui.cdn')),
				//TODO: set the skin from admin / user selection
		        'skin' => config('epesi.ui.skin', $this->skin),
		        'template_dir' => array_merge(ModuleManager::collect('templates', [$this->skin]), (array) $this->template_dir),
// 		        'catch_error_types' => config('app.debug') ? 
// 		                  // debug mode
// 		                  E_ALL & ~E_NOTICE & ~E_DEPRECATED & ~E_USER_DEPRECATED : 
// 		                  // production mode
// 		                  E_ERROR | E_PARSE | E_CORE_ERROR | E_COMPILE_ERROR | E_USER_ERROR
		]);
	}
	
	final public static function module()
	{
	    return System\SystemCore::class;
	}
	
	public function response()
	{
		return response($this->render());
	}
	
// 	public function getViewJS($actions)
// 	{
// 		$ready = new jsFunction($actions);
		
// 		return "<script page-pjax>\n".
// 				(new jQuery($ready))->jsRender().
// 				'</script>';
// 	}
	
	public function render()
	{			
	    System\SystemCore::requireCSS('epesi.css');
	    
		$this->addCsrfToken();
		
		$this->addFavIcon();
		
// 		$this->enablePjax();
		
		ob_start();
		
		$this->run();
		
		return ob_get_clean();
	}
	
	/**
	 * Handles / renders exceptions
	 * 
	 * @param \Exception $exception
	 * @return string
	 */
	public function renderException($exception)
	{
	    ob_start();
	    if ($exception instanceof TokenMismatchException) {
	        $this->jsRedirectHomepage(__('Session expired! Redirecting to login screen ...'));

It seems like __('Session expired! Redirecting to login screen ...') can also be of type array; however, parameter $message of Epesi\Core\UI::jsRedirectHomepage() does only seem to accept string, maybe add an additional type check?

	    }
	    elseif ($exception instanceof NotFoundHttpException) {
	        $this->jsRedirectHomepage(__('Requested page not found! Redirecting to your home page ...'));
	    }	    
	    else {
	        $this->caughtException($exception);
	    }
	    
	    return ob_get_clean();
	}
	
	/**
	 * Redirects to epesi homepage
	 * 
	 * @param string $message
	 */
	public function jsRedirectHomepage($message)
	{
	    $homepageUrl = url(HomePage\Model\HomePage::pathOfUser());
	    
	    $redirectJs = $this->jsRedirectConfirm($homepageUrl, $message)->jsRender();
	    
	    if ($this->isJsonRequest()) {

The method isJsonRequest() does not exist on Epesi\Core\UI. Since you implemented __call, consider adding a @method annotation.

	        $this->outputResponseJSON([
	                'success'   => true,
	                'message'   => $message,
	                'atkjs'   => $redirectJs
	        ]);
	    }
	    else {
	        $this->outputResponseHTML($this->getTag('script', $redirectJs));
	    }
	}
	
	/**
	 * Displays confirmation dialog and redirects to $page
	 * 
	 * @param string $page
	 * @param string $message
	 * @return \atk4\ui\JsExpression
	 */
	public function jsRedirectConfirm($page, $message)
	{
	    $redirectJs = $this->jsRedirect($page)->jsRender();
	    
	    return new \atk4\ui\JsExpression("if (confirm([])) { $redirectJs }", [$message]);
	}
	
	/**
	 * Initialize JS and CSS includes.
	 */
	public function initIncludes()
	{
// 		$this->requireJS(asset('js/app.js'));
// 		$this->requireCSS(asset('css/app.css'));
				
		//TODO: include below in app.js and app.css
		
		$localJs = url('storage/system/js');
		$localCss = url('storage/system/css');
		
		// jQuery
		$urlJs = $this->cdn['jquery']?? $localJs;
		$this->requireJS($urlJs.'/jquery.min.js');
		
		// Semantic UI
		$urlJs = $this->cdn['semantic-ui']?? $localJs;
		$urlCss = $this->cdn['semantic-ui']?? $localCss;
		$this->requireJS($urlJs.'/semantic.min.js');
		$this->requireCSS($urlCss.'/semantic.min.css');
		
		// Serialize Object
		$urlJs = $this->cdn['serialize-object']?? $localJs;
		$this->requireJS($urlJs.'/jquery.serialize-object.min.js');
		
		// Agile UI
		$urlJs = $this->cdn['atk']?? $localJs;
		$urlCss = $this->cdn['atk']?? $localCss;
		$this->requireJS($urlJs.'/atkjs-ui.min.js');
		$this->requireCSS($urlCss.'/agileui.css');
		
		// Draggable
		$urlJs = $this->cdn['draggable']?? $localJs;
		$this->requireJS($urlJs.'/draggable.bundle.js');
		
		// jQuery niceScroll	
		$urlJs = $this->cdn['jquery-nicescroll']?? $localJs;
		$this->requireJS($urlJs.'/jquery.nicescroll.js');
		
		// clipboard.js
		$urlJs = $this->cdn['clipboardjs']?? $localJs;
		$this->requireJS($urlJs.'/clipboard.js');
	}
	
	/**
	 * Add Laravel required csrf token to the page
	 */
	public function addCsrfToken()
	{
		$this->html->template->appendHTML('meta', $this->getTag('meta', ['name' => 'csrf-token', 'content' => csrf_token()]));

The function atk4\ui\HtmlTemplate::appendHtml() has been deprecated: use "dangerouslyAppendHtml" method instead - will be removed in v2.5

array('name' => 'csrf-token', 'content' => csrf_token()) of type array<string,string> is incompatible with the type string expected by parameter $attr of atk4\ui\App::getTag().

		$this->addJS('$.ajaxSetup({
			headers: {
				\'X-CSRF-TOKEN\': $(\'meta[name="csrf-token"]\').attr(\'content\')
			}
		})');
	}
	
	/**
	 * Adds the favicon set in config
	 */
	public function addFavIcon()
	{
		$this->html->template->appendHTML('HEAD', $this->getTag('link', ['rel' => 'shortcut icon', 'href' => config('epesi.ui.favicon', url('favicon.png'))]));

array('rel' => 'shortcut icon', 'href' => config('epesi.ui.favicon', url('favicon.png'))) of type array<string,mixed|string> is incompatible with the type string expected by parameter $attr of atk4\ui\App::getTag().

The function atk4\ui\HtmlTemplate::appendHtml() has been deprecated: use "dangerouslyAppendHtml" method instead - will be removed in v2.5

	}
	
	public function enablePjax()
	{
		// pjax library
// 		$this->requireJS('https://cdn.jsdelivr.net/npm/pjax/pjax.js');
		
// 		$this->html->template->appendHTML('HEAD', '<script>
// 			$(function(){
// 				var pjax = new Pjax({
// 						"elements": ".pjax", 
// 						"selectors": [".atk-layout", "head > script[page-pjax]", "head > title"]
// 				});
// 			});
			
// 		</script>');
		
		// pjax-api library
		$this->requireJS('https://cdn.jsdelivr.net/npm/pjax-api@latest');

		$this->html->template->appendHTML('HEAD', '<script>

The function atk4\ui\HtmlTemplate::appendHtml() has been deprecated: use "dangerouslyAppendHtml" method instead - will be removed in v2.5

			$(function(){		
				const { Pjax } = require("pjax-api");		
				new Pjax({
						"links": ".pjax", 
						"areas": [".atk-layout", "head > script[page-pjax]", "head > title"]
				});
			});
			
		</script>');

		// common
		$this->addJs('$(".pjax").click(function(e) {
				window.onbeforeunload(e);
				
				if (e.returnValue == "unsaved" && ! confirm("Unsaved data. Continue?")) {
 					e.stopImmediatePropagation();
					window.stop();
 				}
		});');		
	}
	
	public function addJs($js, $args = [])
	{
		$this->html->js(true, new \atk4\ui\JsExpression($js, $args));
	}

	/**
	 * Override default method to make sure js script is included only once
	 * 
	 * {@inheritDoc}
	 * @see \atk4\ui\App::requireJS()
	 */
	public function requireJs($url, $isAsync = false, $isDefer = false)
	{
		static $cache;
		
		$key = md5(serialize(func_get_args()));
		
		if (! isset($cache[$key])) {
			$cache[$key] = true;
			
			parent::requireJS($url, $isAsync, $isDefer);
		}
				
		return $this;
	}
		
	/**
	 * Set the breadcrumb location
	 * 
	 * @param array|string $location
	 * @return null
	 */
	public function setLocation($location)
	{
		$this->layout->setLocation($location);

The method setLocation() does not exist on atk4\ui\Layout. It seems like you code against a sub-type of atk4\ui\Layout such as Epesi\Core\Layout\LayoutView.

		
		return $this;

The expression return $this returns the type Epesi\Core\UI which is incompatible with the documented return type null.

	}
	
	public function packageInfo()
	{
		$content = file_get_contents(__DIR__ . '/../composer.json');
		
		return json_decode($content, true);
	}
}