jield-webdev/laminas-assetmanager

An assetmanager module for Laminas

v4.0 2024-11-22 11:19 UTC

Requires

• php: ~8.3.0 || ~8.4.0
• assetic/framework: ^v3.1
• laminas/laminas-cache-storage-adapter-memory: ^2.4.x-dev
• laminas/laminas-cli: ^1.10
• laminas/laminas-eventmanager: ^3.14
• laminas/laminas-loader: ^2.11
• laminas/laminas-modulemanager: ^2.17
• laminas/laminas-mvc: ^3.8
• laminas/laminas-servicemanager: ^3.23
• laminas/laminas-stdlib: ^3.20
• scssphp/scssphp: ~1.13

Requires (Dev)

• iteaoffice/testing: ^5.0
• rector/rector: ^1.2

BSD-2-Clause

• Wesley Overdijk
• Marco Pivetta
• Johan van der Heide

• asset
• asset manager
• laminas

README

By Wesley Overdijk and Marco Pivetta

Updated to laminas by Johan van der Heide

Introduction

This module is intended for usage with a default directory structure of a Laminas Skeleton Application. It provides functionality to load assets and static files from your module directories through simple configuration. This allows you to avoid having to copy your files over to the public/ directory, and makes usage of assets very similar to what already is possible with view scripts, which can be overridden by other modules. In a nutshell, this module allows you to package assets with your module working out of the box.

Installation

1. Require assetmanager:

./composer.phar require jield-webdev/laminas-assetmanager
#when asked for a version, type "1.*".

Usage

Sample module config:

<?php

return [
    'asset_manager' => [
        'resolver_configs' => [
            'collections' => [
                'js/d.js' => [
                    'js/a.js',
                    'js/b.js',
                    'js/c.js',
                ],
            ],
            'paths'       => [
                __DIR__ . '/some/particular/directory',
            ],
            'map'         => [
                'specific-path.css' => __DIR__ . '/some/particular/file.css',
            ],
        ],
        'filters'          => [
            'js/d.js' => [
                [
                    // Note: You will need to require the classes used for the filters yourself.
                    'filter' => 'JSMin',
                ],
            ],
        ],
        'view_helper'      => [
            'cache'            => 'Application\Cache\Redis', // You will need to require the factory used for the cache yourself.
            'append_timestamp' => true,                      // optional, if false never append a query param
            'query_string'     => '_',                       // optional
        ],
        'caching'          => [
            'js/d.js' => [
                'cache' => 'Apc',
            ],
        ],
    ],
];

CLI usage:

Based on Laminas-CLI also support for asset warm up and purge is available.

./vendor/bin/laminas assetmanager:warmup --purge|-p --verbose|-v

This script will create all the assets and store them in the cache. If the purge flag is set, it will also purge the existing cache. This can be useful in a deployment scenario.

Please be careful, since this module will serve every file as-is, including PHP code.

The task list has been slimmed down a lot lately. However, there are still a couple of things that should be done.

• Renewing the cache