File: README-ES.md

Recommend this page to a friend!
  Classes of Josantonius  >  PHP Asset  >  README-ES.md  >  Download  
File: README-ES.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP Asset
Generate HTML to include JavaScript and CSS files
Author: By
Last change: Updated to 1.1.7 version
Updated to 1.1.7 version
Date: 3 years ago
Size: 9,479 bytes
 

 

Contents

Class file image Download

PHP Asset library

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

English version

Biblioteca PHP para manejo de estilos y scripts; Añadir, minimizar, unificar e imprimir.

Requisitos

Esta clase es soportada por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.

Instalación

La mejor forma de instalar esta extensión es a través de Composer.

Para instalar PHP Asset library, simplemente escribe:

$ composer require Josantonius/Asset

El comando anterior sólo instalará los archivos necesarios, si prefieres descargar todo el código fuente puedes utilizar:

$ composer require Josantonius/Asset --prefer-source

También puedes clonar el repositorio completo con Git:

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

O instalarlo manualmente:

Descargar Asset.php:

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

Descargar Json.php:

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

Métodos disponibles

Métodos disponibles en esta biblioteca:

- Agregar scripts o estilos:

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

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $type | 'script' o 'style' | string | Sí | |

| Atributo | clave | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | --- | | $data | | Settings | array | Sí | | | | name | ID único | string | Sí | | | | url | URL del archivo | string | Sí | | | | version | Versión | string | No | false | | | footer | Solo para scripts - Fijar en footer | boolean | No | true | | | attr | Solo para scripts - Atributo (defer/sync) | string | No | |

# Return (boolean)

- Comprobar si se ha añadido un estilo o script en particular:

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

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $type | 'script' o 'style' | string | Sí | | | $name | ID único | string | Sí | |

# Return (boolean)

- Eliminar script o estilo:

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

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $type | 'script' o 'style' | string | Sí | | | $name | ID único | string | Sí | |

# Return (boolean true)

- Unificar el contenido de los archivos en un único archivo:

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

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $uniqueID | Identificador único para el archivo unificado | string | Sí | | | $params | Urls de ruta | mixed | Sí | | | $minify | Minimizar el contenido del archivo | boolean | No | false |

# Return (boolean true)

- Salida de hojas de estilos:

Asset::outputStyles($output);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $output | Salida para estilos | string | No | '' |

# Return (string|false) ? Estilos o false

- Salida de hojas de scripts:

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

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $place | 'header' o 'footer' | string | Sí | | | $output | Salida para scripts | string | No | '' |

# Return (string|false) ? Scripts o false

Cómo empezar

Para utilizar esta clase con Composer:

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

use Josantonius\Asset\Asset;

Si la instalaste manualmente, utiliza:

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

use Josantonius\Asset\Asset;

Uso

Ejemplo de uso para esta biblioteca:

- Agregar estilos:

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'
]);

- Agregar 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
]);

- Verificar si los recursos se han añadido correctamente:

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

- Borrar recursos añadidos:

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

- Unificar:

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

- Unificar y minimizar:

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

- Unificar indicando diferentes rutas de urls para estilos y scripts:

Asset::unify('UniqueID', [

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

- Unificar y minimizar indicando diferentes rutas de urls para estilos y scripts:

Asset::unify('UniqueID', [

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

], true);

- Imprimir estilos:

echo Asset::outputStyles();

- Imprimir los scripts del footer:

echo Asset::outputScripts('footer');

- Imprimir los scripts del header:

echo Asset::outputScripts('header');

Tests

Para ejecutar las pruebas necesitarás Composer y seguir los siguientes pasos:

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

$ cd PHP-Algorithm

$ composer install

Ejecutar pruebas unitarias con PHPUnit:

$ composer phpunit

Ejecutar pruebas de estándares de código PSR2 con PHPCS:

$ composer phpcs

Ejecutar pruebas con PHP Mess Detector para detectar inconsistencias en el estilo de codificación:

$ composer phpmd

Ejecutar todas las pruebas anteriores:

$ composer tests

? Tareas pendientes

  • [ ] Añadir nueva funcionalidad.
  • [ ] Mejorar pruebas.
  • [ ] Mejorar documentación.
  • [ ] Refactorizar código para las reglas de estilo de código deshabilitadas. Ver phpmd.xml y .php_cs.dist.

Contribuir

Si deseas colaborar, puedes echar un vistazo a la lista de issues o tareas pendientes.

Pull requests

  • Fork and clone.
  • Ejecuta el comando `composer install` para instalar dependencias. Esto también instalará las dependencias de desarrollo.
  • Ejecuta el comando `composer fix` para estandarizar el código.
  • Ejecuta las pruebas.
  • Crea una nueva rama (branch), commit, push y envíame un pull request.

Repositorio

La estructura de archivos de este repositorio se creó con PHP-Skeleton.

Licencia

Este proyecto está licenciado bajo licencia MIT. Consulta el archivo LICENSE para más información.

Copyright

2016 - 2018 Josantonius, josantonius.com

Si te ha resultado útil, házmelo saber :wink:

Puedes contactarme en Twitter o a través de mi correo electrónico.


For more information send a message to info at phpclasses dot org.