Developed with love by KnpLabs Hire us for your project!
15

custom-assets-bundle

by adrenalinkin

Provides creating assets from the custom sources. Work like an assets:install

Custom Assets Bundle На Русском

Introduction

Bundle allows transfer required assets from the custom folders into public directory. Business logic similar to
standard Symfony command - assets:install. Also required YAML-configuration, which register one or more path
to the custom sources. After installation sources will be transfer into custom_assets folder under public part
of the project.

Installation

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable
version of this bundle:
text
composer require adrenalinkin/custom-assets-bundle

This command requires you to have Composer install globally.

Step 2: Enable the Bundle

Then, enable the bundle by updating your app/AppKernel.php file to enable the bundle:

<?php
// app/AppKernel.php

class AppKernel extends Kernel
{
    // ...

    public function registerBundles()
    {
        $bundles = [
            // ...

            new Linkin\Bundle\CustomAssetsBundle\LinkinCustomAssetsBundle(),
        ];

        return $bundles;
    }

    // ...
}

Step 3: Run command by Composer

Register the script in composer.json for call custom assets installation every time when composer requirements
has been install/update. To provide this behaviour add string
"Linkin\\Bundle\\CustomAssetsBundle\\Composer\\ScriptHandler::installCustomAssets",
after standard installAssets call. Example:

{
    "scripts": {
        "post-root-package-install": [
            "SymfonyStandard\\Composer::hookRootPackageInstall"
        ],
        "symfony-scripts": [
            "Incenteev\\ParameterHandler\\ScriptHandler::buildParameters",
            "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::buildBootstrap",
            "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::clearCache",
            "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets",

            "Linkin\\Bundle\\CustomAssetsBundle\\Composer\\ScriptHandler::installCustomAssets",

            "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installRequirementsFile",
            "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::prepareDeploymentTarget"
        ],
        "post-install-cmd": [
            "@symfony-scripts"
        ],
        "post-update-cmd": [
            "@symfony-scripts"
        ]
    }
}

Configuration

To start using Bundle your need to create configuration in the global project configuration app/config/config.yml
or register configuration in the custom_assets.yml in the any bundle of you project.
Simple configuration, which should transfer Bootstrap asset:

linkin_custom_assets:
    sources:
        bootstrap_dir: '../vendor/twbs/bootstrap/dist'

More information about configuration and configuration file in the part
Configuration description.

Usage

Usage example expect using simple configuration from the previous part.
After run the command custom_assets:install assets from folder
vendor/twbs/bootstrap/dist will be transfer into public folder of you project and will be available from the
web/custom_assets/bootstrap_dir.

Thus you you can access to the required filed, for example bootstrap.min.css:

    <link type="text/css" rel="stylesheet" href="{{ asset('custom_assets/bootstrap_dir/css/bootstrap.min.css') }}">

Commands

License

license

Copyright (c) Viktor Linkin since 2016

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
linkin_custom_assets:
sources:

# Prototype
name: []