The ezcss and ezscript operators #

This page is a reference for designers and developers. All eight operators are defined by the class ezjscPackerTemplateFunctions in extension/ezjscore/autoloads/ezjscpackertemplatefunctions.php and registered in extension/ezjscore/autoloads/eztemplateautoload.php.

Contents #

1. Signatures
2. require, load and plain: how they differ
3. Pack levels
4. File names
5. Examples

Signatures #

ezscript[_require|_load]( array|string scripts
                          [, string type='text/javascript'
                          [, string language=''
                          [, string charset='utf-8'
                          [, int pack_level=2 ]]]] )

ezcss[_require|_load]( array|string css_files
                       [, string media='all'
                       [, string type='text/css'
                       [, string rel='stylesheet'
                       [, string charset=''
                       [, int pack_level=3 ]]]]] )

ezscriptfiles( array|string scripts [, int pack_level=2 [, bool ignore_loaded=false ]] )
ezcssfiles( array|string css_files [, int pack_level=3 [, bool ignore_loaded=false ]] )

(from the class's header comment; charset on stylesheets is deprecated as not valid HTML.) Arrays may be nested; they are flattened, so ezini() lists can be passed inside an array.

require, load and plain: how they differ #

Because the remembered files are kept in the persistent variable of the content view, a full view served from the view cache still delivers its required files to the pagelayout.

Pack levels #

The level is forced to 0 when site.ini [TemplateSettings] DevelopmentMode=enabled, unless ezjscore.ini [eZJSCore] Packer is set (to enabled, disabled or a level 0 to 3). Stylesheets: relative url() paths are rewritten to absolute ones when packed, so images and fonts still load.

File names #

• 'main.css': found in stylesheets/ of the design cascade (javascript/ for scripts).
• 'sub/file.css': a subfolder.
• '/extension/x/design/y/stylesheets/file.css': a leading / means a path from the installation root, outside the usual subfolder.
• 'ezjsc::jquery', 'ezjsc::jqueryUI': generators of ezjscore ([ezjscServer_ezjsc] in ezjscore.ini); a name with :: calls a server function instead of reading a file.

A file that is not found is skipped with a warning in the debug output ("Could not find: ..."), not an error.

Examples #

{* all stylesheets of the design, plus whatever views required *}
{ezcss_load( array( 'base.css', 'components.css' ) )}

{* merged but not minified: keeps vendor CSS byte-identical *}
{ezcss_load( array( 'vendor.css' ), 'all', 'text/css', 'stylesheet', '', 1 )}

{* jQuery and the site script at the end of the body *}
{ezscript_load( array( 'ezjsc::jquery', 'site.js' ) )}

{* deferred bundle *}
{foreach ezscriptfiles( array( 'late.js' ), 2, true() ) as $url}<script defer src="{$url}"></script>{/foreach}

Related pages #

• Loading stylesheets
• Loading JavaScript
• The packer
• ezjscore
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.