Phalcon Assets

Assets\Asset

Object representation of an asset

$asset = new \Phalcon\Assets\Asset("js", "js/jquery.js");

Uses Phalcon\Assets\Exceptions\CannotReadAsset · Phalcon\Assets\Traits\AttributesTrait · Phalcon\Assets\Traits\SourceTargetTrait · Phalcon\Contracts\Assets\AssetsTypes · Phalcon\Traits\Php\FileTrait · Phalcon\Traits\Php\HashTrait

Method Summary

Properties

Methods

__construct()

public function __construct(
    string $type,
    string $path,
    bool $isLocal = true,
    bool $filter = true,
    array $attributes = [],
    string|null $version = null,
    bool $isAutoVersion = false
);

Asset constructor.

getAssetKey()

public function getAssetKey(): string;

Gets the asset’s key.

getContent()

public function getContent( string|null $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()

public function getFilter(): bool;

Gets if the asset must be filtered or not.

getPath()

public function getPath(): string;

Returns the path for this asset

getRealSourcePath()

public function getRealSourcePath( string|null $basePath = null ): string;

Returns the complete location where the asset is located

getRealTargetPath()

public function getRealTargetPath( string|null $basePath = null ): string;

Returns the complete location where the asset must be written

getRealTargetUri()

public function getRealTargetUri(): string;

Returns the real target uri for the generated HTML

getType()

public function getType(): string;

Gets the asset’s type.

getVersion()

public function getVersion(): string|null;

Gets the asset’s version.

isAutoVersion()

public function isAutoVersion(): bool;

Checks if the asset is using auto version

setAttributes()

public function setAttributes( array $attributes ): AssetInterface;

Sets extra HTML attributes

setAutoVersion()

public function setAutoVersion( bool $flag ): AssetInterface;

setFilter()

public function setFilter( bool $filter ): AssetInterface;

Sets if the asset must be filtered or not

setPath()

public function setPath( string $path ): AssetInterface;

Sets the asset’s path

setType()

public function setType( string $type ): AssetInterface;

Sets the asset’s type

setVersion()

public function setVersion( string $version ): AssetInterface;

Sets the asset’s version

Assets\AssetInterface

Phalcon\Assets\AssetInterface

Uses Phalcon\Contracts\Assets\Asset

Assets\Asset\Css

Represents CSS assets

Uses Phalcon\Assets\Asset

Method Summary

Methods

__construct()

public function __construct(
    string $path,
    bool $local = true,
    bool $filter = true,
    array $attributes = [],
    string|null $version = null,
    bool $autoVersion = false
);

Css constructor.

Assets\Asset\Js

Represents JavaScript assets

Uses Phalcon\Assets\Asset

Method Summary

Methods

__construct()

public function __construct(
    string $path,
    bool $local = true,
    bool $filter = true,
    array $attributes = [],
    string|null $version = null,
    bool $autoVersion = false
);

Js constructor.

Assets\Collection

Collection of asset objects

Uses ArrayIterator · Countable · IteratorAggregate · Phalcon\Assets\Traits\AttributesTrait · Phalcon\Assets\Traits\SourceTargetTrait · Phalcon\Contracts\Assets\AssetsTypes · Phalcon\Traits\Php\FileTrait · Traversable

Method Summary

Properties

Methods

add()

public function add( AssetInterface $asset ): static;

Adds an asset to the collection

addCss()

public function addCss(
    string $path,
    mixed $isLocal = null,
    bool $filter = true,
    array $attributes = [],
    string|null $version = null,
    bool $autoVersion = false
): static;

Adds a CSS asset to the collection

addFilter()

public function addFilter( FilterInterface $filter ): static;

Adds a filter to the collection

addInline()

public function addInline( Inline $code ): static;

Adds an inline code to the collection

addInlineCss()

public function addInlineCss(
    string $content,
    bool $filter = true,
    array $attributes = []
): static;

Adds an inline CSS to the collection

addInlineJs()

public function addInlineJs(
    string $content,
    bool $filter = true,
    array $attributes = []
): static;

Adds an inline JavaScript to the collection

addJs()

public function addJs(
    string $path,
    mixed $isLocal = null,
    bool $filter = true,
    array $attributes = [],
    string|null $version = null,
    bool $autoVersion = false
): static;

Adds a JavaScript asset to the collection

count()

public function count(): int;

Return the count of the assets

getAssets()

public function getAssets(): array;

Return the stored assets

getCodes()

public function getCodes(): array;

Return the stored codes

getFilters()

public function getFilters(): array;

Return the stored filters

getIterator()

public function getIterator(): Traversable;

Returns the iterator of the class

getJoin()

public function getJoin(): bool;

getPrefix()

public function getPrefix(): string;

Returns the prefix

getRealTargetPath()

public function getRealTargetPath( string $basePath ): string;

Returns the complete location where the joined/filtered collection must be written

getTargetIsLocal()

public function getTargetIsLocal(): bool;

Returns whether the target is local or not

getVersion()

public function getVersion(): string;

Returns the version

has()

public function has( AssetInterface $asset ): bool;

Checks this the asset is added to the collection.

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()

public function isAutoVersion(): bool;

Checks if collection is using auto version

join()

public function join( bool $flag ): static;

Sets if all filtered assets in the collection must be joined in a single result file

setAttributes()

public function setAttributes( array $attributes ): static;

Sets extra HTML attributes

setAutoVersion()

public function setAutoVersion( bool $flag ): static;

setFilters()

public function setFilters( array $filters ): static;

Sets an array of filters in the collection

setPrefix()

public function setPrefix( string $prefix ): static;

Sets a common prefix for all the assets

setTargetIsLocal()

public function setTargetIsLocal( bool $flag ): static;

Sets if the target local or not

setVersion()

public function setVersion( string $version ): static;

Sets the version

addAsset()

final protected function addAsset( AssetInterface $asset ): bool;

Adds an asset or inline-code to the collection

Assets\Exception

Exceptions thrown in Phalcon\Assets will use this class

Assets\Exceptions\AssetSourceTargetCollision

Uses Phalcon\Assets\Exception

Method Summary

Methods

__construct()

public function __construct( string $path );

Assets\Exceptions\CannotReadAsset

Uses Phalcon\Assets\Exception

Method Summary

Methods

__construct()

public function __construct( string $path );

Assets\Exceptions\CollectionNotFound

Uses Phalcon\Assets\Exception

Method Summary

Methods

__construct()

public function __construct( string $name = "" );

Assets\Exceptions\InvalidAssetSourcePath

Uses Phalcon\Assets\Exception

Method Summary

Methods

__construct()

public function __construct( string $path );

Assets\Exceptions\InvalidAssetTargetPath

Uses Phalcon\Assets\Exception

Method Summary

Methods

__construct()

public function __construct( string $path );

Assets\Exceptions\InvalidFilter

Uses Phalcon\Assets\Exception

Method Summary

Methods

__construct()

public function __construct();

Assets\Exceptions\InvalidTargetPath

Uses Phalcon\Assets\Exception

Method Summary

Methods

__construct()

public function __construct( string $path );

Assets\Exceptions\TargetPathIsDirectory

Uses Phalcon\Assets\Exception

Method Summary

Methods

__construct()

public function __construct( string $path );

Assets\FilterInterface

Phalcon\Assets\FilterInterface

Uses Phalcon\Contracts\Assets\Filter

Assets\Filters\Cssmin

Filter intended to minify CSS content (remove comments, newlines, and line feeds, and drop the last semicolon of the last property).

NOTE: This functionality is not currently available; filter() returns the content unchanged.

Uses Phalcon\Assets\FilterInterface

Method Summary

Methods

filter()

public function filter( string $content ): string;

Filters the content using CSSMIN

Assets\Filters\Jsmin

Filter intended to minify JavaScript content (remove comments and the characters that are insignificant to JavaScript - tabs, carriage returns, and most spaces and linefeeds).

NOTE: This functionality is not currently available; filter() returns the content unchanged.

Uses Phalcon\Assets\FilterInterface

Method Summary

Methods

filter()

public function filter( string $content ): string;

Filters the content using JSMIN

Assets\Filters\None

Returns the content without make any modification to the original source

Uses Phalcon\Assets\FilterInterface

Method Summary

Methods

filter()

public function filter( string $content ): string;

Returns the content as is

Assets\Inline

Represents an inline asset

$inline = new \Phalcon\Assets\Inline("js", "alert('hello world');");

Uses Phalcon\Assets\Traits\AttributesTrait · Phalcon\Contracts\Assets\AssetsTypes · Phalcon\Traits\Php\HashTrait

Method Summary

Properties

Methods

__construct()

public function __construct(
    string $type,
    string $content,
    bool $filter = true,
    array $attributes = []
);

Inline constructor.

getAssetKey()

public function getAssetKey(): string;

Gets the asset’s key.

getContent()

public function getContent(): string;

Gets if the asset content

getFilter()

public function getFilter(): bool;

Gets if the asset must be filtered or not.

getType()

public function getType(): string;

Gets the asset’s type.

setAttributes()

public function setAttributes( array $attributes ): AssetInterface;

Sets extra HTML attributes

setFilter()

public function setFilter( bool $filter ): AssetInterface;

Sets if the asset must be filtered or not

setType()

public function setType( string $type ): AssetInterface;

Sets the inline’s type

Assets\Inline\Css

Represents an inlined CSS

Uses Phalcon\Assets\Inline · Phalcon\Contracts\Assets\AssetsTypes

Method Summary

Methods

__construct()

public function __construct(
    string $content,
    bool $filter = true,
    array $attributes = []
);

Css constructor.

Assets\Inline\Js

Represents an inline JavaScript

Uses Phalcon\Assets\Inline · Phalcon\Contracts\Assets\AssetsTypes

Method Summary

Methods

__construct()

public function __construct(
    string $content,
    bool $filter = true,
    array $attributes = []
);

Js constructor.

Assets\Manager

Manages collections of CSS/JavaScript assets

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\Contracts\Assets\AssetsTypes · Phalcon\Di\AbstractInjectionAware · Phalcon\Html\Helper\Link · Phalcon\Html\Helper\Script · Phalcon\Html\TagFactory · Phalcon\Mvc\Url · Phalcon\Traits\Php\FileTrait

Method Summary

Properties

Methods

__construct()

public function __construct(
    TagFactory $tagFactory,
    array $options = []
);

Manager constructor.

addAsset()

public function addAsset( Asset $asset ): static;

Adds a raw asset to the manager

addAssetByType()

public function addAssetByType(
    string $type,
    Asset $asset
): static;

Adds an asset by its type

addCss()

public function addCss(
    string $path,
    bool $local = true,
    bool $filter = true,
    array $attributes = [],
    string|null $version = null,
    bool $autoVersion = false
): static;

Adds a CSS asset to the ‘css’ collection

addInlineCode()

public function addInlineCode( Inline $code ): static;

Adds a raw inline code to the manager

addInlineCodeByType()

public function addInlineCodeByType(
    string $type,
    Inline $code
): static;

Adds an inline code by its type

addInlineCss()

public function addInlineCss(
    string $content,
    bool $filter = true,
    array $attributes = []
): static;

Adds an inline CSS to the ‘css’ collection

addInlineJs()

public function addInlineJs(
    string $content,
    bool $filter = true,
    array $attributes = []
): static;

Adds an inline JavaScript to the ‘js’ collection

addJs()

public function addJs(
    string $path,
    bool $local = true,
    bool $filter = true,
    array $attributes = [],
    string|null $version = null,
    bool $autoVersion = false
): static;

Adds a JavaScript asset to the ‘js’ collection

$assets->addJs("scripts/jquery.js");
$assets->addJs("https://jquery.my-cdn.com/jquery.js", false);

collection()

public function collection( string $name ): Collection;

Creates/Returns a collection of assets

collectionAssetsByType()

public function collectionAssetsByType(
    array $assets,
    string $type
): array;

Creates/Returns a collection of assets by type

The instanceof guard below is the validation, so the parameter stays a plain array here.

exists()

public function exists( string $name ): bool;

Returns true or false if collection exists.

if ($manager->exists("jsHeader")) {
    // \Phalcon\Assets\Collection
    $collection = $manager->get("jsHeader");
}

get()

public function get( string $name ): Collection;

Returns a collection by its id.

$scripts = $assets->get("js");

getCollections()

public function getCollections(): Collection[];

Returns existing collections in the manager

getCss()

public function getCss(): Collection;

Returns the CSS collection of assets

getJs()

public function getJs(): Collection;

Returns the CSS collection of assets

getOptions()

public function getOptions(): array;

Returns the manager options

has()

public function has( string $name ): bool;

Returns true or false if collection exists.

if ($manager->has("jsHeader")) {
    // \Phalcon\Assets\Collection
    $collection = $manager->get("jsHeader");
}

output()

public function output(
    Collection $collection,
    string $type
): string|null;

Traverses a collection calling the callback to generate its HTML

outputCss()

public function outputCss( string|null $name = null ): string;

Prints the HTML for CSS assets

outputInline()

public function outputInline(
    Collection $collection,
    mixed $type
): string;

Traverses a collection and generate its HTML

outputInlineCss()

public function outputInlineCss( string|null $name = null ): string;

Prints the HTML for inline CSS

outputInlineJs()

public function outputInlineJs( string|null $name = null ): string;

Prints the HTML for inline JS

outputJs()

public function outputJs( string|null $name = null ): string;

Prints the HTML for JS assets

set()

public function set(
    string $name,
    Collection $collection
): static;

Sets a collection in the Assets Manager

$assets->set("js", $collection);

setOptions()

public function setOptions( array $options ): static;

Sets the manager options

useImplicitOutput()

public function useImplicitOutput( bool $implicitOutput ): static;

Sets if the HTML generated must be directly printed or returned

Assets\Traits\AttributesTrait

Shared HTML-attributes state for asset objects (Asset, Inline, Collection).

@todo set attributes to have a default array when introduced in zephir @todo v7 - share setAttributes here too (blocked: Collection is not an AssetInterface, so the return type diverges)

Uses Phalcon\Contracts\Assets\AssetsTypes

Used by Phalcon\Assets\Asset · Phalcon\Assets\Collection · Phalcon\Assets\Inline

Method Summary

Properties

Methods

getAttributes()

public function getAttributes(): array;

Gets extra HTML attributes.

Assets\Traits\SourceTargetTrait

Shared source/target path, uri and locality state for asset objects (Asset, Collection).

Used by Phalcon\Assets\Asset · Phalcon\Assets\Collection

Method Summary

Properties

Methods

getSourcePath()

public function getSourcePath(): string;

getTargetPath()

public function getTargetPath(): string;

getTargetUri()

public function getTargetUri(): string;

isLocal()

public function isLocal(): bool;

Checks if the asset is local or not

setIsLocal()

public function setIsLocal( bool $flag ): static;

Sets if the asset is local or external

setSourcePath()

public function setSourcePath( string $sourcePath ): static;

Sets the asset’s source path

setTargetPath()

public function setTargetPath( string $targetPath ): static;

Sets the asset’s target path

setTargetUri()

public function setTargetUri( string $targetUri ): static;

Sets a target uri for the generated HTML