|
| 1 | +# PHP Url library |
| 2 | + |
| 3 | +[](https://packagist.org/packages/josantonius/url) [](https://packagist.org/packages/josantonius/url) [](https://packagist.org/packages/josantonius/url) [](https://packagist.org/packages/josantonius/url) |
| 4 | + |
| 5 | +[Spanish version](README-ES.md) |
| 6 | + |
| 7 | +Librería para manipulación de urls. |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +- [Instalación](#instalación) |
| 12 | +- [Requisitos](#requisitos) |
| 13 | +- [Cómo empezar y ejemplos](#cómo-empezar-y-ejemplos) |
| 14 | +- [Métodos disponibles](#métodos-disponibles) |
| 15 | +- [Uso](#uso) |
| 16 | +- [Tests](#tests) |
| 17 | +- [Manejador de excepciones](#manejador-de-excepciones) |
| 18 | +- [Contribuir](#contribuir) |
| 19 | +- [Repositorio](#repositorio) |
| 20 | +- [Autor](#autor) |
| 21 | +- [Licencia](#licencia) |
| 22 | + |
| 23 | +--- |
| 24 | + |
| 25 | +### Instalación |
| 26 | + |
| 27 | +La mejor forma de instalar esta extensión es a través de [composer](http://getcomposer.org/download/). |
| 28 | + |
| 29 | +Para instalar PHP Url library, simplemente escribe: |
| 30 | + |
| 31 | + $ composer require Josantonius/Url |
| 32 | + |
| 33 | +### Requisitos |
| 34 | + |
| 35 | +Esta ĺibrería es soportada por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores. |
| 36 | + |
| 37 | +Para utilizar esta librería en HHVM (HipHop Virtual Machine) tendrás que activar los tipos escalares. Añade la siguiente ĺínea "hhvm.php7.scalar_types = true" en tu "/etc/hhvm/php.ini". |
| 38 | + |
| 39 | +### Cómo empezar y ejemplos |
| 40 | + |
| 41 | +Para utilizar esta librería, simplemente: |
| 42 | + |
| 43 | +```php |
| 44 | +require __DIR__ . '/vendor/autoload.php'; |
| 45 | + |
| 46 | +use Josantonius\Url\Url; |
| 47 | +``` |
| 48 | +### Métodos disponibles |
| 49 | + |
| 50 | +Métodos disponibles en esta librería: |
| 51 | + |
| 52 | +```php |
| 53 | +Url::getCurrentPage(); |
| 54 | +Url::getProtocol(); |
| 55 | +Url::isSSL(); |
| 56 | +Url::getDomain(); |
| 57 | +Url::getUri(); |
| 58 | +Url::getPort(); |
| 59 | +Url::addBackslash(); |
| 60 | +Url::previous(); |
| 61 | +Url::redirect(); |
| 62 | +Url::autoLink(); |
| 63 | +Url::generateSafeSlug(); |
| 64 | +Url::segment(); |
| 65 | +Url::getFirstSegment(); |
| 66 | +Url::getLastSegment(); |
| 67 | +``` |
| 68 | +### Uso |
| 69 | + |
| 70 | +Ejemplo de uso para esta librería: |
| 71 | + |
| 72 | +```php |
| 73 | +<?php |
| 74 | +require __DIR__ . '/vendor/autoload.php'; |
| 75 | + |
| 76 | +use Josantonius\Url\Url; |
| 77 | + |
| 78 | +print('<pre>'); |
| 79 | + |
| 80 | +var_dump(Url::getCurrentPage()); |
| 81 | +# string(35) "http://site.com:8081/user/login/" |
| 82 | + |
| 83 | +var_dump(Url::getProtocol()); |
| 84 | +# string(4) "http" |
| 85 | + |
| 86 | +var_dump(Url::isSSL()); |
| 87 | +# bool(false) |
| 88 | + |
| 89 | +var_dump(Url::getDomain()); |
| 90 | +# string(9) "site.com" |
| 91 | + |
| 92 | +var_dump(Url::getUri()); |
| 93 | +# string(14) "/user/login/" |
| 94 | + |
| 95 | +var_dump(Url::getPort()); |
| 96 | +# string(4) "8081" |
| 97 | + |
| 98 | +var_dump(Url::addBackslash('path/to/file')); |
| 99 | +# string(13) "path/to/file/" |
| 100 | + |
| 101 | +var_dump(Url::autoLink('https://github.com')); |
| 102 | +# string(51) "<a href="https://github.com">https://github.com</a>" |
| 103 | + |
| 104 | +var_dump(Url::autoLink('https://github.com', 'GitHub')); |
| 105 | +# string(39) "<a href="https://github.com">GitHub</a>" |
| 106 | + |
| 107 | +var_dump(Url::generateSafeSlug('https://github.com')); |
| 108 | +# string(16) "https-github-com" |
| 109 | + |
| 110 | +var_dump($segments = Url::segment()); |
| 111 | +/* |
| 112 | +array(2) { |
| 113 | + [0]=> |
| 114 | + string(5) "user" |
| 115 | + [1]=> |
| 116 | + string(6) "login" |
| 117 | +} |
| 118 | +*/ |
| 119 | +var_dump(Url::getFirstSegment($segments)); |
| 120 | +# string(5) "user" |
| 121 | + |
| 122 | +var_dump(Url::getLastSegment($segments)); |
| 123 | +# string(6) "login" |
| 124 | + |
| 125 | +print('</pre>'); |
| 126 | +``` |
| 127 | + |
| 128 | +### Tests |
| 129 | + |
| 130 | +Para utilizar la clase de [pruebas](tests), simplemente: |
| 131 | + |
| 132 | +```php |
| 133 | +<?php |
| 134 | +$loader = require __DIR__ . '/vendor/autoload.php'; |
| 135 | + |
| 136 | +$loader->addPsr4('Josantonius\\Url\\Tests\\', __DIR__ . '/vendor/josantonius/url/tests'); |
| 137 | + |
| 138 | +use Josantonius\Url\Tests\UrlTest; |
| 139 | +``` |
| 140 | +Métodos de prueba disponibles en esta librería: |
| 141 | + |
| 142 | +```php |
| 143 | +UrlTest::testGetCurrentPage(); |
| 144 | +UrlTest::testGetProtocol(); |
| 145 | +UrlTest::testIsSSL(); |
| 146 | +UrlTest::getDomain(); |
| 147 | +UrlTest::testGetUri(); |
| 148 | +UrlTest::testGetPort(); |
| 149 | +UrlTest::testAddBackslash(); |
| 150 | +UrlTest::testPrevious(); |
| 151 | +UrlTest::testRedirect(); |
| 152 | +UrlTest::testAutoLink(); |
| 153 | +UrlTest::testCustomAutoLink(); |
| 154 | +UrlTest::testGenerateSafeSlug(); |
| 155 | +UrlTest::testSegment(); |
| 156 | +UrlTest::testGetFirstSegment(); |
| 157 | +UrlTest::testGetLastSegment(); |
| 158 | +``` |
| 159 | + |
| 160 | +### Manejador de excepciones |
| 161 | + |
| 162 | +Esta librería utiliza [control de excepciones](src/Exception) que puedes personalizar a tu gusto. |
| 163 | +### Contribuir |
| 164 | +1. Comprobar si hay incidencias abiertas o abrir una nueva para iniciar una discusión en torno a un fallo o función. |
| 165 | +1. Bifurca la rama del repositorio en GitHub para iniciar la operación de ajuste. |
| 166 | +1. Escribe una o más pruebas para la nueva característica o expón el error. |
| 167 | +1. Haz cambios en el código para implementar la característica o reparar el fallo. |
| 168 | +1. Envía pull request para fusionar los cambios y que sean publicados. |
| 169 | + |
| 170 | +Esto está pensado para proyectos grandes y de larga duración. |
| 171 | + |
| 172 | +### Repositorio |
| 173 | + |
| 174 | +Los archivos de este repositorio se crearon y subieron automáticamente con [Reposgit Creator](https://github.com/Josantonius/BASH-Reposgit). |
| 175 | + |
| 176 | +### Autor |
| 177 | + |
| 178 | +Mantenido por [Josantonius](https://github.com/Josantonius/). |
| 179 | + |
| 180 | +### Licencia |
| 181 | + |
| 182 | +Este proyecto está licenciado bajo la **licencia MIT**. Consulta el archivo [LICENSE](LICENSE) para más información. |
0 commit comments