Skip to content

[#31203] The one way and the one container for store the script options #1319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Fedik wants to merge 9 commits into from
Closed

[#31203] The one way and the one container for store the script options #1319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b33d982
set/get script options
Fedik Jun 15, 2013
b820822
render script options
Fedik Jun 15, 2013
ab4e87d
rename to JoptionsStorage
Fedik Jun 15, 2013
2bb8da3
use Joomla.optionsStorage
Fedik Jun 21, 2013
1ea535c
use JSON_PRETtY_PRINT when debug enabled
Fedik Jun 22, 2013
8f664da
fix typo _scripts_options => _script_options
Fedik Jun 22, 2013
13afa04
fix typo
Fedik Jun 22, 2013
b993100
fix another typo
Fedik Jun 22, 2013
74f90c0
Merge branch 'master' into scrip-options-storage
Fedik Feb 8, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions libraries/joomla/document/document.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,13 @@ class JDocument
*/
public $_script = array();

/**
* Array of scripts options
*
* @var array
*/
public $_script_options = array();

/**
* Array of linked style sheets
*
Expand Down Expand Up @@ -526,6 +533,40 @@ public function addScriptDeclaration($content, $type = 'text/javascript')
return $this;
}

/**
* Add option for script
*
* @param string $name a full extension name e.g. plg_name, com_name
* @param array $options - scrip options as array
*
* @return JDocument instance of $this to allow chaining
*
*/
public function setScriptOptions($options, $name)
{
$this->_script_options[$name] = $options;
return $this;
}

/**
* Get script(s) options
*
* @param string $name a full extension name e.g. plg_name, com_name
*
* @return array that contain optios for script/extension by name or all options
*
*/
public function getScriptOptions($name = null)
{
if ($name)
{
return (empty($this->_script_options[$name])) ? array() : $this->_script_options[$name];
}
else {
return $this->_script_options;
}
}

/**
* Adds a linked stylesheet to the page
*
Expand Down
19 changes: 19 additions & 0 deletions libraries/joomla/document/html/renderer/head.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ public function fetchHead($document)
$app = JFactory::getApplication();
$app->triggerEvent('onBeforeCompileHead');

// Whether debug enabled
$debug = JFactory::getConfig()->get('debug');

// Get line endings
$lnEnd = $document->_getLineEnd();
$tab = $document->_getTab();
Expand Down Expand Up @@ -195,6 +198,22 @@ public function fetchHead($document)
$buffer .= '></script>' . $lnEnd;
}

// Generate scripts options
if (!empty($document->_script_options))
{
$buffer .= $tab . '<script type="text/javascript">' . $lnEnd;
//TODO: use .extend(Joomla.optionsStorage, options)
//when it will be safe
$buffer .= $tab . 'var Joomla = Joomla || {};' . $lnEnd;
$buffer .= $tab . 'Joomla.optionsStorage = '
. json_encode(
$document->_script_options,
($debug && defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : false)
)
. ';' . $lnEnd;
$buffer .= $tab . '</script>' . $lnEnd;
}

// Generate script declarations
foreach ($document->_script as $type => $content)
{
Expand Down