PHP Classes
elePHPant
Icontem

File: README_ES.md

Recommend this page to a friend!
  Classes of Josantonius  >  PHP Skeleton  >  README_ES.md  >  Download  
File: README_ES.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP Skeleton
Generate code and files for PHP project skeletons
Author: By
Last change:
Date: 2 months ago
Size: 5,276 bytes
 

Contents

Class file image Download

PHP __Package__ library

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

English version

Descripción.

Requisitos

Esta biblioteca 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 __Package__ library, simplemente escribe:

$ composer require __Vendor__/__Package__

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

$ composer require __Vendor__/__Package__ --prefer-source

También puedes clonar el repositorio completo con Git:

$ git clone https://github.com/__Vendor__/__PREFIX____Package__.git

O instalarlo manualmente:

Descargar __Vendor__.php:

$ wget https://raw.githubusercontent.com/__Vendor__/__PREFIX____Package__/master/src/__Package__.php

Métodos disponibles

- Descripción:

__Package__::sample($attr);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $attr | Descripción. | [TIPO DE DATO] | [Sí/No] | [] |

# Return (string) ? Descripción.

Cómo empezar

Para utilizar esta biblioteca con Composer:

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

use __Vendor__\__Package__\__Package__;

Si la instalaste manualmente, utiliza:

require_once __DIR__ . '/__Package__.php';

use __Vendor__\__Package__\__Package__;

Uso

Ejemplo de uso para esta biblioteca:

- Descripción:

Tests

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

$ git clone https://github.com/__Vendor__/__PREFIX____Package__.git

$ cd __PREFIX____Package__

$ 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

Contribuir

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

Pull requests

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

__year__ __Name__, __name__.com

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

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