fabiankoestring/assetmanager

An assetmanager module for Laminas.

5.0.0 2023-01-02 09:28 UTC

Requires

• php: ^7.3 || ^8.0
• assetic/framework: ~3.0.0
• laminas/laminas-eventmanager: ^2.6.3 || ^3.0.1
• laminas/laminas-loader: ^2.5.1
• laminas/laminas-modulemanager: ^2.7.2
• laminas/laminas-mvc: ^2.7.9 || ^3.0.2
• laminas/laminas-servicemanager: ^2.7.6 || ^3.1.1
• laminas/laminas-stdlib: ^3.2.1

Requires (Dev)

• laminas/laminas-cache: ~3.9.0
• laminas/laminas-cache-storage-adapter-filesystem: ~2.3.0
• laminas/laminas-cli: ~1.7.0
• laminas/laminas-http: ^2.5.4
• laminas/laminas-view: ^2.8.1
• phpunit/phpunit: ^8.5.8 || ^9.1
• squizlabs/php_codesniffer: ^3.5.6

BSD-2-Clause

• Wesley Overdijk
• Marco Pivetta

• asset
• asset manager
• laminas

README

By Wesley Overdijk and Marco Pivetta

Introduction

This module is intended for usage with a default directory structure of a LaminasSkeletonApplication. 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 rwoverdijk/assetmanager
# When asked for a version, type "2.*" when using Laminas. When using Zend Framework type "1.*"

Usage

Take a look at the wiki for a quick start and more information. A lot, if not all of the topics, have been covered in-dept there.

Sample module config:

<?php
return array(
    'asset_manager' => array(
        'resolver_configs' => array(
            'collections' => array(
                'js/d.js' => array(
                    'js/a.js',
                    'js/b.js',
                    'js/c.js',
                ),
            ),
            'paths' => array(
                __DIR__ . '/some/particular/directory',
            ),
            'map' => array(
                'specific-path.css' => __DIR__ . '/some/particular/file.css',
            ),
        ),
        'filters' => array(
            'js/d.js' => array(
                array(
                    // Note: You will need to require the classes used for the filters yourself.
                    'filter' => 'JSMin',
                ),
            ),
        ),
        'view_helper' => array(
            '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' => array(
            'js/d.js' => array(
                'cache'     => 'Apc',
            ),
        ),
    ),
);

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

Questions / support

If you're having trouble with the asset manager there are a couple of resources that might be of help.

• Join us on gitter
• The FAQ wiki page, where you'll perhaps find your answer.
• RWOverdijk at irc.freenode.net #zftalk.dev or #spoonx
• Issue tracker. (Please try to not submit unrelated issues).

Todo

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