BaseHtmlEventsTrait::jsShow() - Code Metrics - Inspection of "Add DataTable partial refresh" - phpMv/phpMv-UI - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 468e47...0bebef )

by Jean-Christophe

created 2018-05-04 19:22 UTC

BaseHtmlEventsTrait::jsShow() A

↳ Parent: BaseHtmlEventsTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	2
rs	10
c	0
b	0
f	0

<?php
namespace Ajax\common\html\traits;
use Ajax\JsUtils;
use Ajax\service\AjaxCall;
use Ajax\service\Javascript;
use Ajax\common\html\BaseHtml;

/**
 * @author jc
 * @property \Ajax\common\components\SimpleExtComponent $_bsComponent
 * @property string identifier
 * @property BaseHtml _self
 */
trait BaseHtmlEventsTrait{

	protected $_events=array ();

	/**
	 * @param string $event
	 * @param string|AjaxCall $jsCode
	 * @param boolean $stopPropagation
	 * @param boolean $preventDefault
	 * @return BaseHtml
	 */
	public function addEvent($event, $jsCode, $stopPropagation=false, $preventDefault=false) {
		if ($stopPropagation === true) {
			$jsCode=Javascript::$stopPropagation . $jsCode;
		}
		if ($preventDefault === true) {
			$jsCode=Javascript::$preventDefault . $jsCode;
		}
		return $this->_addEvent($event, $jsCode);
	}
	
	public function trigger($event,$params="[]"){
		$this->executeOnRun('$("#'.$this->identifier.'").trigger("'.$event.'",'.$params.');');
	}
	
	public function jsTrigger($event,$params="[this]"){
		return $this->jsDoJquery("trigger",["'".$event."'",$params]);
	}

	/**
	 * @param string $event
	 * @param string|AjaxCall $jsCode
	 * @return BaseHtml
	 */
	public function _addEvent($event, $jsCode) {
		if (array_key_exists($event, $this->_events)) {
			if (\is_array($this->_events[$event])) {
				if(array_search($jsCode, $this->_events[$event])===false){
					$this->_events[$event][]=$jsCode;
				}
			} else {
				$this->_events[$event]=array ($this->_events[$event],$jsCode );
			}
		} else {
			$this->_events[$event]=$jsCode;
		}
		return $this;
	}

	/**
	 * @param string $event
	 * @param string $jsCode
	 * @param boolean $stopPropagation
	 * @param boolean $preventDefault
	 * @return BaseHtml
	 */
	public function on($event, $jsCode, $stopPropagation=false, $preventDefault=false) {
		return $this->_self->addEvent($event, $jsCode, $stopPropagation, $preventDefault);
	}

	public function onClick($jsCode, $stopPropagation=false, $preventDefault=true) {
		return $this->on("click", $jsCode, $stopPropagation, $preventDefault);
	}

	public function setClick($jsCode) {
		return $this->onClick($jsCode);
	}

	public function onCreate($jsCode){
		if(isset($this->_events["_create"])){
			$this->_events["_create"][]=$jsCode;
		}else{
			$this->_events["_create"]=[$jsCode];
		}
		return $this;
	}

	public function addEventsOnRun(JsUtils $js=NULL) {
		$this->_eventsOnCreate($js);
		if (isset($this->_bsComponent)) {
			foreach ( $this->_events as $event => $jsCode ) {
				$code=$jsCode;
				if (\is_array($jsCode)) {
					$code="";
					foreach ( $jsCode as $jsC ) {
						if ($jsC instanceof AjaxCall) {
							$code.="\n" . $jsC->compile($js);
						} else {
							$code.="\n" . $jsC;
						}
					}
				} elseif ($jsCode instanceof AjaxCall) {
					$code=$jsCode->compile($js);
				}
				$this->_bsComponent->addEvent($event, $code);
			}
			$this->_events=array ();
			return $this->_bsComponent->getScript();
		}
		return "";
	}

	protected function _eventsOnCreate(JsUtils $js=NULL){
		if(isset($this->_events["_create"])){
			$create=$this->_events["_create"];
			if(\is_array($create)){
				$create=\implode("", $create);
			}
			if(isset($js) && $create!=="")
				$js->exec($create,true);
			unset($this->_events["_create"]);
		}
	}

	/**
	 * @param string $operation http method get, post, postForm or json
	 * @param string $event the event that triggers the request
	 * @param string $url The url of the request
	 * @param string $responseElement The selector of the HTML element displaying the answer
	 * @param array $parameters default : array("preventDefault"=>true,"stopPropagation"=>true,"params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"immediatly"=>true,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>null,"headers"=>null,"historize"=>false)
	 * @return $this
	 */
	public function _ajaxOn($operation, $event, $url, $responseElement="", $parameters=array()) {
		$params=array ("url" => $url,"responseElement" => $responseElement );
		$params=array_merge($params, $parameters);
		$this->_addEvent($event, new AjaxCall($operation, $params));
		return $this;
	}

	/**
	 * Performs a get to $url on the event $event on $element
	 * and display it in $responseElement
	 * @param string $event the event that triggers the get request
	 * @param string $url The url of the request
	 * @param string $responseElement The selector of the HTML element displaying the answer
	 * @param array $parameters default : array("preventDefault"=>true,"stopPropagation"=>true,"params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"immediatly"=>true,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>null,"headers"=>null,"historize"=>false)
	 * @return $this
	 **/
	public function getOn($event, $url, $responseElement="", $parameters=array()) {
		return $this->_ajaxOn("get", $event, $url, $responseElement, $parameters);
	}

	/**
	 * Performs a get to $url on the click event on $element
	 * and display it in $responseElement
	 * @param string $url The url of the request
	 * @param string $responseElement The selector of the HTML element displaying the answer
	 * @param array $parameters default : array("preventDefault"=>true,"stopPropagation"=>true,"params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"immediatly"=>true,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>null,"headers"=>null,"historize"=>false)
	 * @return $this
	 **/
	public function getOnClick($url, $responseElement="", $parameters=array()) {
		return $this->getOn("click", $url, $responseElement, $parameters);
	}

	/**
	 * Performs a post to $url on the event $event on $element
	 * and display it in $responseElement
	 * @param string $event the event that triggers the post request
	 * @param string $url The url of the request
	 * @param string $params the request parameters in JSON format
	 * @param string $responseElement The selector of the HTML element displaying the answer
	 * @param array $parameters default : array("preventDefault"=>true,"stopPropagation"=>true,"params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"immediatly"=>true,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>null,"headers"=>null,"historize"=>false)
	 * @return $this
	 **/
	public function postOn($event, $url, $params="{}", $responseElement="", $parameters=array()) {
		$allParameters=[];
		if(isset($parameters["params"])){
			$allParameters[]=JsUtils::_correctParams($parameters["params"]);
		}
		if(isset($params)){
			$allParameters[]=JsUtils::_correctParams($params);
		}
		$parameters["params"]=\implode("+'&'+", $allParameters);
		return $this->_ajaxOn("post", $event, $url, $responseElement, $parameters);
	}
	
	/**
	 * Performs a post to $url on the click event on $element
	 * and display it in $responseElement
	 * @param string $url The url of the request
	 * @param string $params the request parameters in JSON format
	 * @param string $responseElement The selector of the HTML element displaying the answer
	 * @param array $parameters default : array("preventDefault"=>true,"stopPropagation"=>true,"params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"immediatly"=>true,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>null,"headers"=>null,"historize"=>false)
	 * @return $this
	 **/
	public function postOnClick($url, $params="{}", $responseElement="", $parameters=array()) {
		return $this->postOn("click", $url, $params, $responseElement, $parameters);
	}

	/**
	 * Performs a post form with ajax
	 * @param string $event the event that triggers the post request
	 * @param string $url The url of the request
	 * @param string $form The form HTML id
	 * @param string $responseElement selector of the HTML element displaying the answer
	 * @param array $parameters default : array("params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>NULL,"headers"=>null,"historize"=>false)
	 * @return $this
	 */
	public function postFormOn($event, $url, $form, $responseElement="", $parameters=array()) {
		$parameters["form"]=$form;
		return $this->_ajaxOn("postForm", $event, $url, $responseElement, $parameters);
	}

	/**
	 * Performs a post form with ajax on click
	 * @param string $url The url of the request
	 * @param string $form The form HTML id
	 * @param string $responseElement selector of the HTML element displaying the answer
	 * @param array $parameters default : array("params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>NULL,"headers"=>null,"historize"=>false)
	 * @return $this
	 */
	public function postFormOnClick($url, $form, $responseElement="", $parameters=array()) {
		return $this->postFormOn("click", $url, $form, $responseElement, $parameters);
	}

	public function jsDoJquery($jqueryCall, $param="") {
		return "$('#" . $this->identifier . "')." . $jqueryCall . "(" . Javascript::prep_value($param) . ");";
	}

	public function executeOnRun($jsCode) {
		return $this->_addEvent("execute", $jsCode);
	}

	public function jsHtml($content="") {
		return $this->jsDoJquery("html", $content);
	}

	public function jsShow() {
		return $this->jsDoJquery("show");
	}

	public function jsHide() {
		return $this->jsDoJquery("hide");
	}

	public function jsToggle($value) {
		return $this->jsDoJquery("toggle",$value);
	}
	/**
	 * @return array
	 */
	public function getEvents() {
		return $this->_events;
	}

}


1			<?php
2			namespace Ajax\common\html\traits;
3			use Ajax\JsUtils;
4			use Ajax\service\AjaxCall;
5			use Ajax\service\Javascript;
6			use Ajax\common\html\BaseHtml;
7
8			/**
9			* @author jc
10			* @property \Ajax\common\components\SimpleExtComponent $_bsComponent
11			* @property string identifier
12			* @property BaseHtml _self
13			*/
14			trait BaseHtmlEventsTrait{
15
16			protected $_events=array ();
17
18			/**
19			* @param string $event
20			* @param string\|AjaxCall $jsCode
21			* @param boolean $stopPropagation
22			* @param boolean $preventDefault
23			* @return BaseHtml
24			*/
25			public function addEvent($event, $jsCode, $stopPropagation=false, $preventDefault=false) {
26			if ($stopPropagation === true) {
27			$jsCode=Javascript::$stopPropagation . $jsCode;
28			}
29			if ($preventDefault === true) {
30			$jsCode=Javascript::$preventDefault . $jsCode;
31			}
32			return $this->_addEvent($event, $jsCode);
33			}
34
35			public function trigger($event,$params="[]"){
36			$this->executeOnRun('$("#'.$this->identifier.'").trigger("'.$event.'",'.$params.');');
37			}
38
39			public function jsTrigger($event,$params="[this]"){
40			return $this->jsDoJquery("trigger",["'".$event."'",$params]);
41			}
42
43			/**
44			* @param string $event
45			* @param string\|AjaxCall $jsCode
46			* @return BaseHtml
47			*/
48			public function _addEvent($event, $jsCode) {
49			if (array_key_exists($event, $this->_events)) {
50			if (\is_array($this->_events[$event])) {
51			if(array_search($jsCode, $this->_events[$event])===false){
52			$this->_events[$event][]=$jsCode;
53			}
54			} else {
55			$this->_events[$event]=array ($this->_events[$event],$jsCode );
56			}
57			} else {
58			$this->_events[$event]=$jsCode;
59			}
60			return $this;
61			}
62
63			/**
64			* @param string $event
65			* @param string $jsCode
66			* @param boolean $stopPropagation
67			* @param boolean $preventDefault
68			* @return BaseHtml
69			*/
70			public function on($event, $jsCode, $stopPropagation=false, $preventDefault=false) {
71			return $this->_self->addEvent($event, $jsCode, $stopPropagation, $preventDefault);
72			}
73
74			public function onClick($jsCode, $stopPropagation=false, $preventDefault=true) {
75			return $this->on("click", $jsCode, $stopPropagation, $preventDefault);
76			}
77
78			public function setClick($jsCode) {
79			return $this->onClick($jsCode);
80			}
81
82			public function onCreate($jsCode){
83			if(isset($this->_events["_create"])){
84			$this->_events["_create"][]=$jsCode;
85			}else{
86			$this->_events["_create"]=[$jsCode];
87			}
88			return $this;
89			}
90
91			public function addEventsOnRun(JsUtils $js=NULL) {
92			$this->_eventsOnCreate($js);
93			if (isset($this->_bsComponent)) {
94			foreach ( $this->_events as $event => $jsCode ) {
95			$code=$jsCode;
96			if (\is_array($jsCode)) {
97			$code="";
98			foreach ( $jsCode as $jsC ) {
99			if ($jsC instanceof AjaxCall) {
100			$code.="\n" . $jsC->compile($js);
101			} else {
102			$code.="\n" . $jsC;
103			}
104			}
105			} elseif ($jsCode instanceof AjaxCall) {
106			$code=$jsCode->compile($js);
107			}
108			$this->_bsComponent->addEvent($event, $code);
109			}
110			$this->_events=array ();
111			return $this->_bsComponent->getScript();
112			}
113			return "";
114			}
115
116			protected function _eventsOnCreate(JsUtils $js=NULL){
117			if(isset($this->_events["_create"])){
118			$create=$this->_events["_create"];
119			if(\is_array($create)){
120			$create=\implode("", $create);
121			}
122			if(isset($js) && $create!=="")
123			$js->exec($create,true);
124			unset($this->_events["_create"]);
125			}
126			}
127
128			/**
129			* @param string $operation http method get, post, postForm or json
130			* @param string $event the event that triggers the request
131			* @param string $url The url of the request
132			* @param string $responseElement The selector of the HTML element displaying the answer
133			* @param array $parameters default : array("preventDefault"=>true,"stopPropagation"=>true,"params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"immediatly"=>true,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>null,"headers"=>null,"historize"=>false)
134			* @return $this
135			*/
136			public function _ajaxOn($operation, $event, $url, $responseElement="", $parameters=array()) {
137			$params=array ("url" => $url,"responseElement" => $responseElement );
138			$params=array_merge($params, $parameters);
139			$this->_addEvent($event, new AjaxCall($operation, $params));
140			return $this;
141			}
142
143			/**
144			* Performs a get to $url on the event $event on $element
145			* and display it in $responseElement
146			* @param string $event the event that triggers the get request
147			* @param string $url The url of the request
148			* @param string $responseElement The selector of the HTML element displaying the answer
149			* @param array $parameters default : array("preventDefault"=>true,"stopPropagation"=>true,"params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"immediatly"=>true,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>null,"headers"=>null,"historize"=>false)
150			* @return $this
151			**/
152			public function getOn($event, $url, $responseElement="", $parameters=array()) {
153			return $this->_ajaxOn("get", $event, $url, $responseElement, $parameters);
154			}
155
156			/**
157			* Performs a get to $url on the click event on $element
158			* and display it in $responseElement
159			* @param string $url The url of the request
160			* @param string $responseElement The selector of the HTML element displaying the answer
161			* @param array $parameters default : array("preventDefault"=>true,"stopPropagation"=>true,"params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"immediatly"=>true,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>null,"headers"=>null,"historize"=>false)
162			* @return $this
163			**/
164			public function getOnClick($url, $responseElement="", $parameters=array()) {
165			return $this->getOn("click", $url, $responseElement, $parameters);
166			}
167
168			/**
169			* Performs a post to $url on the event $event on $element
170			* and display it in $responseElement
171			* @param string $event the event that triggers the post request
172			* @param string $url The url of the request
173			* @param string $params the request parameters in JSON format
174			* @param string $responseElement The selector of the HTML element displaying the answer
175			* @param array $parameters default : array("preventDefault"=>true,"stopPropagation"=>true,"params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"immediatly"=>true,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>null,"headers"=>null,"historize"=>false)
176			* @return $this
177			**/
178			public function postOn($event, $url, $params="{}", $responseElement="", $parameters=array()) {
179			$allParameters=[];
180			if(isset($parameters["params"])){
181			$allParameters[]=JsUtils::_correctParams($parameters["params"]);
182			}
183			if(isset($params)){
184			$allParameters[]=JsUtils::_correctParams($params);
185			}
186			$parameters["params"]=\implode("+'&'+", $allParameters);
187			return $this->_ajaxOn("post", $event, $url, $responseElement, $parameters);
188			}
189
190			/**
191			* Performs a post to $url on the click event on $element
192			* and display it in $responseElement
193			* @param string $url The url of the request
194			* @param string $params the request parameters in JSON format
195			* @param string $responseElement The selector of the HTML element displaying the answer
196			* @param array $parameters default : array("preventDefault"=>true,"stopPropagation"=>true,"params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"immediatly"=>true,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>null,"headers"=>null,"historize"=>false)
197			* @return $this
198			**/
199			public function postOnClick($url, $params="{}", $responseElement="", $parameters=array()) {
200			return $this->postOn("click", $url, $params, $responseElement, $parameters);
201			}
202
203			/**
204			* Performs a post form with ajax
205			* @param string $event the event that triggers the post request
206			* @param string $url The url of the request
207			* @param string $form The form HTML id
208			* @param string $responseElement selector of the HTML element displaying the answer
209			* @param array $parameters default : array("params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>NULL,"headers"=>null,"historize"=>false)
210			* @return $this
211			*/
212			public function postFormOn($event, $url, $form, $responseElement="", $parameters=array()) {
213			$parameters["form"]=$form;
214			return $this->_ajaxOn("postForm", $event, $url, $responseElement, $parameters);
215			}
216
217			/**
218			* Performs a post form with ajax on click
219			* @param string $url The url of the request
220			* @param string $form The form HTML id
221			* @param string $responseElement selector of the HTML element displaying the answer
222			* @param array $parameters default : array("params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>NULL,"headers"=>null,"historize"=>false)
223			* @return $this
224			*/
225			public function postFormOnClick($url, $form, $responseElement="", $parameters=array()) {
226			return $this->postFormOn("click", $url, $form, $responseElement, $parameters);
227			}
228
229			public function jsDoJquery($jqueryCall, $param="") {
230			return "$('#" . $this->identifier . "')." . $jqueryCall . "(" . Javascript::prep_value($param) . ");";
231			}
232
233			public function executeOnRun($jsCode) {
234			return $this->_addEvent("execute", $jsCode);
235			}
236
237			public function jsHtml($content="") {
238			return $this->jsDoJquery("html", $content);
239			}
240
241			public function jsShow() {
242			return $this->jsDoJquery("show");
243			}
244
245			public function jsHide() {
246			return $this->jsDoJquery("hide");
247			}
248
249			public function jsToggle($value) {
250			return $this->jsDoJquery("toggle",$value);
251			}
252			/**
253			* @return array
254			*/
255			public function getEvents() {
256			return $this->_events;
257			}
258
259			}
260

phpMv / phpMv-UI

Push — master ( 468e47...0bebef )

BaseHtmlEventsTrait::jsShow() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like