---
title: "Phalcon Assets"
version: "5.14"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Assets
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Assets\Asset
Class
Source on GitHub
Represents an asset
```php
$asset = new \Phalcon\Assets\Asset("js", "js/jquery.js");
```
- **`Phalcon\Assets\Asset`** — implements [`Phalcon\Assets\AssetInterface`](#assetsassetinterface)
- [`Phalcon\Assets\Asset\Css`](#assetsassetcss)
- [`Phalcon\Assets\Asset\Js`](#assetsassetjs)
__Uses__ `Phalcon\Assets\Exceptions\CannotReadAsset`
### Method Summary
### Properties
protected
array
$attributes
protected
bool
$filter
protected
bool
$isAutoVersion = false
protected
bool
$isLocal
protected
string
$path
protected
string
$sourcePath
protected
string
$targetPath
protected
string
$targetUri
protected
string
$type
protected
string|null
$version
Version of resource
### Methods
Public · 26
__construct()
```php
public function __construct(
string $type,
string $path,
bool $isLocal = true,
bool $filter = true,
array $attributes = [],
string $version = null,
bool $isAutoVersion = false
);
```
Asset constructor.
getAssetKey()
```php
public function getAssetKey(): string;
```
Gets the asset's key.
getAttributes()
```php
public function getAttributes(): array;
```
Gets extra HTML attributes.
getContent()
```php
public function getContent( string $basePath = null ): string;
```
Returns the content of the asset as an string
Optionally a base path where the asset is located can be set
getFilter()
```php
public function getFilter(): bool;
```
getPath()
```php
public function getPath(): string;
```
getRealSourcePath()
```php
public function getRealSourcePath( string $basePath = null ): string;
```
Returns the complete location where the asset is located
getRealTargetPath()
```php
public function getRealTargetPath( string $basePath = null ): string;
```
Returns the complete location where the asset must be written
getRealTargetUri()
```php
public function getRealTargetUri(): string;
```
Returns the real target uri for the generated HTML
getSourcePath()
```php
public function getSourcePath(): string;
```
getTargetPath()
```php
public function getTargetPath(): string;
```
getTargetUri()
```php
public function getTargetUri(): string;
```
getType()
```php
public function getType(): string;
```
getVersion()
```php
public function getVersion(): string|null;
```
Version of resource
isAutoVersion()
```php
public function isAutoVersion(): bool;
```
Checks if the asset is using auto version
isLocal()
```php
public function isLocal(): bool;
```
Checks if the asset is local or not
setAttributes()
```php
public function setAttributes( array $attributes ): AssetInterface;
```
Sets extra HTML attributes
setAutoVersion()
```php
public function setAutoVersion( bool $flag ): AssetInterface;
```
setFilter()
```php
public function setFilter( bool $filter ): AssetInterface;
```
Sets if the asset must be filtered or not
setIsLocal()
```php
public function setIsLocal( bool $flag ): AssetInterface;
```
Sets if the asset is local or external
setPath()
```php
public function setPath( string $path ): AssetInterface;
```
Sets the asset's path
setSourcePath()
```php
public function setSourcePath( string $sourcePath ): AssetInterface;
```
Sets the asset's source path
setTargetPath()
```php
public function setTargetPath( string $targetPath ): AssetInterface;
```
Sets the asset's target path
setTargetUri()
```php
public function setTargetUri( string $targetUri ): AssetInterface;
```
Sets a target uri for the generated HTML
setType()
```php
public function setType( string $type ): AssetInterface;
```
Sets the asset's type
setVersion()
```php
public function setVersion( string $version ): AssetInterface;
```
Sets the asset's version
Protected · 2
phpFileExists()
```php
protected function phpFileExists( string $filename ): bool;
```
@todo to be removed when we get traits
phpFileGetContents()
```php
protected function phpFileGetContents( string $filename );
```
## Assets\AssetInterface
Interface
Source on GitHub
Interface for custom Phalcon\Assets resources
- **`Phalcon\Assets\AssetInterface`**
### Method Summary
### Methods
Public · 7
getAssetKey()
```php
public function getAssetKey(): string;
```
Gets the asset's key.
getAttributes()
```php
public function getAttributes(): array|null;
```
Gets extra HTML attributes.
getFilter()
```php
public function getFilter(): bool;
```
Gets if the asset must be filtered or not.
getType()
```php
public function getType(): string;
```
Gets the asset's type.
setAttributes()
```php
public function setAttributes( array $attributes ): AssetInterface;
```
Sets extra HTML attributes.
setFilter()
```php
public function setFilter( bool $filter ): AssetInterface;
```
Sets if the asset must be filtered or not.
setType()
```php
public function setType( string $type ): AssetInterface;
```
Sets the asset's type.
## Assets\Asset\Css
Class
Source on GitHub
Represents CSS assets
- [`Phalcon\Assets\Asset`](#assetsasset)
- **`Phalcon\Assets\Asset\Css`**
__Uses__ `Phalcon\Assets\Asset`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct(
string $path,
bool $local = true,
bool $filter = true,
array $attributes = [],
string $version = null,
bool $autoVersion = false
);
```
Phalcon\Assets\Asset\Css constructor
## Assets\Asset\Js
Class
Source on GitHub
Represents JavaScript assets
- [`Phalcon\Assets\Asset`](#assetsasset)
- **`Phalcon\Assets\Asset\Js`**
__Uses__ `Phalcon\Assets\Asset`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct(
string $path,
bool $local = true,
bool $filter = true,
array $attributes = [],
string $version = null,
bool $autoVersion = false
);
```
Phalcon\Assets\Asset\Js constructor
## Assets\Collection
Class
Source on GitHub
Collection of asset objects
- **`Phalcon\Assets\Collection`** — implements `Countable`, `IteratorAggregate`
__Uses__ `ArrayIterator` · `Countable` · `IteratorAggregate`
### Method Summary
public
static
add( AssetInterface $asset )
Adds an asset to the collection
public
static
addCss(string $path,mixed $isLocal = null,bool $filter = true,array $attributes = [],string $version = null,bool $autoVersion = false)
Adds a CSS asset to the collection
public
static
addFilter( FilterInterface $filter )
Adds a filter to the collection
public
static
addInline( Inline $code )
Adds an inline code to the collection
public
static
addInlineCss(string $content,bool $filter = true,array $attributes = [])
Adds an inline CSS to the collection
public
static
addInlineJs(string $content,bool $filter = true,array $attributes = [])
Adds an inline JavaScript to the collection
public
static
addJs(string $path,mixed $isLocal = null,bool $filter = true,array $attributes = [],string $version = null,bool $autoVersion = false)
Adds a JavaScript asset to the collection
public
int
count()
Return the count of the assets
public
array
getAssets()
public
array
getAttributes()
public
array
getCodes()
public
array
getFilters()
public
\Traversable
getIterator()
Returns the generator of the class
public
bool
getJoin()
public
string
getPrefix()
public
string
getRealTargetPath( string $basePath )
Returns the complete location where the joined/filtered collection must
public
string
getSourcePath()
public
bool
getTargetIsLocal()
public
string
getTargetPath()
public
string
getTargetUri()
public
string
getVersion()
public
bool
has( AssetInterface $asset )
Checks this the asset is added to the collection.
public
bool
isAutoVersion()
Checks if collection is using auto version
public
bool
isLocal()
public
static
join( bool $flag )
Sets if all filtered assets in the collection must be joined in a single
public
static
setAttributes( array $attributes )
Sets extra HTML attributes
public
static
setAutoVersion( bool $flag )
public
static
setFilters( array $filters )
Sets an array of filters in the collection
public
static
setIsLocal( bool $flag )
Sets if the collection uses local assets by default
public
static
setPrefix( string $prefix )
Sets a common prefix for all the assets
public
static
setSourcePath( string $sourcePath )
Sets a base source path for all the assets in this collection
public
static
setTargetIsLocal( bool $flag )
Sets if the target local or not
public
static
setTargetPath( string $targetPath )
Sets the target path of the file for the filtered/join output
public
static
setTargetUri( string $targetUri )
Sets a target uri for the generated HTML
public
static
setVersion( string $version )
Sets the version
protected
bool
addAsset( AssetInterface $asset )
Adds an asset or inline-code to the collection
### Properties
protected
array
$assets = []
protected
array
$attributes = []
protected
bool
$autoVersion = false
Should version be determined from file modification time
protected
array
$codes = []
protected
array
$filters = []
protected
bool
$isLocal = true
protected
bool
$join = true
protected
string
$prefix = ""
protected
string
$sourcePath = ""
protected
bool
$targetIsLocal = true
protected
string
$targetPath = ""
protected
string
$targetUri = ""
protected
string
$version = ""
### Methods
Public · 35
add()
```php
public function add( AssetInterface $asset ): static;
```
Adds an asset to the collection
addCss()
```php
public function addCss(
string $path,
mixed $isLocal = null,
bool $filter = true,
array $attributes = [],
string $version = null,
bool $autoVersion = false
): static;
```
Adds a CSS asset to the collection
addFilter()
```php
public function addFilter( FilterInterface $filter ): static;
```
Adds a filter to the collection
addInline()
```php
public function addInline( Inline $code ): static;
```
Adds an inline code to the collection
addInlineCss()
```php
public function addInlineCss(
string $content,
bool $filter = true,
array $attributes = []
): static;
```
Adds an inline CSS to the collection
addInlineJs()
```php
public function addInlineJs(
string $content,
bool $filter = true,
array $attributes = []
): static;
```
Adds an inline JavaScript to the collection
addJs()
```php
public function addJs(
string $path,
mixed $isLocal = null,
bool $filter = true,
array $attributes = [],
string $version = null,
bool $autoVersion = false
): static;
```
Adds a JavaScript asset to the collection
count()
```php
public function count(): int;
```
Return the count of the assets
@link https://php.net/manual/en/countable.count.php
getAssets()
```php
public function getAssets(): array;
```
getAttributes()
```php
public function getAttributes(): array;
```
getCodes()
```php
public function getCodes(): array;
```
getFilters()
```php
public function getFilters(): array;
```
getIterator()
```php
public function getIterator(): \Traversable;
```
Returns the generator of the class
@link https://php.net/manual/en/iteratoraggregate.getiterator.php
getJoin()
```php
public function getJoin(): bool;
```
getPrefix()
```php
public function getPrefix(): string;
```
getRealTargetPath()
```php
public function getRealTargetPath( string $basePath ): string;
```
Returns the complete location where the joined/filtered collection must
be written
getSourcePath()
```php
public function getSourcePath(): string;
```
getTargetIsLocal()
```php
public function getTargetIsLocal(): bool;
```
getTargetPath()
```php
public function getTargetPath(): string;
```
getTargetUri()
```php
public function getTargetUri(): string;
```
getVersion()
```php
public function getVersion(): string;
```
has()
```php
public function has( AssetInterface $asset ): bool;
```
Checks this the asset is added to the collection.
```php
use Phalcon\Assets\Asset;
use Phalcon\Assets\Collection;
$collection = new Collection();
$asset = new Asset("js", "js/jquery.js");
$collection->add($asset);
$collection->has($asset); // true
```
isAutoVersion()
```php
public function isAutoVersion(): bool;
```
Checks if collection is using auto version
isLocal()
```php
public function isLocal(): bool;
```
join()
```php
public function join( bool $flag ): static;
```
Sets if all filtered assets in the collection must be joined in a single
result file
setAttributes()
```php
public function setAttributes( array $attributes ): static;
```
Sets extra HTML attributes
setAutoVersion()
```php
public function setAutoVersion( bool $flag ): static;
```
setFilters()
```php
public function setFilters( array $filters ): static;
```
Sets an array of filters in the collection
setIsLocal()
```php
public function setIsLocal( bool $flag ): static;
```
Sets if the collection uses local assets by default
setPrefix()
```php
public function setPrefix( string $prefix ): static;
```
Sets a common prefix for all the assets
setSourcePath()
```php
public function setSourcePath( string $sourcePath ): static;
```
Sets a base source path for all the assets in this collection
setTargetIsLocal()
```php
public function setTargetIsLocal( bool $flag ): static;
```
Sets if the target local or not
setTargetPath()
```php
public function setTargetPath( string $targetPath ): static;
```
Sets the target path of the file for the filtered/join output
setTargetUri()
```php
public function setTargetUri( string $targetUri ): static;
```
Sets a target uri for the generated HTML
setVersion()
```php
public function setVersion( string $version ): static;
```
Sets the version
Protected · 1
addAsset()
```php
final protected function addAsset( AssetInterface $asset ): bool;
```
Adds an asset or inline-code to the collection
## Assets\Exception
Class
Source on GitHub
Exceptions thrown in Phalcon\Assets will use this class
- `\Exception`
- **`Phalcon\Assets\Exception`**
- [`Phalcon\Assets\Exceptions\AssetSourceTargetCollision`](#assetsexceptionsassetsourcetargetcollision)
- [`Phalcon\Assets\Exceptions\CannotReadAsset`](#assetsexceptionscannotreadasset)
- [`Phalcon\Assets\Exceptions\CollectionNotFound`](#assetsexceptionscollectionnotfound)
- [`Phalcon\Assets\Exceptions\InvalidAssetSourcePath`](#assetsexceptionsinvalidassetsourcepath)
- [`Phalcon\Assets\Exceptions\InvalidAssetTargetPath`](#assetsexceptionsinvalidassettargetpath)
- [`Phalcon\Assets\Exceptions\InvalidFilter`](#assetsexceptionsinvalidfilter)
- [`Phalcon\Assets\Exceptions\InvalidTargetPath`](#assetsexceptionsinvalidtargetpath)
- [`Phalcon\Assets\Exceptions\TargetPathIsDirectory`](#assetsexceptionstargetpathisdirectory)
## Assets\Exceptions\AssetSourceTargetCollision
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\Exception`
- [`Phalcon\Assets\Exception`](#assetsexception)
- **`Phalcon\Assets\Exceptions\AssetSourceTargetCollision`**
__Uses__ `Phalcon\Assets\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $path );
```
## Assets\Exceptions\CannotReadAsset
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\Exception`
- [`Phalcon\Assets\Exception`](#assetsexception)
- **`Phalcon\Assets\Exceptions\CannotReadAsset`**
__Uses__ `Phalcon\Assets\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $path );
```
## Assets\Exceptions\CollectionNotFound
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\Exception`
- [`Phalcon\Assets\Exception`](#assetsexception)
- **`Phalcon\Assets\Exceptions\CollectionNotFound`**
__Uses__ `Phalcon\Assets\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Assets\Exceptions\InvalidAssetSourcePath
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\Exception`
- [`Phalcon\Assets\Exception`](#assetsexception)
- **`Phalcon\Assets\Exceptions\InvalidAssetSourcePath`**
__Uses__ `Phalcon\Assets\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $path );
```
## Assets\Exceptions\InvalidAssetTargetPath
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\Exception`
- [`Phalcon\Assets\Exception`](#assetsexception)
- **`Phalcon\Assets\Exceptions\InvalidAssetTargetPath`**
__Uses__ `Phalcon\Assets\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $path );
```
## Assets\Exceptions\InvalidFilter
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\Exception`
- [`Phalcon\Assets\Exception`](#assetsexception)
- **`Phalcon\Assets\Exceptions\InvalidFilter`**
__Uses__ `Phalcon\Assets\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Assets\Exceptions\InvalidTargetPath
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\Exception`
- [`Phalcon\Assets\Exception`](#assetsexception)
- **`Phalcon\Assets\Exceptions\InvalidTargetPath`**
__Uses__ `Phalcon\Assets\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $path );
```
## Assets\Exceptions\TargetPathIsDirectory
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
- `\Exception`
- [`Phalcon\Assets\Exception`](#assetsexception)
- **`Phalcon\Assets\Exceptions\TargetPathIsDirectory`**
__Uses__ `Phalcon\Assets\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $path );
```
## Assets\FilterInterface
Interface
Source on GitHub
Interface for custom Phalcon\Assets filters
- **`Phalcon\Assets\FilterInterface`**
### Method Summary
### Methods
Public · 1
filter()
```php
public function filter( string $content ): string;
```
Filters the content returning a string with the filtered content
## Assets\Filters\Cssmin
Class
Source on GitHub
Minify the CSS - removes comments removes newlines and line feeds keeping
removes last semicolon from last property
- **`Phalcon\Assets\Filters\Cssmin`** — implements [`Phalcon\Assets\FilterInterface`](#assetsfilterinterface)
__Uses__ `Phalcon\Assets\FilterInterface`
### Method Summary
### Methods
Public · 1
filter()
```php
public function filter( string $content ): string;
```
Filters the content using CSSMIN
> NOTE: This functionality is not currently available
\{: .alert .alert-info \}
## Assets\Filters\Jsmin
Class
Source on GitHub
Deletes the characters which are insignificant to JavaScript. Comments will
be removed. Tabs will be replaced with spaces. Carriage returns will be
replaced with linefeeds. Most spaces and linefeeds will be removed.
- **`Phalcon\Assets\Filters\Jsmin`** — implements [`Phalcon\Assets\FilterInterface`](#assetsfilterinterface)
__Uses__ `Phalcon\Assets\FilterInterface`
### Method Summary
### Methods
Public · 1
filter()
```php
public function filter( string $content ): string;
```
Filters the content using JSMIN
> NOTE: This functionality is not currently available
\{: .alert .alert-info \}
## Assets\Filters\None
Class
Source on GitHub
Returns the content without make any modification to the original source
- **`Phalcon\Assets\Filters\None`** — implements [`Phalcon\Assets\FilterInterface`](#assetsfilterinterface)
__Uses__ `Phalcon\Assets\FilterInterface`
### Method Summary
### Methods
Public · 1
filter()
```php
public function filter( string $content ): string;
```
Returns the content as is
## Assets\Inline
Class
Source on GitHub
Represents an inline asset
```php
$inline = new \Phalcon\Assets\Inline("js", "alert('hello world');");
```
- **`Phalcon\Assets\Inline`** — implements [`Phalcon\Assets\AssetInterface`](#assetsassetinterface)
- [`Phalcon\Assets\Inline\Css`](#assetsinlinecss)
- [`Phalcon\Assets\Inline\Js`](#assetsinlinejs)
### Method Summary
### Properties
protected
array
$attributes
protected
string
$content
protected
bool
$filter
protected
string
$type
### Methods
Public · 9
__construct()
```php
public function __construct(
string $type,
string $content,
bool $filter = true,
array $attributes = []
);
```
Phalcon\Assets\Inline constructor
getAssetKey()
```php
public function getAssetKey(): string;
```
Gets the asset's key.
getAttributes()
```php
public function getAttributes(): array;
```
getContent()
```php
public function getContent(): string;
```
getFilter()
```php
public function getFilter(): bool;
```
getType()
```php
public function getType(): string;
```
setAttributes()
```php
public function setAttributes( array $attributes ): AssetInterface;
```
Sets extra HTML attributes
setFilter()
```php
public function setFilter( bool $filter ): AssetInterface;
```
Sets if the asset must be filtered or not
setType()
```php
public function setType( string $type ): AssetInterface;
```
Sets the inline's type
## Assets\Inline\Css
Class
Source on GitHub
Represents an inlined CSS
- [`Phalcon\Assets\Inline`](#assetsinline)
- **`Phalcon\Assets\Inline\Css`**
__Uses__ `Phalcon\Assets\Inline`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct(
string $content,
bool $filter = true,
array $attributes = []
);
```
Phalcon\Assets\Inline\Css constructor
## Assets\Inline\Js
Class
Source on GitHub
Represents an inline JavaScript
- [`Phalcon\Assets\Inline`](#assetsinline)
- **`Phalcon\Assets\Inline\Js`**
__Uses__ `Phalcon\Assets\Inline`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct(
string $content,
bool $filter = true,
array $attributes = []
);
```
Phalcon\Assets\Inline\Js constructor
## Assets\Manager
Class
Source on GitHub
Manages collections of CSS/JavaScript assets
- `stdClass`
- [`Phalcon\Di\AbstractInjectionAware`](/5.14/api/phalcon_di/#diabstractinjectionaware)
- **`Phalcon\Assets\Manager`**
__Uses__ `Phalcon\Assets\Asset\Css` · `Phalcon\Assets\Asset\Js` · `Phalcon\Assets\Exceptions\AssetSourceTargetCollision` · `Phalcon\Assets\Exceptions\CollectionNotFound` · `Phalcon\Assets\Exceptions\InvalidAssetSourcePath` · `Phalcon\Assets\Exceptions\InvalidAssetTargetPath` · `Phalcon\Assets\Exceptions\InvalidFilter` · `Phalcon\Assets\Exceptions\InvalidTargetPath` · `Phalcon\Assets\Exceptions\TargetPathIsDirectory` · `Phalcon\Assets\Inline\Css` · `Phalcon\Assets\Inline\Js` · `Phalcon\Di\AbstractInjectionAware` · `Phalcon\Html\Helper\Element` · `Phalcon\Html\Helper\Link` · `Phalcon\Html\Helper\Script` · `Phalcon\Html\TagFactory`
### Method Summary
public
__construct(TagFactory $tagFactory,array $options = [])
Manager constructor.
public
static
addAsset( Asset $asset )
Adds a raw asset to the manager
public
static
addAssetByType(string $type,Asset $asset)
Adds a asset by its type
public
static
addCss(string $path,bool $local = true,bool $filter = true,array $attributes = [],string $version = null,bool $autoVersion = false)
Adds a CSS asset to the 'css' collection
public
static
addInlineCode( Inline $code )
Adds a raw inline code to the manager
public
static
addInlineCodeByType(string $type,Inline $code)
Adds an inline code by its type
public
static
addInlineCss(string $content,bool $filter = true,array $attributes = [])
Adds an inline CSS to the 'css' collection
public
static
addInlineJs(string $content,bool $filter = true,array $attributes = [])
Adds an inline JavaScript to the 'js' collection
public
static
addJs(string $path,bool $local = true,bool $filter = true,array $attributes = [],string $version = null,bool $autoVersion = false)
Adds a JavaScript asset to the 'js' collection
public
Collection
collection( string $name )
Creates/Returns a collection of assets
public
array
collectionAssetsByType(array $assets,string $type)
Creates/Returns a collection of assets by type
public
bool
exists( string $name )
Returns true or false if collection exists.
public
Collection
get( string $name )
Returns a collection by its id.
public
Collection[]
getCollections()
Returns existing collections in the manager
public
Collection
getCss()
Returns the CSS collection of assets
public
Collection
getJs()
Returns the CSS collection of assets
public
array
getOptions()
Returns the manager options
public
bool
has( string $name )
Returns true or false if collection exists.
public
string|null
output(Collection $collection,string $type)
Traverses a collection calling the callback to generate its HTML
public
string
outputCss( string $name = null )
Prints the HTML for CSS assets
public
string
outputInline(Collection $collection,mixed $type)
Traverses a collection and generate its HTML
public
string
outputInlineCss( string $name = null )
Prints the HTML for inline CSS
public
string
outputInlineJs( string $name = null )
Prints the HTML for inline JS
public
string
outputJs( string $name = null )
Prints the HTML for JS assets
public
static
set(string $name,Collection $collection)
Sets a collection in the Assets Manager
public
static
setOptions( array $options )
Sets the manager options
public
static
useImplicitOutput( bool $implicitOutput )
Sets if the HTML generated must be directly printed or returned
### Properties
protected
array
$collections = []
protected
bool
$implicitOutput = true
protected
array
$options = []
protected
TagFactory
$tagFactory
### Methods
Public · 27
__construct()
```php
public function __construct(
TagFactory $tagFactory,
array $options = []
);
```
Manager constructor.
addAsset()
```php
public function addAsset( Asset $asset ): static;
```
Adds a raw asset to the manager
addAssetByType()
```php
public function addAssetByType(
string $type,
Asset $asset
): static;
```
Adds a asset by its type
addCss()
```php
public function addCss(
string $path,
bool $local = true,
bool $filter = true,
array $attributes = [],
string $version = null,
bool $autoVersion = false
): static;
```
Adds a CSS asset to the 'css' collection
addInlineCode()
```php
public function addInlineCode( Inline $code ): static;
```
Adds a raw inline code to the manager
addInlineCodeByType()
```php
public function addInlineCodeByType(
string $type,
Inline $code
): static;
```
Adds an inline code by its type
addInlineCss()
```php
public function addInlineCss(
string $content,
bool $filter = true,
array $attributes = []
): static;
```
Adds an inline CSS to the 'css' collection
addInlineJs()
```php
public function addInlineJs(
string $content,
bool $filter = true,
array $attributes = []
): static;
```
Adds an inline JavaScript to the 'js' collection
addJs()
```php
public function addJs(
string $path,
bool $local = true,
bool $filter = true,
array $attributes = [],
string $version = null,
bool $autoVersion = false
): static;
```
Adds a JavaScript asset to the 'js' collection
```php
$assets->addJs("scripts/jquery.js");
$assets->addJs("http://jquery.my-cdn.com/jquery.js", false);
```
collection()
```php
public function collection( string $name ): Collection;
```
Creates/Returns a collection of assets
collectionAssetsByType()
```php
public function collectionAssetsByType(
array $assets,
string $type
): array;
```
Creates/Returns a collection of assets by type
exists()
```php
public function exists( string $name ): bool;
```
Returns true or false if collection exists.
```php
if ($manager->exists("jsHeader")) {
// \Phalcon\Assets\Collection
$collection = $manager->get("jsHeader");
}
```
get()
```php
public function get( string $name ): Collection;
```
Returns a collection by its id.
```php
$scripts = $assets->get("js");
```
getCollections()
```php
public function getCollections(): Collection[];
```
Returns existing collections in the manager
getCss()
```php
public function getCss(): Collection;
```
Returns the CSS collection of assets
getJs()
```php
public function getJs(): Collection;
```
Returns the CSS collection of assets
getOptions()
```php
public function getOptions(): array;
```
Returns the manager options
has()
```php
public function has( string $name ): bool;
```
Returns true or false if collection exists.
```php
if ($manager->has("jsHeader")) {
// \Phalcon\Assets\Collection
$collection = $manager->get("jsHeader");
}
```
output()
```php
public function output(
Collection $collection,
string $type
): string|null;
```
Traverses a collection calling the callback to generate its HTML
outputCss()
```php
public function outputCss( string $name = null ): string;
```
Prints the HTML for CSS assets
outputInline()
```php
public function outputInline(
Collection $collection,
mixed $type
): string;
```
Traverses a collection and generate its HTML
outputInlineCss()
```php
public function outputInlineCss( string $name = null ): string;
```
Prints the HTML for inline CSS
outputInlineJs()
```php
public function outputInlineJs( string $name = null ): string;
```
Prints the HTML for inline JS
outputJs()
```php
public function outputJs( string $name = null ): string;
```
Prints the HTML for JS assets
set()
```php
public function set(
string $name,
Collection $collection
): static;
```
Sets a collection in the Assets Manager
```php
$assets->set("js", $collection);
```
setOptions()
```php
public function setOptions( array $options ): static;
```
Sets the manager options
useImplicitOutput()
```php
public function useImplicitOutput( bool $implicitOutput ): static;
```
Sets if the HTML generated must be directly printed or returned
Source: https://docs.phalcon.io/5.14/api/phalcon_assets/index.mdx