Ubiquity\controllers\crud\CRUDControllerUtilitiesTrait

Complexity

Total Complexity

37

Size/Duplication

Total Lines	227
Duplicated Lines	0 %

Test Coverage

Coverage

68.79%

Importance

Changes

0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	_deleteMultiple()	0	21	5
A	_getModelViewer()	0	2	1
A	crudLoadView()	0	16	3
A	getSingleton()	0	5	2
A	_getFiles()	0	2	1
A	_getAdminData()	0	2	1
A	_getEvents()	0	2	1
A	_edit()	0	18	2
A	getModelInstance()	0	16	4
A	refreshInstance()	0	6	3
A	_showModel()	0	4	1
A	getInstanceToString()	0	6	2
A	updateMemberDataElement()	0	4	1
A	search()	0	4	1
A	_renderDataTableForRefresh()	0	5	1
A	getInstances()	0	16	4
A	getAdminData()	0	2	1
A	getFiles()	0	2	1
A	getModelViewer()	0	2	1
A	getEvents()	0	2	1

<?php

namespace Ubiquity\controllers\crud;

use Ubiquity\utils\http\URequest;
use Ubiquity\orm\DAO;
use Ubiquity\controllers\admin\viewers\ModelViewer;
use Ajax\semantic\widgets\datatable\Pagination;
use Ajax\common\html\HtmlContentOnly;
use Ubiquity\orm\OrmUtils;
use Ajax\semantic\html\collections\HtmlMessage;

/**
 * @author jc
 * @property int $activePage
 * @property string $model
 * @property \Ajax\php\ubiquity\JsUtils $jquery
 * @property \Ubiquity\views\View $view
 */
trait CRUDControllerUtilitiesTrait {
	abstract protected function _showSimpleMessage(CRUDMessage $message,$staticName=null):HtmlMessage;
	abstract public function loadView($viewName, $pData = NULL, $asString = false);
	abstract public function index();
	abstract public function _getBaseRoute();
	abstract protected function _showConfMessage(CRUDMessage $message,$url, $responseElement, $data, $attributes = NULL):HtmlMessage;

	protected $modelViewer;
	protected $adminDatas;
	protected $events;
	protected $crudFiles;
	
	protected function getInstances(&$totalCount,$page=1,$id=null){
		$this->activePage=$page;
		$model=$this->model;
		$condition=$this->_getAdminData()->_getInstancesFilter($model);
		$totalCount=DAO::count($model,$condition);
		if($totalCount){
			$recordsPerPage=$this->_getModelViewer()->recordsPerPage($model,$totalCount);
			if(is_numeric($recordsPerPage)){
				if(isset($id)){
					$rownum=DAO::getRownum($model, $id);
					$this->activePage=Pagination::getPageOfRow($rownum,$recordsPerPage);
				}
				return DAO::paginate($model,$this->activePage,$recordsPerPage,$condition);
			}
		}
		return DAO::getAll($model,$condition);
	}
	
	protected function search($model,$search){
		$fields=$this->_getAdminData()->getSearchFieldNames($model);
		$condition=$this->_getAdminData()->_getInstancesFilter($model);
		return CRUDHelper::search($model, $search, $fields,$condition);
	}
	
	/**
	 * @param mixed $ids
	 * @param boolean $included
	 * @return object
	 */
	private function getModelInstance($ids,$included=true) {
		$ids=\explode("_", $ids);
		if(!is_bool($included)){
			if(!is_array($included)){
				$included=[$included];
			}
		}
		$instance=DAO::getOne($this->model, $ids,$included);
		if(isset($instance)){
			return $instance;
		}
		$message=new CRUDMessage("This object does not exist!","Get object","warning","warning circle");
		$message=$this->_getEvents()->onNotFoundMessage($message,$ids);
		echo $this->_showSimpleMessage($message);
		echo $this->jquery->compile($this->view);
		exit(1);
	}
	
	protected function updateMemberDataElement($member,$instance){
		$dt=$this->_getModelViewer()->getModelDataElement($instance, $this->model, false);
		$dt->compile();
		echo new HtmlContentOnly($dt->getFieldValue($member));
	}
	
	private function _renderDataTableForRefresh($instances,$model,$totalCount){
		$compo= $this->_getModelViewer()->getModelDataTable($instances, $model,$totalCount)->refresh(["tbody"]);
		$this->_getEvents()->onDisplayElements($compo,$instances,true);
		$compo->setLibraryId("_compo_");
		$this->jquery->renderView("@framework/main/component.html");
	}

	protected function _edit($instance, $modal="no") {
		$_SESSION["instance"]=$instance;
		$modal=($modal == "modal");
		$form=$this->_getModelViewer()->getForm("frmEdit", $instance);
		$this->jquery->click("#action-modal-frmEdit-0", "$('#frmEdit').form('submit');", false);
		if (!$modal) {
			$this->jquery->click("#bt-cancel", "$('#form-container').transition('drop');");
			$this->jquery->compile($this->view);
			$this->loadView($this->_getFiles()->getViewForm(), [ "modal" => $modal,"instance"=>$instance,"isNew"=>$instance->_new ]);
		} else {
			$this->jquery->exec("$('#modal-frmEdit').modal('show');", true);
			$form=$form->asModal(\get_class($instance));
			$form->setActions([ "Okay","Cancel" ]);
			$btOkay=$form->getAction(0);
			$btOkay->addClass("green")->setValue("Validate modifications");
			$form->onHidden("$('#modal-frmEdit').remove();");
			echo $form->compile($this->jquery, $this->view);
			echo $this->jquery->compile($this->view);
		}
	}
	
	protected function _showModel($id=null) {
		$model=$this->model;
		$datas=$this->getInstances($totalCount,1,$id);
		return $this->_getModelViewer()->getModelDataTable($datas, $model,$totalCount,$this->activePage);
	}

	/**
	 * Helper to delete multiple objects
	 * @param mixed $data
	 * @param string $action
	 * @param string $target the css selector for refreshing
	 * @param callable|string $condition the callback for generating the SQL where (for deletion) with the parameter data, or a simple string
	 */
	protected function _deleteMultiple($data,$action,$target,$condition){
		if(URequest::isPost()){
			if(is_callable($condition)){
				$condition=$condition($data);
			}
			$rep=DAO::deleteAll($this->model, $condition);
			if($rep){
				$message=new CRUDMessage("Deleting {count} objects","Deletion","info","info circle",4000);
				$message=$this->_getEvents()->onSuccessDeleteMultipleMessage($message,$rep);
				$message->parseContent(["count"=>$rep]);
			}
			if(isset($message)){
				$this->_showSimpleMessage($message,"delete-all");
			}
			$this->index();
		}else{
			$message=new CRUDMessage("Do you confirm the deletion of this objects?", "Remove confirmation","error");
			$this->_getEvents()->onConfDeleteMultipleMessage($message,$data);
			$message=$this->_showConfMessage($message, $this->_getBaseRoute() . "/{$action}/{$data}",$target, $data,["jqueryDone"=>"replaceWith"]);
			echo $message;
			echo $this->jquery->compile($this->view);
		}
	}
	
	
	protected function refreshInstance($instance,$isNew){
		if($this->_getAdminData()->refreshPartialInstance() && !$isNew){
			$this->jquery->setJsonToElement(OrmUtils::objectAsJSON($instance));
		}else{
			$pk=OrmUtils::getFirstKeyValue($instance);
			$this->jquery->get($this->_getBaseRoute() . "/refreshTable/".$pk, "#lv", [ "jqueryDone" => "replaceWith" ]);
		}
	}
	
	/**
	 * To override for defining a new adminData
	 * @return CRUDDatas
	 */
	protected function getAdminData ():CRUDDatas{
		return new CRUDDatas();
	}
	
	public function _getAdminData ():CRUDDatas{
		return $this->getSingleton($this->adminDatas,"getAdminData");
	}
	
	/**
	 * To override for defining a new ModelViewer
	 * @return ModelViewer
	 */
	protected function getModelViewer ():ModelViewer{
		return new ModelViewer($this);
	}
	
	private function _getModelViewer():ModelViewer{
		return $this->getSingleton($this->modelViewer,"getModelViewer");
	}
	
	/**
	 * To override for changing view files
	 * @return CRUDFiles
	 */
	protected function getFiles ():CRUDFiles{
		return new CRUDFiles();
	}
	
	/**
	 * @return CRUDFiles
	 */
	public function _getFiles(){
		return $this->getSingleton($this->crudFiles,"getFiles");
	}
	
	/**
	 * To override for changing events
	 * @return CRUDEvents
	 */
	protected function getEvents ():CRUDEvents{
		return new CRUDEvents($this);
	}
	
	private function _getEvents():CRUDEvents{
		return $this->getSingleton($this->events,"getEvents");
	}
	
	private function getSingleton($value, $method) {
		if (! isset ( $value )) {
			$value = $this->$method ();
		}
		return $value;
	}
	
	private function crudLoadView($viewName,$vars=[]){
		$this->_getEvents()->beforeLoadView($viewName,$vars);
		if(!URequest::isAjax()){
			$files=$this->_getFiles();
			$mainTemplate=$files->getBaseTemplate();
			if(isset($mainTemplate)){
				$vars["_viewname"]=$viewName;
				$vars["_base"]=$mainTemplate;
				$this->jquery->renderView($files->getViewBaseTemplate(),$vars);
			}else{
				$vars["hasScript"]=true;
				$this->jquery->renderView($viewName,$vars);
			}
		}else{
			$vars["hasScript"]=true;
			$this->jquery->renderView($viewName,$vars);
		}
	}
	
	/**
	 * @param object $instance
	 * @return string
	 */
	protected function getInstanceToString($instance){
		if (method_exists($instance, "__toString")){
			return $instance . "";
		}
		else{
			return get_class($instance);
		}
	}
}