PHP Str library

Spanish version

Biblioteca PHP para manejo de strings.

• Requisitos
• Instalación
• Métodos disponibles
• Cómo empezar
• Uso
• Tests
• Tareas pendientes
• Contribuir
• Repositorio
• Licencia
• Copyright

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 Str library, simplemente escribe:

$ composer require Josantonius/Str

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

$ composer require Josantonius/Str --prefer-source

También puedes clonar el repositorio completo con Git:

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

O instalarlo manualmente:

Descargar Str.php:

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

Métodos disponibles

Métodos disponibles en esta biblioteca:

- Comprobar si la cadena comienza con un valor determinado:

Str::startsWith($search, $string);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $search | La cadena a buscar. | string | Yes | | | $string | El string donde buscar. | string | Yes | |

# Return (boolean)

- Comprobar si la cadena acaba con un valor determinado:

Str::endsWith($search, $string);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $search | La cadena a buscar. | string | Yes | | | $string | El string donde buscar. | string | Yes | |

# Return (boolean)

Cómo empezar

Para utilizar esta biblioteca con Composer:

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

use Josantonius\Str\Str;

Si la instalaste manualmente, utiliza:

require_once __DIR__ . '/Str.php';

use Josantonius\Str\Str;

Uso

Ejemplo de uso para esta biblioteca:

- Comprobar si la cadena comienza con un valor determinado:

Str::startsWith("Hello", "Hello world");

- Comprobar si la cadena acaba con un valor determinado:

Str::endsWith("world", "Hello World");

Tests

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

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

$ cd PHP-Str

$ 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

2017 - 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.