Requirements

static 

flush()

Triggered early in the request when a flush is requested

static 

set_combined_files_enabled(bool $enable)

Enable combining of css/javascript files.

static bool

get_combined_files_enabled()

Checks whether combining of css/javascript files is enabled.

static 

set_combined_files_folder(string $folder)

Set the relative folder e.g. 'assets' for where to store combined files

static 

set_suffix_requirements($var)

Set whether to add caching query params to the requests for file-based requirements.

static bool

get_suffix_requirements()

Check whether we want to suffix requirements

static 

backend()

No description

static 

set_backend(Requirements_Backend $backend)

Setter method for changing the Requirements backend

static 

javascript(string $file)

Register the given JavaScript file as required.

static 

customScript(string $script, string|int $uniquenessID = null)

Register the given JavaScript code into the list of requirements

static array

get_custom_scripts()

Return all registered custom scripts

static 

customCSS(string $script, string|int $uniquenessID = null)

Register the given CSS styles into the list of requirements

static 

insertHeadTags(string $html, string|int $uniquenessID = null)

Add the following custom HTML code to the section of the page

static 

javascriptTemplate(string $file, string[]|int[] $vars, string|int $uniquenessID = null)

Include the content of the given JavaScript file in the list of requirements. Dollar-sign variables will be interpolated with values from $vars similar to a .ss template.

static 

css(string $file, string $media = null)

Register the given stylesheet into the list of requirements.

static 

themedCSS(string $name, string $module = null, string $media = null)

Registers the given themeable stylesheet as required.

static 

themedJavascript(string $name, string $module = null, string $type = null)

Registers the given themeable javascript as required.

static 

clear(string|int $fileOrID = null)

Clear either a single or all requirements

static 

restore()

Restore requirements cleared by call to Requirements::clear

static 

block(string|int $fileOrID)

Block inclusion of a specific file

static 

unblock(string|int $fileOrID)

Remove an item from the block list

static 

unblock_all()

Removes all items from the block list

static string

includeInHTML(string $templateFile, string $content)

Update the given HTML content with the appropriate include tags for the registered requirements. Needs to receive a valid HTML/XHTML template in the $content parameter, including a head and body tag.

static 

include_in_response(SS_HTTPResponse $response)

Attach requirements inclusion to X-Include-JS and X-Include-CSS headers on the given HTTP Response

static array

add_i18n_javascript(string $langDir, bool $return = false, bool $langOnly = false)

Add i18n files from the given javascript directory. SilverStripe expects that the given directory will contain a number of JavaScript files named by language: en_US.js, de_DE.js, etc.

static bool|void

combine_files(string $combinedFileName, array $files, string $media = null)

Concatenate several css or javascript files into a single dynamically generated file. This increases performance by fewer HTTP requests.

static array

get_combine_files()

Return all combined files; keys are the combined file names, values are lists of files being combined.

static 

delete_combined_files(string $combinedFileName = null)

Delete all dynamically generated combined files from the filesystem

static 

delete_all_combined_files()

Deletes all generated combined files in the configured combined files directory, but doesn't delete the directory itself

static 

clear_combined_files()

Re-sets the combined files definition. See {@link Requirements_Backend::clear_combined_files()}

static 

process_combined_files()

Do the heavy lifting involved in combining (and, in the case of JavaScript minifying) the combined files.

static 

set_write_js_to_body($var)

Set whether you want to write the JS to the body of the page rather than at the end of the head tag.

static 

set_force_js_to_bottom(bool $var)

Set whether to force the JavaScript to end of the body. Useful if you use inline script tags that don't rely on scripts included via {@link Requirements::javascript()).

static 

debug()

Output debugging information