PHP Classes
elePHPant
Icontem

PHP Asset: Generate HTML to include JavaScript and CSS files

Recommend this page to a friend!
  Info   View files Documentation   View files View files (21)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2017-12-06 (7 days ago) RSS 2.0 feedNot enough user ratingsTotal: 113 This week: 14All time: 8,745 This week: 58Up
Version License PHP version Categories
php-asset 1.1.6MIT/X Consortium ...5.6HTML, PHP 5
Description Author

This class can generate HTML to include JavaScript and CSS files.

It can add HTML tags to a page that would load JavaScript and CSS files from given URLs.

  Performance   Level  
Name: Josantonius is available for providing paid consulting. Contact Josantonius .
Classes: 19 packages by
Country: Spain Spain
Age: ???
All time rank: 227456 in Spain Spain
Week rank: 2 Up1 in Spain Spain Up
Innovation award
Innovation award
Nominee: 8x

Details

PHP Asset library

Latest Stable Version Latest Unstable Version License Codacy Badge Total Downloads Travis PSR2 PSR4 CodeCov

Versión en español

PHP library for handling styles and scripts; Add, minify, unify and print.

Requirements

This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.

Installation

The preferred way to install this extension is through Composer.

To install PHP Asset library, simply:

$ composer require Josantonius/Asset

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

$ composer require Josantonius/Asset --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/Josantonius/PHP-Asset.git

Or install it manually:

Download Asset.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-Asset/master/src/Asset.php

Download Json.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-Json/master/src/Json.php

Available Methods

Available methods in this library:

- Add scripts or styles:

Asset::add($type, $data);

| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $type | 'script' or 'style' | string | Yes | |

| Attribute | key | Description | Type | Required | Default | --- | --- | --- | --- | --- | --- | | $data | | Settings | array | Yes | | | | name | Unique ID | string | Yes | | | | url | Url to file | string | Yes | | | | version | Version | string | No | false | | | footer | Only for scripts - Attach in footer | boolean | No | true | | | attr | Only for scripts - Attribute (defer/sync) | string | No | |

# Return (boolean)

- Check if a particular style or script has been added:

Asset::isAdded($type, $name);

| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $type | 'script' or 'style' | string | Yes | | | $name | Unique ID | string | Yes | |

# Return (boolean)

- Remove script or style:

Asset::remove($type, $name);

| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $type | 'script' or 'style' | string | Yes | | | $name | Unique ID | string | Yes | |

# Return (boolean true)

- Sets whether to merge the content of files into a single file:

Asset::unify($uniqueID, $params, $minify);

| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $uniqueID | Unique identifier for unified file | string | Yes | | | $params | Path urls | mixed | Yes | | | $minify | Minimize file content | boolean | No | false |

# Return (boolean true)

- Output stylesheet:

Asset::outputStyles($output);

| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $output | Output for styles | string | No | '' |

# Return (string|false) ? Output or false

- Output scripts:

Asset::outputScripts($place, $output);

| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $place | 'header' or 'footer' | string | Yes | | | $output | Output for scripts | string | No | '' |

# Return (string|false) ? Output or false

Quick Start

To use this class with Composer:

require __DIR__ . '/vendor/autoload.php';

use Josantonius\Asset\Asset;

Or If you installed it manually, use it:

require_once __DIR__ . '/Asset.php';
require_once __DIR__ . '/Json.php';

use Josantonius\Asset\Asset;

Usage

Example of use for this library:

- Add styles:

Asset::add('style', [
    'name' => 'style-first',
    'url'  => 'http://josantonius.com/css/style.css',
]);

Asset::add('style', [
    'name'    => 'style-second',
    'url'     => 'http://josantonius.com/css/custom.css',
    'version' => '1.1.1'
]);

- Add scripts:

Asset::add('script', [
    'name' => 'script-first',
    'url'  => 'http://josantonius.com/js/script.js',
]);

Asset::add('script', [
    'name'    => 'script-second',
    'url'     => 'http://josantonius.com/js/custom.js',
    'attr'    => 'defer',
    'version' => '1.1.3',
    'footer'  => false
]);

- Check if resources have been added correctly:

Asset::isAdded('script', 'script-first');  // true
Asset::isAdded('style', 'style-first');    // true

- Delete added resources:

Asset::remove('style', 'style-first')    // true
Asset::remove('script', 'script-first'); // true

- Unify:

Asset::unify('UniqueID', 'http://josantonius.com/min/');

- Unify and minify:

Asset::unify('UniqueID', 'http://josantonius.com/min/', true);

- Unify specifying different url paths for styles and scripts:

Asset::unify('UniqueID', [

    'styles'  => 'http://josantonius.com/min/css/',
    'scripts' => 'http://josantonius.com/min/js/'
]);

- Unify and minify specifying different url paths for styles and scripts:

Asset::unify('UniqueID', [

    'styles'  => 'http://josantonius.com/min/css/',
    'scripts' => 'http://josantonius.com/min/js/'

], true);

- Output styles:

echo Asset::outputStyles();

- Output footer scripts:

echo Asset::outputScripts('footer');

- Output header scripts:

echo Asset::outputScripts('header');

Tests

To run tests you just need composer and to execute the following:

$ git clone https://github.com/Josantonius/PHP-Asset.git

$ cd PHP-Asset

$ composer install

Run unit tests with PHPUnit:

$ composer phpunit

Run PSR2 code standard tests with PHPCS:

$ composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:

$ composer phpmd

Run all previous tests:

$ composer tests

? TODO

  • [ ] Add new feature
  • [ ] Improve tests
  • [ ] Improve documentation
  • [ ] Refactor code

Contribute

If you would like to help, please take a look at the list of issues or the To Do checklist.

Pull requests

  • Fork and clone.
  • Run the command composer install to install the dependencies. This will also install the dev dependencies.
  • Run the command composer fix to excute code standard fixers.
  • Run the tests.
  • Create a branch, commit, push and send me a pull request.

Repository

The file structure from this repository was created with PHP-Skeleton.

License

This project is licensed under MIT license. See the LICENSE file for more info.

Copyright

2016 - 2017 Josantonius, josantonius.com

If you find it useful, let me know :wink:

You can contact me on Twitter or through my email.

  Files folder image Files  
File Role Description
Files folder imagesrc (2 files)
Files folder imagetests (3 files, 1 directory)
Accessible without login Plain text file .editorconfig Data Auxiliary data
Accessible without login Plain text file .php_cs.dist Example Example script
Accessible without login Plain text file .travis.yml Data Auxiliary data
Accessible without login Plain text file CHANGELOG.md Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file CONDUCT.md Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file phpcs.xml Data Auxiliary data
Accessible without login Plain text file phpmd.xml Data Auxiliary data
Accessible without login Plain text file phpunit.xml Data Auxiliary data
Accessible without login Plain text file README-ES.md Doc. Documentation
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  src  
File Role Description
  Plain text file Asset.php Class Class source
  Accessible without login Plain text file files.jsond Data Auxiliary data

  Files folder image Files  /  tests  
File Role Description
Files folder imageassets (2 directories)
  Plain text file ScriptsTest.php Class Class source
  Plain text file StylesTest.php Class Class source
  Plain text file UnifyFilesTest.php Class Class source

  Files folder image Files  /  tests  /  assets  
File Role Description
Files folder imagecss (2 files)
Files folder imagejs (2 files)

  Files folder image Files  /  tests  /  assets  /  css  
File Role Description
  Accessible without login Plain text file custom.css Data Auxiliary data
  Accessible without login Plain text file style.css Data Auxiliary data

  Files folder image Files  /  tests  /  assets  /  js  
File Role Description
  Accessible without login Plain text file custom.js Data Auxiliary data
  Accessible without login Plain text file script.js Data Auxiliary data

 Version Control Unique User Downloads Download Rankings  
 100%
Total:113
This week:14
All time:8,745
This week:58Up