Secciones

Class Phalcon\Assets\Asset

Código fuente en GitHub

Namespace Phalcon\Assets   Implements AssetInterface

Representa un recurso

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

Propiedades

/**
 * @var array | null
 */
protected attributes;

/**
 * @var bool
 */
protected autoVersion = false;

/**
 * @var bool
 */
protected filter;

/**
 * @var bool
 */
protected local;

/**
 * @var string
 */
protected path;

/**
 * @var string
 */
protected sourcePath;

/**
 * @var string
 */
protected targetPath;

/**
 * @var string
 */
protected targetUri;

/**
 * @var string
 */
protected type;

/**
     * Version of resource
     * @var string
     */
protected version;

Métodos

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

Constructor Phalcon\Assets\Asset

public function getAssetKey(): string;

Obtiene la clave del recurso.

public function getAttributes(): array | null
public function getContent( string $basePath = null ): string;

Devuelve el contenido del recurso como una cadena Opcionalmente se puede establecer una ruta base donde localizar el recurso

public function getFilter(): bool
public function getLocal(): bool
public function getPath(): string
public function getRealSourcePath( string $basePath = null ): string;

Devuelve la ubicación completa donde se localiza el recurso

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

Devuelve la ubicación completa donde se debe escribir el recurso

public function getRealTargetUri(): string;

Devuelve la uri destino real para el HTML generado

public function getSourcePath(): string
public function getTargetPath(): string
public function getTargetUri(): string
public function getType(): string
public function getVersion():   string
public function isAutoVersion(): bool;

Comprueba si el recurso está usando la versión automática

public function setAttributes( array $attributes ): AssetInterface;

Establece atributos HTML extra

public function setAutoVersion( bool $autoVersion )
public function setFilter( bool $filter ): AssetInterface;

Establece si el recurso se debe filtrar o no

public function setLocal( bool $local ): AssetInterface;

Establece si el recurso es local o externo

public function setPath( string $path ): AssetInterface;

Establece la ruta del recurso

public function setSourcePath( string $sourcePath ): AssetInterface;

Establece la ruta origen del recurso

public function setTargetPath( string $targetPath ): AssetInterface;

Establece la ruta destino del recurso

public function setTargetUri( string $targetUri ): AssetInterface;

Establece una uri destino para el HTML generado

public function setType( string $type ): AssetInterface;

Establece el tipo de recurso

public function setVersion(     string $version )

Class Phalcon\Assets\Asset\Css

Código fuente en GitHub

Namespace Phalcon\Assets\Asset   Uses Phalcon\Assets\Asset   Extends AssetBase

Representa recursos CSS

Métodos

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

Constructor Phalcon\Assets\Asset\Css

Class Phalcon\Assets\Asset\Js

Código fuente en GitHub

Namespace Phalcon\Assets\Asset   Uses Phalcon\Assets\Asset   Extends AssetBase

Representa recursos JavaScript

Métodos

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

Phalcon\Assets\Asset\Js constructor

Interface Phalcon\Assets\AssetInterface

Código fuente en GitHub

Namespace Phalcon\Assets

Interfaz para recursos Phalcon\Assets personalizados

Métodos

public function getAssetKey(): string;

Obtiene la clave del recurso.

public function getAttributes(): array | null;

Obtiene los atributos HTML extra.

public function getFilter(): bool;

Obtiene si el recurso se debe filtrar o no.

public function getType(): string;

Obtiene el tipo de recurso.

public function setAttributes( array $attributes ): AssetInterface;

Establece los atributos HTML extra.

public function setFilter( bool $filter ): AssetInterface;

Establece si el recurso se debe filtrar o no.

public function setType( string $type ): AssetInterface;

Establece el tipo de recurso.

Class Phalcon\Assets\Collection

Código fuente en GitHub

Namespace Phalcon\Assets   Uses Countable, Iterator, Phalcon\Assets\Asset\Css, Phalcon\Assets\Asset\Js, Phalcon\Assets\Inline\Js, Phalcon\Assets\Inline\Css   Implements Countable, Iterator

Representa una colección de recursos

Propiedades

/**
 * @var array
 */
protected assets;

/**
 * @var array
 */
protected attributes;

/**
     * Should version be determined from file modification time
     * @var bool
     */
protected autoVersion = false;

/**
 * @var array
 */
protected codes;

/**
 * @var array
 */
protected filters;

/**
 * @var array
 */
protected includedAssets;

/**
 * @var bool
 */
protected join = true;

/**
 * @var bool
 */
protected local = true;

/**
 * @var string
 */
protected prefix;

/**
 * @var int
 */
protected position = 0;

/**
 * @var string
 */
protected sourcePath;

/**
 * @var bool
 */
protected targetLocal = true;

/**
 * @var string
 */
protected targetPath;

/**
 * @var string
 */
protected targetUri;

/**
     * Version of resource
     * @var string
     */
protected version;

Métodos

public function __construct();

Constructor Phalcon\Assets\Collection

public function add( AssetInterface $asset ): Collection;

Añade un recurso a la colección

public function addCss( string $path, mixed $local = null, bool $filter = bool, mixed $attributes = null, string $version = null, bool $autoVersion = bool ): Collection;

Añade un recurso CSS a la colección

public function addFilter( FilterInterface $filter ): Collection;

Añade un filtro a la colección

public function addInline( Inline $code ): Collection;

Añade un código en línea a la colección

public function addInlineCss( string $content, bool $filter = bool, mixed $attributes = null ): Collection;

Añade un CSS en línea a la colección

public function addInlineJs( string $content, bool $filter = bool, mixed $attributes = null ): Collection;

Añade un JavaScript en línea a la colección

public function addJs( string $path, mixed $local = null, bool $filter = bool, mixed $attributes = null, string $version = null, bool $autoVersion = bool ): Collection;

Añade un recurso JavaScript a la colección

public function count(): int;

Devuelve el número de elementos en la colección

public function current(): Asset;

Devuelve el recurso actual en el iterador

public function getAssets(): array
public function getAttributes(): array
public function getCodes(): array
public function getFilters(): array
public function getJoin(): bool
public function getLocal(): bool
public function getPosition(): int
public function getPrefix(): string
public function getRealTargetPath( string $basePath ): string;

Devuelve la ubicación completa donde la colección unida/filtrada se debe escribir

public function getSourcePath(): string
public function getTargetLocal(): bool
public function getTargetPath(): string
public function getTargetUri(): string
public function getVersion():   string
public function has( AssetInterface $asset ): bool;

Comprueba si este recurso está añadido a la colección.

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
public function isAutoVersion(): bool;

Comprueba si la colección está usando versión automática

public function join( bool $join ): Collection;

Establece si todos los recursos filtrados de la colección se deben unir en un sólo fichero resultante

public function key(): int;

Devuelve la clave/posición actual del iterador

public function next(): void;

Mueve el puntero interno de iteración a la siguiente posición

public function rewind(): void;

Rebobina el iterador interno

public function setAttributes( array $attributes ): Collection;

Establece atributos HTML extra

public function setAutoVersion(     bool $autoVersion )
public function setFilters( array $filters ): Collection;

Establece un vector de filtros en la colección

public function setLocal( bool $local ): Collection;

Establece si la colección usa recursos locales por defecto

public function setPrefix( string $prefix ): Collection;

Establece un prefijo común para todos los recursos

public function setSourcePath( string $sourcePath ): Collection;

Establece una ruta de origen base para todos los recursos de esta colección

public function setTargetLocal( bool $targetLocal ): Collection;

Establece el destino local

public function setTargetPath( string $targetPath ): Collection;

Establece la ruta destino del fichero para la salida filtrada/unida

public function setTargetUri( string $targetUri ): Collection;

Establece una uri destino para el HTML generado

public function setVersion(     string $version )
public function valid(): bool;

Comprueba si el elemento actual en el iterador es válido

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

Añade un recurso o código-en-línea a la colección

Class Phalcon\Assets\Exception

Código fuente en GitHub

Namespace Phalcon\Assets   Extends \Phalcon\Exception

Las excepciones lanzadas en Phalcon\Assets usarán esta clase

Interface Phalcon\Assets\FilterInterface

Código fuente en GitHub

Namespace Phalcon\Assets

Interfaz para filtros de Phalcon\Assets personalizados

Métodos

public function filter( string $content ): string;

Filtran el contenido devolviendo una cadena con el contenido filtrado

Class Phalcon\Assets\Filters\Cssmin

Código fuente en GitHub

Namespace Phalcon\Assets\Filters   Uses Phalcon\Assets\FilterInterface   Implements FilterInterface

Minimiza el CSS - elimina comentarios, elimina las líneas nuevas y los avances de línea que se mantienen, elimina el punto y coma de la última propiedad

Métodos

public function filter( string $content ): string;

Filtra el contenido usando CSSMIN NOTA: Esta funcionalidad no está disponible actualmente

Class Phalcon\Assets\Filters\Jsmin

Código fuente en GitHub

Namespace Phalcon\Assets\Filters   Uses Phalcon\Assets\FilterInterface   Implements FilterInterface

Elimina los caracteres que son insignificantes para JavaScript. Se eliminarán los comentarios. Las tabulaciones se reemplazarán con espacios. Los retornos de carro se reemplazarán con saltos de línea. La mayoría de saltos de línea y espacios se eliminarán.

Métodos

public function filter( string $content ): string;

Filtra el contenido usando JSMIN NOTA: Esta funcionalidad no está disponible actualmente

Class Phalcon\Assets\Filters\None

Código fuente en GitHub

Namespace Phalcon\Assets\Filters   Uses Phalcon\Assets\FilterInterface   Implements FilterInterface

Devuelve el contenido sin hacer ninguna modificación sobre la fuente original

Métodos

public function filter( string $content ): string;

Devuelve el contenido tal cual

Class Phalcon\Assets\Inline

Código fuente en GitHub

Namespace Phalcon\Assets   Implements AssetInterface

Representa un recurso en línea

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

Propiedades

/**
 * @var array | null
 */
protected attributes;

/**
 * @var string
 */
protected content;

/**
 * @var bool
 */
protected filter;

/**
 * @var string
 */
protected type;

Métodos

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

Constructor Phalcon\Assets\Inline

public function getAssetKey(): string;

Obtiene la clave del recurso.

public function getAttributes(): array | null
public function getContent(): string
public function getFilter(): bool
public function getType(): string
public function setAttributes( array $attributes ): AssetInterface;

Establece atributos HTML extra

public function setFilter( bool $filter ): AssetInterface;

Establece si el recurso se debe filtrar o no

public function setType( string $type ): AssetInterface;

Establece el tipo en línea

Class Phalcon\Assets\Inline\Css

Código fuente en GitHub

Namespace Phalcon\Assets\Inline   Uses Phalcon\Assets\Inline   Extends InlineBase

Representa un CSS en línea

Métodos

public function __construct( string $content, bool $filter = bool, mixed $attributes = null );

Constructor Phalcon\Assets\Inline\Css

Class Phalcon\Assets\Inline\Js

Código fuente en GitHub

Namespace Phalcon\Assets\Inline   Uses Phalcon\Assets\Inline   Extends InlineBase

Representa un JavaScript en línea

Métodos

public function __construct( string $content, bool $filter = bool, mixed $attributes = null );

Constructor Phalcon\Assets\Inline\Js

Class Phalcon\Assets\Manager

Código fuente en GitHub

Namespace Phalcon\Assets   Uses Phalcon\Tag, Phalcon\Assets\Asset\Js, Phalcon\Assets\Asset\Css, Phalcon\Assets\Inline\Css, Phalcon\Assets\Inline\Js, Phalcon\Di\DiInterface, Phalcon\Di\AbstractInjectionAware   Extends AbstractInjectionAware

Phalcon\Assets\Manager

Gestiona colecciones de recursos CSS/JavaScript

Propiedades

//
protected collections;

/**
 * Options configure
 * @var array
 */
protected options;

/**
 * @var bool
 */
protected implicitOutput = true;

Métodos

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

Constructor Phalcon\Assets\Manager

public function addAsset( Asset $asset ): Manager;

Añade un recurso en bruto al gestor

$assets->addAsset(
    new Phalcon\Assets\Asset("css", "css/style.css")
);
public function addAssetByType( string $type, Asset $asset ): Manager;

Añade un recurso por su tipo

$assets->addAssetByType(
    "css",
    new \Phalcon\Assets\Asset\Css("css/style.css")
);
public function addCss( string $path, mixed $local = bool, bool $filter = bool, mixed $attributes = null, string $version = null, bool $autoVersion = bool ): Manager;

Añade un recurso CSS a la colección ‘css’

   $assets->addCss("css/bootstrap.css");
   $assets->addCss("http://bootstrap.my-cdn.com/style.css", false);
public function addInlineCode( Inline $code ): Manager;

Añade un código en línea en bruto al gestor

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

Añade un código en línea por su tipo

public function addInlineCss( string $content, mixed $filter = bool, mixed $attributes = null ): Manager;

Añade un CSS en línea a la colección ‘css’

public function addInlineJs( string $content, mixed $filter = bool, mixed $attributes = null ): Manager;

Añade un JavaScript en línea a la colección ‘js’

public function addJs( string $path, mixed $local = bool, bool $filter = bool, mixed $attributes = null, string $version = null, bool $autoVersion = bool ): Manager;

Añade un recurso JavaScript a la colección ‘js’

$assets->addJs("scripts/jquery.js");
$assets->addJs("http://jquery.my-cdn.com/jquery.js", false);
public function collection( string $name ): Collection;

Crea/Devuelve una colección de recursos

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

Crea/Devuelve una colección de recursos por tipo

public function exists( string $id ): bool;

Devuelve true o false si existe la colección.

if ($assets->exists("jsHeader")) {
    // \Phalcon\Assets\Collection
    $collection = $assets->get("jsHeader");
}
public function get( string $id ): Collection;

Devuelve una colección por su id.

$scripts = $assets->get("js");
public function getCollections(): Collection[];

Devuelve las colecciones existentes en el gestor

public function getCss(): Collection;

Devuelve la colección de recursos CSS

public function getJs(): Collection;

Devuelve la colección de recursos JavaScript

public function getOptions(): array;

Devuelve las opciones del gestor

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

Recorre una colección llamando a la función de retorno para generar su HTML

public function outputCss( string $collectionName = null ): string;

Imprime el HTML para los recursos CSS

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

Recorre una colección y genera su HTML

public function outputInlineCss( string $collectionName = null ): string;

Imprime el HTML para CSS en línea

public function outputInlineJs( string $collectionName = null ): string;

Imprime el HTML para JS en línea

public function outputJs( string $collectionName = null ): string;

Imprime el HTML para recursos JS

public function set( string $id, Collection $collection ): Manager;

Establece una colección en el Gestor de Recursos

$assets->set("js", $collection);
public function setOptions( array $options ): Manager;

Establece las opciones del gestor

public function useImplicitOutput( bool $implicitOutput ): Manager;

Establece si el HTML generado debe ser impreso directamente o devuelto