Documentation

JavascriptImporter
in package
implements FilterInterface

Importer JS Filter Class used to import referenced javascript files.

=include library/jquery.js; =require library/jquery.js;

(@todo Below needs fixing) =define #FOO "Bar"; console.log(#FOO);

Tags
author

Alexey Bobkov, Samuel Georges

Interfaces, Classes and Traits

FilterInterface
A filter manipulates an asset at load and dump.

Table of Contents

$definedVars  : array<string|int, mixed>
$includedFiles  : array<string|int, mixed>
$scriptFile  : string
$scriptPath  : string
filterDump()  : mixed
Filters an asset just before it's dumped.
filterLoad()  : mixed
Filters an asset after it has been loaded.
directiveDefine()  : mixed
Directive to define and replace variables
directiveInclude()  : mixed
Directive to process script includes
directiveRequire()  : mixed
Directive to process mandatory script includes
parse()  : string
Process JS imports inside a string of javascript

Properties

$definedVars

protected array<string|int, mixed> $definedVars = []

Variables defined by this script.

$includedFiles

protected array<string|int, mixed> $includedFiles = []

Cache of required files.

$scriptPath

protected string $scriptPath

Location of where the processed JS script resides.

Methods

directiveDefine()

Directive to define and replace variables

protected directiveDefine(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed

directiveInclude()

Directive to process script includes

protected directiveInclude(mixed $data[, mixed $required = false ]) : mixed
Parameters
$data : mixed
$required : mixed = false
Return values
mixed

directiveRequire()

Directive to process mandatory script includes

protected directiveRequire(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed

parse()

Process JS imports inside a string of javascript

protected parse( $content) : string
Parameters
$content :

string JS code to process.

Return values
string

Processed JS.

Search results