AssetCollector implements SingletonInterface

The Asset Collector is responsible for keeping track of - everything within <script> tags: javascript files and inline javascript code - inline CSS and CSS files

The goal of the asset collector is to:

  • utilize a single "runtime-based" store for adding assets of certain kinds that are added to the output
  • allow to deal with assets from non-cacheable plugins and cacheable content in the Frontend
  • reduce the "power" and flexibility (I'd say it's a burden) of the "god class" PageRenderer.
  • reduce the burden of storing everything in PageRenderer

As a side-effect this allows to:

  • Add a single CSS snippet or CSS file per content block, but assure that the CSS is only added once to the output.

Note on the implementation:

  • We use a Singleton to make use of the AssetCollector throughout Frontend process (similar to PageRenderer).
  • Although this is not optimal, I don't see any other way to do so in the current code.

Table of Contents

Interfaces

SingletonInterface
"empty" interface for singletons (marker interface pattern)

Properties

$inlineJavaScripts  : array<string|int, mixed>
$inlineStyleSheets  : array<string|int, mixed>
$javaScripts  : array<string|int, mixed>
$media  : array<string|int, mixed>
$styleSheets  : array<string|int, mixed>

Methods

addInlineJavaScript()  : AssetCollector
addInlineStyleSheet()  : AssetCollector
addJavaScript()  : AssetCollector
addMedia()  : AssetCollector
addStyleSheet()  : AssetCollector
getInlineJavaScripts()  : array<string|int, mixed>
getInlineStyleSheets()  : array<string|int, mixed>
getJavaScripts()  : array<string|int, mixed>
getMedia()  : array<string|int, mixed>
getState()  : array<string|int, mixed>
getStyleSheets()  : array<string|int, mixed>
removeInlineJavaScript()  : self
removeInlineStyleSheet()  : self
removeJavaScript()  : self
removeMedia()  : self
removeStyleSheet()  : self
updateState()  : void
filterAssetsPriority()  : array<string|int, mixed>

Properties

$inlineJavaScripts

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

$inlineStyleSheets

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

$javaScripts

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

$media

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

$styleSheets

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

Methods

addInlineJavaScript()

public addInlineJavaScript(string $identifier, string $source[, array<string|int, mixed> $attributes = [] ][, array<string|int, mixed> $options = [] ]) : AssetCollector
Parameters
$identifier : string
$source : string

JavaScript code

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

additional HTML <script> tag attributes

$options : array<string|int, mixed> = []

['priority' => true] means rendering before other tags

Return values
AssetCollector

addInlineStyleSheet()

public addInlineStyleSheet(string $identifier, string $source[, array<string|int, mixed> $attributes = [] ][, array<string|int, mixed> $options = [] ]) : AssetCollector
Parameters
$identifier : string
$source : string

stylesheet code

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

additional HTML tag attributes

$options : array<string|int, mixed> = []

['priority' => true] means rendering before other tags

Return values
AssetCollector

addJavaScript()

public addJavaScript(string $identifier, string $source[, array<string|int, mixed> $attributes = [] ][, array<string|int, mixed> $options = [] ]) : AssetCollector
Parameters
$identifier : string
$source : string

URI to JavaScript file (allows EXT: syntax)

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

additional HTML <script> tag attributes

$options : array<string|int, mixed> = []

['priority' => true] means rendering before other tags

Return values
AssetCollector

addMedia()

public addMedia(string $fileName, array<string|int, mixed> $additionalInformation) : AssetCollector
Parameters
$fileName : string
$additionalInformation : array<string|int, mixed>

One dimensional hash map (array with non numerical keys) with scalar values

Return values
AssetCollector

addStyleSheet()

public addStyleSheet(string $identifier, string $source[, array<string|int, mixed> $attributes = [] ][, array<string|int, mixed> $options = [] ]) : AssetCollector
Parameters
$identifier : string
$source : string

URI to stylesheet file (allows EXT: syntax)

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

additional HTML tag attributes

$options : array<string|int, mixed> = []

['priority' => true] means rendering before other tags

Return values
AssetCollector

getInlineJavaScripts()

public getInlineJavaScripts([bool|null $priority = null ]) : array<string|int, mixed>
Parameters
$priority : bool|null = null
Return values
array<string|int, mixed>

getInlineStyleSheets()

public getInlineStyleSheets([bool|null $priority = null ]) : array<string|int, mixed>
Parameters
$priority : bool|null = null
Return values
array<string|int, mixed>

getJavaScripts()

public getJavaScripts([bool|null $priority = null ]) : array<string|int, mixed>
Parameters
$priority : bool|null = null
Return values
array<string|int, mixed>

getMedia()

public getMedia() : array<string|int, mixed>
Return values
array<string|int, mixed>

getState()

public getState() : array<string|int, mixed>
Internal
Return values
array<string|int, mixed>

getStyleSheets()

public getStyleSheets([bool|null $priority = null ]) : array<string|int, mixed>
Parameters
$priority : bool|null = null
Return values
array<string|int, mixed>

removeInlineJavaScript()

public removeInlineJavaScript(string $identifier) : self
Parameters
$identifier : string
Return values
self

removeInlineStyleSheet()

public removeInlineStyleSheet(string $identifier) : self
Parameters
$identifier : string
Return values
self

removeJavaScript()

public removeJavaScript(string $identifier) : self
Parameters
$identifier : string
Return values
self

removeMedia()

public removeMedia(string $identifier) : self
Parameters
$identifier : string
Return values
self

removeStyleSheet()

public removeStyleSheet(string $identifier) : self
Parameters
$identifier : string
Return values
self

updateState()

public updateState(array<string|int, mixed> $newState) : void
Parameters
$newState : array<string|int, mixed>
Internal

filterAssetsPriority()

protected filterAssetsPriority(array<string|int, mixed> &$assets, bool|null $priority) : array<string|int, mixed>
Parameters
$assets : array<string|int, mixed>

Takes a reference to prevent a deep copy. The variable is not changed (const).

$priority : bool|null

null: no filter; else filters for the given priority

Return values
array<string|int, mixed> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results