Skip to content
This repository was archived by the owner on Jan 29, 2020. It is now read-only.
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
38 changes: 38 additions & 0 deletions doc/book/assets-listener.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Assets listener

Allow to use assets (css, js etc.) from modules, or other not public folders

Web server has not access to module folder directly, but this is possible through `AssetsListener`.
`Zend\View\Helper\Assets` helper can build link to module folder (through Router),
`AssetsListener` can detect this link (through Router too) and route it to module name and asset.
When `AssetsListener` detected asset link, it caching module asset to public folder and
browser can request this asset directly from public folder (it can be disabled).
Also `AssetsListener` can filter assets content, as sample .less to .css.

## Basic Usage

Configure template resolver
```php
// Add temptate resolver for assets in config file
'assets_manager' => [
'template_resolver' => [
'prefix_resolver' => [
'ModuleName::' => __DIR__ . '\ModuleNameDir\assets'
],
],
],
```

Add asset in layout
```php
<?php
// in layout add asset for module:
$this->assets()->add('ModuleName::foo.css');
echo $this->assets();
?>
```

Layout Output:
```html
<link href="/assets-cache/prefix-ModuleTwo/foo.css" type="text/css">
```
1 change: 1 addition & 0 deletions src/Application.php
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ class Application implements
*/
protected $defaultListeners = [
'RouteListener',
'AssetsListener',
'MiddlewareListener',
'DispatchListener',
'HttpMethodListener',
Expand Down
Loading