OxidEsales\EshopCommunity\Core\ViewHelper\JavaScriptRenderer Class Reference

Public Member Functions
	render ($widget, $forceRender, $isDynamic=false)

Protected Member Functions
	isAjaxRequest ()
	shouldForceRender ($forceRender, $isAjaxRequest)
	prepareFilesForRendering ($files, $widget)
	formFilesOutput ($includes, $widget)
	formSnippetsOutput ($scripts, $widgetName, $ajaxRequest)
	sanitize ($scripts)
	enclose ($scriptsOutput, $widget, $isAjaxRequest)

Detailed Description

Class for preparing JavaScript.

Member Function Documentation

enclose()

OxidEsales\EshopCommunity\Core\ViewHelper\JavaScriptRenderer::enclose (   $scriptsOutput,   $widget,   $isAjaxRequest  )

protected

Enclose with script tag or add in function for wiget.

Parameters

string	$scriptsOutput	javascript to be enclosed.
string	$widget	widget name.
bool	$isAjaxRequest	is ajax request

Returns

string

formFilesOutput()

OxidEsales\EshopCommunity\Core\ViewHelper\JavaScriptRenderer::formFilesOutput (   $includes,   $widget  )

protected

Form output for includes.

Parameters

array	$includes	String files to include.
string	$widget	Widget name.

Returns

string

formSnippetsOutput()

OxidEsales\EshopCommunity\Core\ViewHelper\JavaScriptRenderer::formSnippetsOutput (   $scripts,   $widgetName,   $ajaxRequest  )

protected

Forms how javascript should look like when output. If varnish is active, javascript should be passed to WidgetsHandler instead of direct call.

Parameters

array	$scripts	Scripts to execute (from add).
string	$widgetName	Widget name.
bool	$ajaxRequest	Is ajax request.

Returns

string

isAjaxRequest()

OxidEsales\EshopCommunity\Core\ViewHelper\JavaScriptRenderer::isAjaxRequest ( )

protected

Returns if it is ajax request.

Returns

bool

prepareFilesForRendering()

OxidEsales\EshopCommunity\Core\ViewHelper\JavaScriptRenderer::prepareFilesForRendering (   $files,   $widget  )

protected

Returns files list for rendering.

Parameters

array	$files
string	$widget

Returns

array

render()

OxidEsales\EshopCommunity\Core\ViewHelper\JavaScriptRenderer::render	(		$widget,
			$forceRender,
			$isDynamic = false
	)

Renders all registered JavaScript snippets and files.

Parameters

string	$widget	Widget name
bool	$forceRender	Force rendering of scripts.
bool	$isDynamic	Force rendering of scripts.

Returns

string

sanitize()

OxidEsales\EshopCommunity\Core\ViewHelper\JavaScriptRenderer::sanitize (   $scripts )

protected

Sanitize javascript, which will be passed to WidgetsHandler.

Parameters

string

$scripts

Returns

string

shouldForceRender()

OxidEsales\EshopCommunity\Core\ViewHelper\JavaScriptRenderer::shouldForceRender (   $forceRender,   $isAjaxRequest  )

protected

Returns whether rendering of scripts should be forced.

Parameters

bool	$forceRender
bool	$isAjaxRequest

Returns

bool

---

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

• /oxideshop-ce/source/Core/ViewHelper/JavaScriptRenderer.php