JsUtils Class Reference

Inheritance diagram for JsUtils:

Public Member Functions
	inline ($script, $cdata=true)
	Outputs a <script> tag.
	getUrl ($url)
	Generates an URL Used internally by phpMv.
	addViewElement ($identifier, $content, &$view)
	Adds the array of controls q in the $view element Used internally by phpMv.
	createScriptVariable (&$view, $view_var, $output)
	Creates the script variable script_foot Used internally by phpMv.
	forward ($initialController, $controller, $action, $params=array())
	Forwards to.
	renderContent ($initialControllerInstance, $viewName, $params=NULL)
	render the content of an existing view : $viewName and set the response to the modal content Used internally by phpMv
	fromDispatcher ($dispatcher)
	Collects url parts from the request dispatcher : controllerName, actionName, parameters Used internally by phpMv.
	renderView ($viewName, $parameters=[], $asString=false)
	Performs jQuery compilation and displays a view.
	renderDefaultView ($parameters=[], $asString=false)
	Performs jQuery compilation and displays the default view.
	execJSFromFile ($jsFile, $parameters=[], $immediatly=true)
	Loads and eventually executes a jsFile with php parameters, using the default template engine.
	ajaxValidationRule (string $ruleName, string $checkUrl, string $params='{_value:value}', string $method='post')
	Adds a new semantic validation ajax rule.
	checkValidationRule ($callback)
	Checks a validation rule declared with @ajaxValidationRule.
Public Member Functions inherited from JsUtils
	ui (JqueryUI $ui=NULL)
	getter or setter of the jQuery-UI variable
	bootstrap (Bootstrap $bootstrap=NULL)
	getter or setter of the Twitter Bootstrap variable
	semantic (Semantic $semantic=NULL)
	getter or setter of the Semantic-UI variable
	config ($config=NULL)
	__construct ($params=array(), $injected=NULL)
	__set ($property, $value)
	getParam ($key)
	output ($array_js)
	Outputs the called javascript to the screen.
	compile (&$view=NULL, $view_var='script_foot', $script_tags=TRUE)
	gather together all script needing to be output
	clear_compile ()
	Clears the array of script events collected for output.
	getScript ($offset=0)
	scriptCount ()
	generate_json ($result=NULL, $match_array_type=FALSE)
	Can be passed a database result or associative array and returns a JSON formatted string.
	_prep_args ($result, $is_key=FALSE)
	Ensures a standard json value and escapes values.
	_add_event ($element, $js, $event, $preventDefault=false, $stopPropagation=false, $immediatly=true, $listenerOn=false)
	Constructs the syntax for an event, and adds to into the array for compilation.
	getInjected ()
	setParam (string $param, $value)
Public Member Functions inherited from JsUtilsEventsTrait
	blur ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library blur event.
	change ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library change event.
	click ($element='this', $js='', $ret_false=TRUE, $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library click event.
	contextmenu ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library contextmenu event.
	dblclick ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library dblclick event.
	error ($element='this', $js='')
	Outputs a javascript library error event.
	focus ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library focus event.
	hover ($element='this', $over='', $out='')
	Outputs a javascript library hover event.
	keydown ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library keydown event.
	keypress ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library keypress event.
	keyup ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library keydown event.
	load ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library load event.
	mousedown ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library mousedown event.
	mouseout ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library mouseout event.
	mouseleave ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library mouseleave event.
	mouseenter ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library mouseenter event.
	mouseover ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library mouseover event.
	mouseup ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library mouseup event.
	unload ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library unload event.
	resize ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library resize event.
	scroll ($element='this', $js='', $preventDefault=false, $stopPropagation=false, $listenerOn=false)
	Outputs a javascript library scroll event.
Public Member Functions inherited from JsUtilsActionsTrait
	_genericCallValue ($jQueryCall, $element='this', $param="", $immediatly=false)
	Execute a generic jQuery call with a value.
	_genericCallElement ($jQueryCall, $to='this', $element='', $immediatly=false)
	Execute a generic jQuery call with 2 elements.
	addClass ($element='this', $class='', $immediatly=false)
	add class to element
	after ($to, $element, $immediatly=false)
	Insert content, specified by the parameter, after each element in the set of matched elements.
	before ($to, $element, $immediatly=false)
	Insert content, specified by the parameter, before each element in the set of matched elements.
	attr ($element='this', $attributeName='id', $value="", $immediatly=false)
	Get or set the value of an attribute for the first element in the set of matched elements or set one or more attributes for every matched element.
	val ($element='this', $value='', $immediatly=false)
	Get or set the value of the first element in the set of matched elements or set one or more attributes for every matched element.
	html ($element='this', $value='', $immediatly=false)
	Get or set the html of an attribute for the first element in the set of matched elements.
	animate ($element='this', $params=array(), $speed='', $extra='', $immediatly=false)
	Outputs a javascript library animate event.
	append ($to, $element, $immediatly=false)
	Insert content, specified by the parameter $element, to the end of each element in the set of matched elements $to.
	prepend ($to, $element, $immediatly=false)
	Insert content, specified by the parameter $element, to the beginning of each element in the set of matched elements $to.
	fadeIn ($element='this', $speed='', $callback='', $immediatly=false)
	Execute a javascript library hide action.
	fadeOut ($element='this', $speed='', $callback='', $immediatly=false)
	Execute a javascript library hide action.
	slideUp ($element='this', $speed='', $callback='', $immediatly=false)
	Execute a javascript library slideUp action.
	removeClass ($element='this', $class='', $immediatly=false)
	Execute a javascript library removeClass action.
	slideDown ($element='this', $speed='', $callback='', $immediatly=false)
	Execute a javascript library slideDown action.
	slideToggle ($element='this', $speed='', $callback='', $immediatly=false)
	Execute a javascript library slideToggle action.
	hide ($element='this', $speed='', $callback='', $immediatly=false)
	Execute a javascript library hide action.
	toggle ($element='this', $speed='', $callback='', $immediatly=false)
	Execute a javascript library toggle action.
	toggleClass ($element='this', $class='', $immediatly=false)
	Execute a javascript library toggle class action.
	trigger ($element='this', $event='click', $immediatly=false)
	Execute all handlers and behaviors attached to the matched elements for the given event.
	show ($element='this', $speed='', $callback='', $immediatly=false)
	Execute a javascript library show action.
	sortable ($element, $options=array())
	Creates a jQuery sortable.
	tablesorter ($table='', $options='')
	Table Sorter Plugin.
	condition ($condition, $jsCodeIfTrue, $jsCodeIfFalse=null, $immediatly=false)
	Allows to attach a condition.
	doJQuery ($element, $jqueryCall, $param="", $jsCallback="")
	Calls the JQuery callback $someThing on $element with facultative parameter $param.
	doJQueryDeferred ($element, $jqueryCall, $param="", $jsCallback="")
	Calls the JQuery callback $someThing on $element with facultative parameter $param.
	doJQueryOn ($event, $element, $elementToModify, $jqueryCall, $param="", $parameters=array())
	Calls the JQuery callback $jqueryCall on $element with facultative parameter $param in response to an event $event.
	exec ($js, $immediatly=false)
	Executes the code $js.
	execAtLast ($js)
	Executes the code $js.
	execOn ($event, $element, $js, $parameters=array())
	Executes the javascript code $js when $event fires on $element.
	setJsonToElement ($json, $elementClass="_element", $immediatly=true)
	setDraggable ($element, $parameters=[])
	Sets an element draggable (HTML5 drag and drop)
	asDropZone ($element, $jsCallback="", $parameters=[])
	Declares an element as a drop zone (HTML5 drag and drop)
	interval ($jsCode, $time, $globalName=null, $immediatly=true)
	Calls a function or evaluates an expression at specified intervals (in milliseconds)
	clearInterval ($globalName, $immediatly=true)
	Clears an existing interval.
	counter ($counterSelector, $value=0, $limit=0, $globalName=null, $countDown=true, $immediatly=true)
	Associates a counter to the element designated by $counterSelector Triggers the events counter-start and counter-end on finished with the parameters value and limit.
	counterOn ($element, $event, $counterSelector, $value=0, $limit=0, $globalName=null, $countDown=true)
	Associates a counter to the element designated by $counterSelector when $event is triggered on $element.
	activateLink ($target, $property='href', $href=null)
	Activates an element if it is active (add the class active)
	_activateLink ($target, $property='href', $href=null)
	Returns the javascript code for activate an element if it is active (add the class active)
Public Member Functions inherited from JsUtilsAjaxTrait
	interval ($jsCode, $time, $globalName=null, $immediatly=true)
	setAjaxLoader ($loader)
	get ($url, $responseElement='', $parameters=[])
	Performs an ajax GET request.
	ajax ($method, $url, $responseElement='', $parameters=[])
	Performs an ajax request.
	ajaxInterval ($method, $url, $interval, $globalName=null, $responseElement='', $parameters=[], $immediatly=true)
	Executes an ajax query at regular intervals.
	ajaxDeferred ($method, $url, $responseElement='', $parameters=[])
	Performs a deferred ajax request.
	json ($url, $method="get", $parameters=[])
	Performs an ajax request and receives the JSON data types by assigning DOM elements with the same name.
	jsonOn ($event, $element, $url, $method='get', $parameters=array())
	Makes an ajax request and receives the JSON data types by assigning DOM elements with the same name when $event fired on $element.
	jsonDeferred ($url, $method='get', $parameters=[])
	Prepares an ajax request delayed and receives the JSON data types by assigning DOM elements with the same name.
	jsonArray ($maskSelector, $url, $method='get', $parameters=[])
	Performs an ajax request and receives the JSON array data types by assigning DOM elements with the same name.
	jsonArrayDeferred ($maskSelector, $url, $method='get', $parameters=[])
	Peforms an ajax request delayed and receives a JSON array data types by copying and assigning them to the DOM elements with the same name.
	jsonArrayOn ($event, $element, $maskSelector, $url, $method='get', $parameters=array())
	Performs an ajax request and receives the JSON array data types by assigning DOM elements with the same name when $event fired on $element.
	getDeferred ($url, $responseElement="", $parameters=[])
	Prepares a Get ajax request for using on an event.
	getOn ($event, $element, $url, $responseElement="", $parameters=array())
	Performs a get to $url on the event $event on $element and display it in $responseElement.
	ajaxOn ($event, $element, $url, $responseElement='', $parameters=array())
	Performs an ajax request to $url on the event $event on $element and display it in $responseElement.
	ajaxOnClick ($element, $url, $responseElement='', $parameters=array())
	Performs a get to $url on the click event on $element and display it in $responseElement.
	getOnClick ($element, $url, $responseElement='', $parameters=array())
	Performs a get to $url on the click event on $element and display it in $responseElement.
	getHref ($element, $responseElement="", $parameters=array())
	Uses an hyperlink to make an ajax get request.
	postHref ($element, $responseElement="", $parameters=array())
	Uses an hyperlink to make an ajax get request.
	postFormAction ($element, $responseElement="", $parameters=array())
	Uses a form action to make an ajax post request.
	post ($url, $params="{}", $responseElement="", $parameters=[])
	Makes an ajax post.
	postDeferred ($url, $params="{}", $responseElement="", $parameters=[])
	Prepares a delayed ajax POST to use on an event.
	postOn ($event, $element, $url, $params="{}", $responseElement="", $parameters=array())
	Performs a post to $url on the event $event fired on $element and pass the parameters $params Display the result in $responseElement.
	postOnClick ($element, $url, $params='{}', $responseElement='', $parameters=array())
	Performs a post to $url on the click event fired on $element and pass the parameters $params Display the result in $responseElement.
	postForm ($url, $form, $responseElement, $parameters=[])
	Performs a post form with ajax.
	postFormDeferred ($url, $form, $responseElement, $parameters=[])
	Performs a delayed post form with ajax For use on an event.
	postFormOn ($event, $element, $url, $form, $responseElement="", $parameters=array())
	Performs a post form with ajax in response to an event $event on $element display the result in $responseElement.
	postFormOnClick ($element, $url, $form, $responseElement="", $parameters=array())
	Performs a post form with ajax in response to the click event on $element display the result in $responseElement.
	addCsrf ($name='csrf-token')
Public Member Functions inherited from JsUtilsInternalTrait
	addToCompile ($jsScript)

Static Public Member Functions
static	diSemantic ($controller, $options=['defer'=> true, 'gc'=> true])
	Returns an instance of JsUtils initialized with Semantic (for di injection)
static	diBootstrap ($controller, $options=['defer'=> true, 'gc'=> true])
	Returns an instance of JsUtils initialized with Bootstrap (for di injection)
Static Public Member Functions inherited from JsUtilsAjaxTrait
static	_correctParams ($params, $ajaxParameters=[])
static	_implodeParams ($parameters)

Protected Member Functions
	_open_script ($src='')
	Outputs an opening <script>
Protected Member Functions inherited from JsUtils
	initialize ()
	To override for special initialization of the component.
Protected Member Functions inherited from JsUtilsActionsTrait
	_showHideWithEffect ($action, $element='this', $speed='', $callback='', $immediatly=false)
	show or hide with effect
Protected Member Functions inherited from JsUtilsAjaxTrait
	_ajax ($method, $url, $responseElement='', $parameters=[])
	createAjaxParameters (&$original, $parameters)
	implodeAjaxParameters ($ajaxParameters)
	_addJsCondition ($jsCondition, $jsSource)
	_getAjaxUrl ($url, $attr)
	onPopstate ()
	autoActiveLinks ($previousURL="window.location.href")
	_getOnAjaxDone ($responseElement, $jqueryDone, $ajaxTransition, $jsCallback, $history=null)
	removeLoader ($hasLoader)
	_getResponseElement ($responseElement)
	_getFormElement ($formElement)
	_correctAjaxUrl ($url)
	addLoading (&$retour, $responseElement, $ajaxLoader=null)
	addResponseLoading (&$retour, $responseElement, $ajaxLoader=null)
	setAjaxDataCall ($params)
	setDefaultParameters (&$parameters, $default)
Protected Member Functions inherited from JsUtilsInternalTrait
	_addToCompile ($jsScript)
	_compileLibrary (BaseGui $library, &$view=NULL)
	defer ($script)
	ready ($script)
	minify ($input)
	_close_script ($extra="\n")
	Outputs an closing </script>
	conflict ()

Additional Inherited Members
Protected Attributes inherited from JsUtils
	$params
	$injected
	$_ui
	$_bootstrap
	$_semantic
	$config
Protected Attributes inherited from JsUtilsEventsTrait
	$jquery_events
Protected Attributes inherited from JsUtilsAjaxTrait
	$ajaxTransition
	$ajaxLoader = "<div class=\"ui active centered inline text loader\">Loading</div>"
Protected Attributes inherited from JsUtilsInternalTrait
	$jquery_code_for_compile = array()
	$jquery_code_for_compile_at_last = array()

Detailed Description

Definition at line 10 of file JsUtils.php.

Member Function Documentation

_open_script()

_open_script (   $src = '' )

protected

Outputs an opening <script>

Parameters

string

$src

Returns

string

Reimplemented from JsUtilsInternalTrait.

Definition at line 18 of file JsUtils.php.

addViewElement()

addViewElement	(		$identifier,
			$content,
		&	$view
	)

Adds the array of controls q in the $view element Used internally by phpMv.

Parameters

string	$identifier
string	$content
object	$view

Reimplemented from JsUtils.

Definition at line 40 of file JsUtils.php.

ajaxValidationRule()

ajaxValidationRule	(	string	$ruleName,
		string	$checkUrl,
		string	$params = '{_value:value}',
		string	$method = 'post'
	)

Adds a new semantic validation ajax rule.

To use with @checkValidationRule in controllers.

Parameters

string	$ruleName
string	$checkUrl
string	$params
string	$method

Returns

void

Definition at line 160 of file JsUtils.php.

checkValidationRule()

checkValidationRule

(

$callback

)

Checks a validation rule declared with @ajaxValidationRule.

Parameters

$callback

a callback using the value to validate : function($value){}

Returns

void

Definition at line 169 of file JsUtils.php.

createScriptVariable()

createScriptVariable	(	&	$view,
			$view_var,
			$output
	)

Creates the script variable script_foot Used internally by phpMv.

Parameters

object	$view
string	$view_var	default: script_foot
string	$output

Reimplemented from JsUtils.

Definition at line 49 of file JsUtils.php.

diBootstrap()

static diBootstrap (   $controller,   $options = [ 'defer' => true, 'gc' => true ]  )

static

Returns an instance of JsUtils initialized with Bootstrap (for di injection)

Parameters

\Ubiquity\controllers\Controller	$controller
array	$options

Returns

\Ajax\php\ubiquity\JsUtils

Definition at line 141 of file JsUtils.php.

diSemantic()

static diSemantic (   $controller,   $options = [ 'defer' => true, 'gc' => true ]  )

static

Returns an instance of JsUtils initialized with Semantic (for di injection)

Parameters

\Ubiquity\controllers\Controller	$controller
array	$options

Returns

\Ajax\php\ubiquity\JsUtils

Definition at line 124 of file JsUtils.php.

execJSFromFile()

execJSFromFile	(		$jsFile,
			$parameters = [],
			$immediatly = true
	)

Loads and eventually executes a jsFile with php parameters, using the default template engine.

Parameters

string	$jsFile
array	$parameters
boolean	$immediatly

Returns

string|null

Exceptions

Exception

Definition at line 106 of file JsUtils.php.

forward()

forward	(		$initialController,
			$controller,
			$action,
			$params = array()
	)

Forwards to.

$controller::$action and set the response to the modal content Used internally by phpMv

Parameters

object	$initialController
string	$controller	a controller
string	$action	an action
array	$params

Reimplemented from JsUtils.

Definition at line 53 of file JsUtils.php.

fromDispatcher()

fromDispatcher

(

$dispatcher

)

Collects url parts from the request dispatcher : controllerName, actionName, parameters Used internally by phpMv.

Parameters

mixed

$dispatcher

Returns

array

Reimplemented from JsUtils.

Definition at line 61 of file JsUtils.php.

getUrl()

getUrl

(

$url

)

Generates an URL Used internally by phpMv.

Parameters

string

$url

Returns

string the generated url

Reimplemented from JsUtils.

Definition at line 36 of file JsUtils.php.

inline()

inline	(		$script,
			$cdata = true
	)

Outputs a <script> tag.

Parameters

string	$script
boolean	$cdata	If a CDATA section should be added

Returns

string

Reimplemented from JsUtils.

Definition at line 28 of file JsUtils.php.

renderContent()

renderContent	(		$initialControllerInstance,
			$viewName,
			$params = NULL
	)

render the content of an existing view : $viewName and set the response to the modal content Used internally by phpMv

Parameters

object	$initialControllerInstance
string	$viewName
array	$params	The parameters to pass to the view

Reimplemented from JsUtils.

Definition at line 57 of file JsUtils.php.

renderDefaultView()

renderDefaultView	(		$parameters = [],
			$asString = false
	)

Performs jQuery compilation and displays the default view.

Parameters

mixed	$parameters	Variable or associative array to pass to the view If a variable is passed, it will have the name $ data </ b> in the view, If an associative array is passed, the view retrieves variables from the table's key names
boolean	$asString	If true, the view is not displayed but returned as a string (usable in a variable)

Definition at line 93 of file JsUtils.php.

renderView()

renderView	(		$viewName,
			$parameters = [],
			$asString = false
	)

Performs jQuery compilation and displays a view.

Parameters

string	$viewName
mixed	$parameters	Variable or associative array to pass to the view If a variable is passed, it will have the name $ data </ b> in the view, If an associative array is passed, the view retrieves variables from the table's key names
boolean	$asString	If true, the view is not displayed but returned as a string (usable in a variable)

Definition at line 75 of file JsUtils.php.

---

The documentation for this class was generated from the following file:

• Ajax/php/ubiquity/JsUtils.php