Skip to content

Added pass method to pipeline variables into Javascript #6

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

Open
rafi wants to merge 1 commit into
base: 1.2/develop
Choose a base branch
from
Open

Added pass method to pipeline variables into Javascript #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 24 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,27 @@ In your code, you can mark an asset group for inclusion using `Assets::group()`

At this point, you can use `Assets::get()` to retrieve all assets that were added by section.

$assets->get('body'); // Retrieves any asset in the `body` section within all required groups.
$assets->get('body'); // Retrieves any asset in the `body` section within all required groups.

## Passing Javascript variables

You can pipeline server-side information into client-side Javascript variables using the `pass` method:

$this->assets->pass([
'route' => [
'name' => Route::name($this->request->route()),
'controller' => strtolower($this->request->controller()),
'action' => $this->request->action()
],
'url' => [
'base' => URL::base(),
'media' => URL::base().Media::uri('/').'/'
],
'environment' => Kohana::$environment
]);

When you use `Assets::get()` to retrieve all the `head` assets, data will be encoded like this:

<script type="text/javascript">window.pass = { "route": { "name": "default", "controller": "Welcome", "action": "index" }, "url": { "base": "/", "media": "/media/kohana/" }, "environment": 40 };</script>

In Javascript, your variables are set and ready to use within the `window.pass` global variable.
45 changes: 45 additions & 0 deletions classes/Yuriko/Assets.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ public static function factory(Object $config = NULL)
*/
protected $_requested = array();

/**
* @var array Collection of variables of pass to JavaScript
*/
protected $_pass = array();

protected $_config;

public function __construct(ArrayObject $config = NULL)
Expand All @@ -49,6 +54,28 @@ public function groups(array $names)
return $this;
}

/**
* Pass variable to JavaScript through 'head' section
*
* @param array $pairs An array that will be converted into JSON eventually
* @param bool $reset Reset previous passes?
* @return $this
*/
public function pass(array $pairs, $reset = FALSE)
{
if ($reset)
{
$this->_pass = array();
}

foreach ($pairs as $key => $value)
{
$this->_pass[$key] = $value;
}

return $this;
}

public function get($section = NULL)
{
$assets = array();
Expand Down Expand Up @@ -76,6 +103,13 @@ public function get($section = NULL)
usort($assets, array($this, '_sort_assets'));

$array = array();

// Prepend pass-through variables to JavaScript
if ($section == 'head')
{
$array[] = $this->_escape_pass();
}

foreach ($assets as $asset)
{
$attributes = Arr::get($asset, 4, array());
Expand All @@ -98,6 +132,17 @@ public function get($section = NULL)
return $array;
}

/**
* Escape pass-through variables as a JavaScript inline block
*
* @return string
*/
protected function _escape_pass()
{
$escaped = 'window.pass = '.json_encode($this->_pass).';';
return '<script type="text/javascript">'.$escaped.'</script>';
}

/**
* Custom sorting method for assets based on 'weight' key
*/
Expand Down