Documentation

Pipeline extends PropertyObject
in package

Grav

Common

Assets

uses AssetUtilsTrait

Class Pipeline

Constants

CSS_ASSET = 1
CSS_SOURCEMAP_REGEX = '{\/\*# (.*?) \*\/}'
CSS_URL_REGEX = '{url$([\'\"]?)(.*?)\1$|(@import)\s+([\'\"])(.*?)\4}'
FIRST_FORWARDSLASH_REGEX = '{^\/{1}\w}'
JS_ASSET = 2
JS_IMPORT_REGEX = '{import.+from\s?[\'|\"](.+?)[\'|\"]}'
JS_MODULE_ASSET = 3

Properties

$asset : string
$assets_dir : string
$assets_url : string
$attributes : array<string|int, mixed>
$base_url : string
$css_minify : bool
$css_minify_windows : bool
$css_pipeline_include_externals : bool
$css_rewrite : bool
$fetch_command : Closure|null
$js_minify : bool
$js_minify_windows : bool
$js_pipeline_include_externals : bool
$query : string
$timestamp : string
$type : string
$_definedProperties : array<string|int, mixed>
$_key : string

Methods

__construct() : mixed: Pipeline constructor.
__get() : mixed: Returns the value at specified offset.
__isset() : bool: Checks whether or not an offset exists.
__serialize() : array<string|int, mixed>
__set() : void: Assigns a value to the specified offset.
__toString() : string: Returns a string representation of this object.
__unserialize() : void
__unset() : void: Magic method to unset the attribute
defNestedProperty() : $this
defProperty() : $this
getKey() : string
getNestedProperty() : mixed
getProperty() : mixed
getType() : string
hasKey() : bool
hasNestedProperty() : bool
hasProperty() : bool
isRemoteLink() : bool: Determine whether a link is local or remote.
jsonSerialize() : array<string|int, mixed>: Implements JsonSerializable interface.
offsetExists() : bool: Whether or not an offset exists.
offsetGet() : mixed: Returns the value at specified offset.
offsetSet() : void: Assigns a value to the specified offset.
offsetUnset() : void: Unsets an offset.
renderCss() : bool|string: Minify and concatenate CSS
renderJs() : bool|string: Minify and concatenate JS files.
renderJs_Module() : bool|string: Minify and concatenate JS files.
setNestedProperty() : $this
setProperty() : $this
unsetNestedProperty() : $this
unsetProperty() : $this
cssRewrite() : string: Finds relative CSS urls() and rewrites the URL with an absolute one
doGetProperty() : mixed
doHasProperty() : bool
doSerialize() : array<string|int, mixed>
doSetProperty() : void
doUnserialize() : void
doUnsetProperty() : void
gatherLinks() : string: Download and concatenate the content of several links.
getElement() : mixed|null
getElements() : array<string|int, mixed>
getTypePrefix() : string
initObjectProperties() : void
isPropertyLoaded() : bool
jsRewrite() : string: Finds relative JS urls() and rewrites the URL with an absolute one
moveImports() : string: Moves @import statements to the top of the file per the CSS specification
offsetLoad() : mixed
offsetPrepare() : mixed
offsetSerialize() : mixed
renderAttributes() : string: Build an HTML attribute string from an array.
renderQueryString() : string: Render Querystring
setElements() : void
setKey() : $this
shouldMinify() : bool

CSS_ASSET


    protected
        mixed
    CSS_ASSET
    = 1

CSS_SOURCEMAP_REGEX


    protected
        mixed
    CSS_SOURCEMAP_REGEX
    = '{\/\*# (.*?) \*\/}'

CSS_URL_REGEX


    protected
        mixed
    CSS_URL_REGEX
    = '{url\(([\'\"]?)(.*?)\1\)|(@import)\s+([\'\"])(.*?)\4}'

FIRST_FORWARDSLASH_REGEX


    protected
        mixed
    FIRST_FORWARDSLASH_REGEX
    = '{^\/{1}\w}'

JS_ASSET


    protected
        mixed
    JS_ASSET
    = 2

JS_IMPORT_REGEX


    protected
        mixed
    JS_IMPORT_REGEX
    = '{import.+from\s?[\'|\"](.+?)[\'|\"]}'

JS_MODULE_ASSET


    protected
        mixed
    JS_MODULE_ASSET
    = 3

$asset


        protected
            string
    $asset

$assets_dir


        protected
            string
    $assets_dir

$assets_url


        protected
            string
    $assets_url

$attributes


        protected
            array<string|int, mixed>
    $attributes

$base_url


        protected
            string
    $base_url

$css_minify


        protected
            bool
    $css_minify
     = false

$css_minify_windows


        protected
            bool
    $css_minify_windows
     = false

$css_pipeline_include_externals


        protected
            bool
    $css_pipeline_include_externals
     = true

$css_rewrite


        protected
            bool
    $css_rewrite
     = false

$fetch_command


        protected
            Closure|null
    $fetch_command

Closure used by the pipeline to fetch assets.

Useful when file_get_contents() function is not available in your PHP installation or when you want to apply any kind of preprocessing to your assets before they get pipelined.

The closure will receive as the only parameter a string with the path/URL of the asset and it should return the content of the asset file as a string.

$js_minify


        protected
            bool
    $js_minify
     = false

$js_minify_windows


        protected
            bool
    $js_minify_windows
     = false

$js_pipeline_include_externals


        protected
            bool
    $js_pipeline_include_externals
     = true

$query


        protected
            string
    $query
     = ''

$timestamp


        protected
            string
    $timestamp

$type


        protected
        static    string
    $type

$_definedProperties


        private
            array<string|int, mixed>
    $_definedProperties

$_key


        private
            string
    $_key

__construct()

Pipeline constructor.


    public
                    __construct([array<string|int, mixed> $elements = [] ][, string|null $key = null ]) : mixed

Parameters

$elements : array<string|int, mixed> = []
$key : string|null = null

__get()

Returns the value at specified offset.


    public
                    __get(mixed $offset) : mixed

Parameters

$offset : mixed: The offset to retrieve.

#[ReturnTypeWillChange]

Return values

mixed —

Can return all value types.

__isset()

Checks whether or not an offset exists.


    public
                    __isset(mixed $offset) : bool

Parameters

$offset : mixed: An offset to check for.

#[ReturnTypeWillChange]

Return values

bool —

Returns TRUE on success or FALSE on failure.

__serialize()


    public
        final            __serialize() : array<string|int, mixed>

Return values

array<string|int, mixed>

__set()

Assigns a value to the specified offset.


    public
                    __set(mixed $offset, mixed $value) : void

Parameters

$offset : mixed: The offset to assign the value to.
$value : mixed: The value to set.

#[ReturnTypeWillChange]

__toString()

Returns a string representation of this object.


    public
                    __toString() : string

#[ReturnTypeWillChange]

Return values

string

__unserialize()


    public
        final            __unserialize(array<string|int, mixed> $data) : void

Parameters

$data : array<string|int, mixed>

__unset()

Magic method to unset the attribute


    public
                    __unset(mixed $offset) : void

Parameters

$offset : mixed: The name value to unset

#[ReturnTypeWillChange]

defNestedProperty()


    public
                    defNestedProperty(string $property, mixed $default[, string|null $separator = null ]) : $this

Parameters

$property : string: Object property to be updated.
$default : mixed: Default value.
$separator : string|null = null: Separator, defaults to '.'

Return values

$this

defProperty()


    public
                    defProperty(string $property, mixed $default) : $this

Parameters

$property : string: Object property to be defined.
$default : mixed: Default value.

Return values

$this

getKey()


    public
                    getKey() : string

Return values

string

getNestedProperty()


    public
                    getNestedProperty(string $property[, mixed|null $default = null ][, string|null $separator = null ]) : mixed

Parameters

$property : string: Object property to be fetched.
$default : mixed|null = null: Default value if property has not been set.
$separator : string|null = null: Separator, defaults to '.'

Return values

mixed —

Property value.

getProperty()


    public
                    getProperty(string $property[, mixed $default = null ]) : mixed

Parameters

$property : string: Object property to be fetched.
$default : mixed = null: Default value if property has not been set.

Return values

mixed —

Property value.

getType()


    public
                    getType([bool $prefix = true ]) : string

Parameters

$prefix : bool = true

Return values

string

hasKey()


    public
                    hasKey() : bool

Return values

bool

hasNestedProperty()


    public
                    hasNestedProperty(string $property[, string|null $separator = null ]) : bool

Parameters

$property : string: Object property name.
$separator : string|null = null: Separator, defaults to '.'

Return values

bool —

True if property has been defined (can be null).

hasProperty()


    public
                    hasProperty(string $property) : bool

Parameters

$property : string: Object property name.

Return values

bool —

True if property has been defined (can be null).

isRemoteLink()

Determine whether a link is local or remote.


    public
            static        isRemoteLink(string $link) : bool

Understands both "http://" and "https://" as well as protocol agnostic links "//"

Parameters

$link : string

Return values

bool

jsonSerialize()

Implements JsonSerializable interface.


    public
                    jsonSerialize() : array<string|int, mixed>

#[ReturnTypeWillChange]

Return values

array<string|int, mixed>

offsetExists()

Whether or not an offset exists.


    public
                    offsetExists(mixed $offset) : bool

Parameters

$offset : mixed: An offset to check for.

#[ReturnTypeWillChange]

Return values

bool —

Returns TRUE on success or FALSE on failure.

offsetGet()

Returns the value at specified offset.


    public
                    offsetGet(mixed $offset) : mixed

Parameters

$offset : mixed: The offset to retrieve.

#[ReturnTypeWillChange]

Return values

mixed —

Can return all value types.

offsetSet()

Assigns a value to the specified offset.


    public
                    offsetSet(mixed $offset, mixed $value) : void

Parameters

$offset : mixed: The offset to assign the value to.
$value : mixed: The value to set.

#[ReturnTypeWillChange]

offsetUnset()

Unsets an offset.


    public
                    offsetUnset(mixed $offset) : void

Parameters

$offset : mixed: The offset to unset.

#[ReturnTypeWillChange]

renderCss()

Minify and concatenate CSS


    public
                    renderCss(array<string|int, mixed> $assets, string $group[, array<string|int, mixed> $attributes = [] ]) : bool|string

Parameters

$assets : array<string|int, mixed>
$group : string
$attributes : array<string|int, mixed> = []

Return values

bool|string —

URL or generated content if available, else false

renderJs()

Minify and concatenate JS files.


    public
                    renderJs(array<string|int, mixed> $assets, string $group[, array<string|int, mixed> $attributes = [] ][, mixed $type = self::JS_ASSET ]) : bool|string

Parameters

$assets : array<string|int, mixed>
$group : string
$attributes : array<string|int, mixed> = []
$type : mixed = self::JS_ASSET

Return values

bool|string —

URL or generated content if available, else false

renderJs_Module()

Minify and concatenate JS files.


    public
                    renderJs_Module(array<string|int, mixed> $assets, string $group[, array<string|int, mixed> $attributes = [] ]) : bool|string

Parameters

$assets : array<string|int, mixed>
$group : string
$attributes : array<string|int, mixed> = []

Return values

bool|string —

URL or generated content if available, else false

setNestedProperty()


    public
                    setNestedProperty(string $property, mixed $value[, string|null $separator = null ]) : $this

Parameters

$property : string: Object property to be updated.
$value : mixed: New value.
$separator : string|null = null: Separator, defaults to '.'

Return values

$this

setProperty()


    public
                    setProperty(string $property, mixed $value) : $this

Parameters

$property : string: Object property to be updated.
$value : mixed: New value.

Return values

$this

unsetNestedProperty()


    public
                    unsetNestedProperty(string $property[, string|null $separator = null ]) : $this

Parameters

$property : string: Object property to be updated.
$separator : string|null = null: Separator, defaults to '.'

Return values

$this

unsetProperty()


    public
                    unsetProperty(string $property) : $this

Parameters

$property : string: Object property to be unset.

Return values

$this

cssRewrite()

Finds relative CSS urls() and rewrites the URL with an absolute one


    protected
                    cssRewrite(string $file, string $dir, bool $local) : string

Parameters

$file : string: the css source file
$dir : string: , $local relative path to the css file
$local : bool: is this a local or remote asset

Return values

string

doGetProperty()


    protected
                &    doGetProperty(string $property[, mixed $default = null ][, callable|bool $doCreate = false ]) : mixed

Parameters

$property : string: Object property to be fetched.
$default : mixed = null: Default value if property has not been set.
$doCreate : callable|bool = false: Set true to create variable.

Return values

mixed —

Property value.

doHasProperty()


    protected
                    doHasProperty(string $property) : bool

Parameters

$property : string: Object property name.

Return values

bool —

True if property has been defined (can be null).

doSerialize()


    protected
                    doSerialize() : array<string|int, mixed>

Return values

array<string|int, mixed>

doSetProperty()


    protected
                    doSetProperty(string $property, mixed $value) : void

Parameters

$property : string: Object property to be updated.
$value : mixed: New value.

doUnserialize()


    protected
                    doUnserialize(array<string|int, mixed> $serialized) : void

Parameters

$serialized : array<string|int, mixed>

doUnsetProperty()


    protected
                    doUnsetProperty(string $property) : void

Parameters

$property : string: Object property to be unset.

gatherLinks()

Download and concatenate the content of several links.


    protected
                    gatherLinks(array<string|int, mixed> $assets[, int $type = self::CSS_ASSET ]) : string

Parameters

$assets : array<string|int, mixed>
$type : int = self::CSS_ASSET

Return values

string

getElement()


    protected
                    getElement(string $property[, mixed|null $default = null ]) : mixed|null

Parameters

$property : string
$default : mixed|null = null

Return values

mixed|null

getElements()


    protected
                    getElements() : array<string|int, mixed>

Return values

array<string|int, mixed>

getTypePrefix()


    protected
                    getTypePrefix() : string

Return values

string

initObjectProperties()


    protected
                    initObjectProperties() : void

isPropertyLoaded()


    protected
                    isPropertyLoaded(string $property) : bool

Parameters

$property : string: Object property name.

Return values

bool —

True if property has been loaded.

jsRewrite()

Finds relative JS urls() and rewrites the URL with an absolute one


    protected
                    jsRewrite(string $file, string $dir, bool $local) : string

Parameters

$file : string: the css source file
$dir : string: local relative path to the css file
$local : bool: is this a local or remote asset

Return values

string

moveImports()

Moves @import statements to the top of the file per the CSS specification


    protected
                    moveImports(string $file) : string

Parameters

$file : string: the file containing the combined CSS files

Return values

string —

the modified file with any @imports at the top of the file

offsetLoad()


    protected
                    offsetLoad(string $offset, mixed $value) : mixed

Parameters

$offset : string
$value : mixed

offsetPrepare()


    protected
                    offsetPrepare(string $offset, mixed $value) : mixed

Parameters

$offset : string
$value : mixed

offsetSerialize()


    protected
                    offsetSerialize(string $offset, mixed $value) : mixed

Parameters

$offset : string
$value : mixed

renderAttributes()

Build an HTML attribute string from an array.


    protected
                    renderAttributes() : string

Return values

string

renderQueryString()

Render Querystring


    protected
                    renderQueryString([string|null $asset = null ]) : string

Parameters

$asset : string|null = null

Return values

string

setElements()


    protected
                    setElements(array<string|int, mixed> $elements) : void

Parameters

$elements : array<string|int, mixed>

setKey()


    protected
                    setKey(string $key) : $this

Parameters

$key : string

Return values

$this

shouldMinify()


    private
                    shouldMinify([string $type = 'css' ]) : bool

Parameters

$type : string = 'css'

Return values

bool

Pipeline extends PropertyObject in package Grav Common Assets uses AssetUtilsTrait

Table of Contents

Constants

Properties

Methods

Constants

CSS_ASSET

CSS_SOURCEMAP_REGEX

Tags

CSS_URL_REGEX

Tags

FIRST_FORWARDSLASH_REGEX

JS_ASSET

JS_IMPORT_REGEX

Tags

JS_MODULE_ASSET

Properties

$asset

$assets_dir

$assets_url

$attributes

$base_url

$css_minify

$css_minify_windows

$css_pipeline_include_externals

$css_rewrite

$fetch_command

$js_minify

$js_minify_windows

$js_pipeline_include_externals

$query

$timestamp

$type

$_definedProperties

$_key

Methods

__construct()

Parameters

__get()

Parameters

Attributes

Return values

__isset()

Parameters

Attributes

Return values

__serialize()

Return values

__set()

Parameters

Attributes

__toString()

Attributes

Return values

__unserialize()

Parameters

__unset()

Parameters

Attributes

defNestedProperty()

Parameters

Tags

Return values

defProperty()

Parameters

Return values

getKey()

Return values

getNestedProperty()

Parameters

Return values

getProperty()

Parameters

Return values

getType()

Parameters

Return values

hasKey()

Return values

hasNestedProperty()

Pipeline extends PropertyObject
in package

Grav

Common

Assets

uses AssetUtilsTrait