|
| 1 | +Simple QrCode |
| 2 | +======================== |
| 3 | + |
| 4 | +[](https://travis-ci.org/SimpleSoftwareIO/simple-qrcode) |
| 5 | +[](https://packagist.org/packages/simplesoftwareio/simple-qrcode) |
| 6 | +[](https://packagist.org/packages/simplesoftwareio/simple-qrcode) |
| 7 | +[](https://packagist.org/packages/simplesoftwareio/simple-qrcode) |
| 8 | +[](https://packagist.org/packages/simplesoftwareio/simple-qrcode) |
| 9 | + |
| 10 | +- [Introducción](#docs-introduction) |
| 11 | +- [Traducciones](#docs-translations) |
| 12 | +- [Configuración](#docs-configuration) |
| 13 | +- [Ideas Simples](#docs-ideas) |
| 14 | +- [Uso](#docs-usage) |
| 15 | +- [Helpers](#docs-helpers) |
| 16 | +- [Uso Común de QrCode](#docs-common-usage) |
| 17 | +- [Uso fuera de Laravel](#docs-outside-laravel) |
| 18 | + |
| 19 | +<a id="docs-introduction"></a> |
| 20 | +## Introducción |
| 21 | +Simple QrCode es un empaquetador de fácil uso para el popular framework Laravel basado en el gran trabajo proporcionado por [Bacon/BaconQrCode](https://github.com/Bacon/BaconQrCode). Hemos creado una interfaz que es familiar y fácil de usar para los usuarios de Laravel. |
| 22 | + |
| 23 | +<a id="docs-translations"></a> |
| 24 | +## Traducciones |
| 25 | +Estamos buscando usuarios que hablen Árabe, Francés, Coreano o Japonés para traducir este documento. Porfavor cread una pull request si podeis ayudar con una traducción! |
| 26 | + |
| 27 | +<a id="docs-configuration"></a> |
| 28 | +## Configuración |
| 29 | + |
| 30 | +#### Composer |
| 31 | + |
| 32 | +Primero, añadir el paquete Simple QrCode en su `require` en su archivo `composer.json`: |
| 33 | + |
| 34 | + "require": { |
| 35 | + "simplesoftwareio/simple-qrcode": "~1" |
| 36 | + } |
| 37 | + |
| 38 | +Luego, ejecutar el comando `composer update`. |
| 39 | + |
| 40 | +#### Service Provider |
| 41 | + |
| 42 | +###### Laravel 4 |
| 43 | +Registrar `SimpleSoftwareIO\QrCode\QrCodeServiceProvider` en su `app/config/app.php` dentro del array `providers`. |
| 44 | + |
| 45 | +###### Laravel 5 |
| 46 | +Registrar `SimpleSoftwareIO\QrCode\QrCodeServiceProvider::class` en su `config/app.php` dentro del array `providers`. |
| 47 | + |
| 48 | +#### Aliases |
| 49 | + |
| 50 | +###### Laravel 4 |
| 51 | +Finalmente, registrar `'QrCode' => 'SimpleSoftwareIO\QrCode\Facades\QrCode'` en su archivo de configuración `app/config/app.php` dentro del array `aliases`. |
| 52 | + |
| 53 | +###### Laravel 5 |
| 54 | +Finalmente, registrar `'QrCode' => SimpleSoftwareIO\QrCode\Facades\QrCode::class` en su archivo de configuración `config/app.php` dentro del array `aliases`. |
| 55 | + |
| 56 | +<a id="docs-ideas"></a> |
| 57 | +## Ideas Simples |
| 58 | + |
| 59 | +#### Print View |
| 60 | + |
| 61 | +Uno de los principales usos de este paquete es la posibilidad de disponer QrCodes en todas nuestras print views. Esto permite a nuestros usuarios volver a la página original después de imprimir simplemente escaneando el código. Todo esto es posible añadiendo lo siguiente en nuestro archivo `footer.blade.php´. |
| 62 | + |
| 63 | + <div class="visible-print text-center"> |
| 64 | + {!! QrCode::size(100)->generate(Request::url()); !!} |
| 65 | + <p>Escanéame para volver a la página principal.</p> |
| 66 | + </div> |
| 67 | + |
| 68 | +#### Incorporar un QrCode |
| 69 | + |
| 70 | +Puedes incorporar un código Qr en un e-mail para permitir a los usuarios un ágil escaneo. El ejemplo siguiente muestra como hacer esto con Laravel. |
| 71 | + |
| 72 | + //Inside of a blade template. |
| 73 | + <img src="{!!$message->embedData(QrCode::format('png')->generate('Incorpórame en un e-mail!'), 'QrCode.png', 'image/png')!!}"> |
| 74 | + |
| 75 | +<a id="docs-usage"></a> |
| 76 | +## Uso |
| 77 | + |
| 78 | +#### Uso Básico |
| 79 | + |
| 80 | +Usar el QrCode Generator es muy simple. La sintaxis más básica es: |
| 81 | + |
| 82 | + QrCode::generate('Transfórmame en un QrCode!'); |
| 83 | + |
| 84 | +Esto creara un código que diga "Transfórmame en un QrCode!" |
| 85 | + |
| 86 | +#### Generate |
| 87 | + |
| 88 | +`Generate` se usa para crear el QrCode. |
| 89 | + |
| 90 | + QrCode::generate('Transfórmame en un QrCode!'); |
| 91 | + |
| 92 | +>Atención! Este método debe de ser usado el último si se usa dentro de una cadena de comandos (chain). |
| 93 | +
|
| 94 | +`Generate` por defecto devolverá un string de una imagen SVG. Puedes imprimirla directamente en un navegador moderno con el sistema Blade de Laravel con el siguiente código: |
| 95 | + |
| 96 | + {!! QrCode::generate('Transfórmame en un QrCode!'); !!} |
| 97 | + |
| 98 | +El método `generate` tiene un segundo parámetro que aceptará un nombre de archivo y un directorio para guardar el QrCode. |
| 99 | + |
| 100 | + QrCode::generate('Transfórmame en un QrCode!', '../public/qrcodes/qrcode.svg'); |
| 101 | + |
| 102 | +#### Cambio de Formato |
| 103 | + |
| 104 | +>QrCode Generator por defecto devolverá una imagen SVG. |
| 105 | +
|
| 106 | +>Atención! El método `format` tiene que ser usado antes que cualquier opción de formato como `size`, `color`, `backgroundColor`, o `margin`. |
| 107 | +
|
| 108 | +Actualmente hay 3 formatos compatibles; PNG, EPS, and SVG. Para cambiar el formato usa el siguiente código: |
| 109 | + |
| 110 | + QrCode::format('png'); //Devolvera una imagen PNG |
| 111 | + QrCode::format('eps'); //Devolvera una imagen EPS |
| 112 | + QrCode::format('svg'); //Devolvera una imagen SVG |
| 113 | + |
| 114 | +#### Cambio de Tamaño |
| 115 | + |
| 116 | +>QrCode Generator devolverá por defecto el tamaño de píxels mínimo para crear el QrCode. |
| 117 | +
|
| 118 | +Puedes cambiar el tamaño de un QrCode usando el método `size`. Simplemente especifica el tamaño deseado en píxels usando el siguiente código: |
| 119 | + |
| 120 | + QrCode::size(100); |
| 121 | + |
| 122 | +#### Cambio de Color |
| 123 | + |
| 124 | +>Presta atención al cambiar el color de un QrCode. Algunos lectores tienen dificultades al leer QrCodes en color. |
| 125 | +
|
| 126 | +Todos los colores deben ser expresados en RGB (Red Green Blue). Puedes cambiar el color del QrCode usando el siguiente código: |
| 127 | + |
| 128 | + QrCode::color(255,0,255); |
| 129 | + |
| 130 | +Para cambiar el color del fondo usamos: |
| 131 | + |
| 132 | + QrCode::backgroundColor(255,255,0); |
| 133 | + |
| 134 | +#### Cambio de Márgenes |
| 135 | + |
| 136 | +Es posible cambiar el márgen alrededor del QrCode. Simplemente especificamos el márgen deseado usando el siguiente código: |
| 137 | + |
| 138 | + QrCode::margin(100); |
| 139 | + |
| 140 | +#### Corrección de Errores |
| 141 | + |
| 142 | +Cambiar el nivel de corrección de errores es fácil. Unicamente usa el siguiente código: |
| 143 | + |
| 144 | + QrCode::errorCorrection('H'); |
| 145 | + |
| 146 | +Las siguientes opciónes son compatibles con el método de `errorCorrection`. |
| 147 | + |
| 148 | +| Error Correction | Assurance Provided | |
| 149 | +| --- | --- | |
| 150 | +| L | 7% of codewords can be restored. | |
| 151 | +| M | 15% of codewords can be restored. | |
| 152 | +| Q | 25% of codewords can be restored. | |
| 153 | +| H | 30% of codewords can be restored. | |
| 154 | + |
| 155 | +>Cuanto más corrección de error se usa; el QrCode aumenta y puede almacenar menos datos. Para saber más sobre [corrección de error](http://en.wikipedia.org/wiki/QR_code#Error_correction). |
| 156 | +
|
| 157 | +#### Encoding |
| 158 | + |
| 159 | +Para cambiar la codificación de carácteres que se usa para crear un QrCode. Por defecto `ISO-8859-1` está seleccionado. Para saber más sobre [codificación de carácteres](http://en.wikipedia.org/wiki/Character_encoding) You can change this to any of the following: |
| 160 | + |
| 161 | + QrCode::encoding('UTF-8')->generate('Transfórmame en un QrCode con símbolos especiales ♠♥!!'); |
| 162 | + |
| 163 | +| Codificador de carácteres | |
| 164 | +| --- | |
| 165 | +| ISO-8859-1 | |
| 166 | +| ISO-8859-2 | |
| 167 | +| ISO-8859-3 | |
| 168 | +| ISO-8859-4 | |
| 169 | +| ISO-8859-5 | |
| 170 | +| ISO-8859-6 | |
| 171 | +| ISO-8859-7 | |
| 172 | +| ISO-8859-8 | |
| 173 | +| ISO-8859-9 | |
| 174 | +| ISO-8859-10 | |
| 175 | +| ISO-8859-11 | |
| 176 | +| ISO-8859-12 | |
| 177 | +| ISO-8859-13 | |
| 178 | +| ISO-8859-14 | |
| 179 | +| ISO-8859-15 | |
| 180 | +| ISO-8859-16 | |
| 181 | +| SHIFT-JIS | |
| 182 | +| WINDOWS-1250 | |
| 183 | +| WINDOWS-1251 | |
| 184 | +| WINDOWS-1252 | |
| 185 | +| WINDOWS-1256 | |
| 186 | +| UTF-16BE | |
| 187 | +| UTF-8 | |
| 188 | +| ASCII | |
| 189 | +| GBK | |
| 190 | +| EUC-KR | |
| 191 | + |
| 192 | +>Un error de `Could not encode content to ISO-8859-1` significa que se esta usando una codificación de carácteres incorrecta. Recomendamos `UTF-8` si no está seguro. |
| 193 | +
|
| 194 | +#### Merge |
| 195 | + |
| 196 | +El método `merge` une una imagen con un QrCode. Normalmente se usa para añadir logos en un QrCode. |
| 197 | + |
| 198 | + QrCode::merge($filename, $percentage, $absolute); |
| 199 | + |
| 200 | + //Genera un QrCode con una imagen en el centro. |
| 201 | + QrCode::format('png')->merge('path-to-image.png')->generate(); |
| 202 | + |
| 203 | + //Genera un QrCode con una imagen en el centro. La imagen ocupa un 30% del QrCode. |
| 204 | + QrCode::format('png')->merge('path-to-image.png', .3)->generate(); |
| 205 | + |
| 206 | + //Genera un QrCode con una imagen en el centro. La imagen ocupa un 30% del QrCode. |
| 207 | + QrCode::format('png')->merge('http://www.google.com/someimage.png', .3, true)->generate(); |
| 208 | + |
| 209 | +>El método `merge` sólo es compatible con PNG de momento. |
| 210 | +>El path del archivo es relativo al path de la app si `$absolute` equivale a `false`. Cambia esta variable a `true` para usar paths absolutos. |
| 211 | +
|
| 212 | +>Se debería usar un nivel alto de corrección de error al usar `merge` para asegurarse que el QrCode se sigue podiendo leer. Recomendamos usar `errorCorrection('H')`. |
| 213 | +
|
| 214 | + |
| 215 | + |
| 216 | +#### Merge Binary String |
| 217 | + |
| 218 | +El método `mergeString` se puede usar para conseguir el mismo resultado que con `merge`, con la diferencia que permite proveer una representación en string del archivo en vez de el filepath. Ésto es útil al trabajar con el `Storage` facade. Su interfaz es muy similar a la de `merge`. |
| 219 | + |
| 220 | + QrCode::mergeString(Storage::get('path/to/image.png'), $percentage); |
| 221 | + |
| 222 | + //Genera un QrCode con una imagen en el centro. |
| 223 | + QrCode::format('png')->mergeString(Storage::get('path/to/image.png'))->generate(); |
| 224 | + |
| 225 | + //Genera un QrCode con una imagen en el centro. La imagen ocupa un 30% del QrCode. |
| 226 | + QrCode::format('png')->mergeString(Storage::get('path/to/image.png'), .3)->generate(); |
| 227 | + |
| 228 | +>Igual que con `merge`, sólo PNG de momento. Lo mismo que con el nivel de corrección de error, alto nivel está recomendado. |
| 229 | +
|
| 230 | +#### Uso Avanzado |
| 231 | + |
| 232 | +Todos los métodos soportan chaining. El método `generate` tiene que ser el último y cualquier cambio de `format` tiene que ser llamado primero. Por ejemplo: |
| 233 | + |
| 234 | + QrCode::size(250)->color(150,90,10)->backgroundColor(10,14,244)->generate('Transfórmame en un QrCode!'); |
| 235 | + QrCode::format('png')->size(399)->color(40,40,40)->generate('Transfórmame en un QrCode!'); |
| 236 | + |
| 237 | +Puedes mostrar una imagen PNG sin guardar el archivo usando una string y eligiendo la codificación `base64_encode`. |
| 238 | + |
| 239 | + <img src="data:image/png;base64, {!! base64_encode(QrCode::format('png')->size(100)->generate('Transfórmame en un QrCode!')) !!} "> |
| 240 | + |
| 241 | +<a id="docs-helpers"></a> |
| 242 | +## Helpers |
| 243 | + |
| 244 | +#### Qué son los helpers? |
| 245 | + |
| 246 | +Los helpers son una manera fácil de crear QrCodes que causan que causan una acción en el lector al escanear. |
| 247 | + |
| 248 | +#### E-Mail |
| 249 | + |
| 250 | +Este helper genera un QrCode de e-mail que es capaz de rellenar dirección e-mail, asunto, y el cuerpo del e-mail. |
| 251 | + |
| 252 | + QrCode::email($to, $subject, $body); |
| 253 | + |
| 254 | + //Rellena la dirección |
| 255 | + QrCode::email('foo@bar.com'); |
| 256 | + |
| 257 | + //Rellena la dirección, el asunto y el cuerpo. |
| 258 | + QrCode::email('foo@bar.com', 'This is the subject.', 'This is the message body.'); |
| 259 | + |
| 260 | + //Solo rellena el asunto y el cuerpo del e-mail. |
| 261 | + QrCode::email(null, 'This is the subject.', 'This is the message body.'); |
| 262 | + |
| 263 | +#### Geo |
| 264 | + |
| 265 | +Este helper genera una latitude y una longitude que un teléfono puede leer y abrir la localización en Google Maps o alguna app similar. |
| 266 | + |
| 267 | + QrCode::geo($latitude, $longitude); |
| 268 | + |
| 269 | + QrCode::geo(37.822214, -122.481769); |
| 270 | + |
| 271 | +#### Phone Number |
| 272 | + |
| 273 | +Este helper genera un QrCode que puede ser escaneado y llama a un número de teléfono. |
| 274 | + |
| 275 | + QrCode::phoneNumber($phoneNumber); |
| 276 | + |
| 277 | + QrCode::phoneNumber('555-555-5555'); |
| 278 | + QrCode::phoneNumber('1-800-Laravel'); |
| 279 | + |
| 280 | +#### SMS (Mensajes de texto) |
| 281 | + |
| 282 | +Este helper crea SMS que pueden ser previamente rellenados con la dirección y el mensaje. |
| 283 | + |
| 284 | + QrCode::SMS($phoneNumber, $message); |
| 285 | + |
| 286 | + //Crea un mensaje de texto con el número rellenado. |
| 287 | + QrCode::SMS('555-555-5555'); |
| 288 | + |
| 289 | + //Crea un mensaje de texto con el número y el mensaje rellenados. |
| 290 | + QrCode::SMS('555-555-5555', 'Mensaje'); |
| 291 | + |
| 292 | +#### WiFi |
| 293 | + |
| 294 | +Este helpers crea QrCodes que conectan un teléfono a una red WiFI. |
| 295 | + |
| 296 | + QrCode::wiFi([ |
| 297 | + 'encryption' => 'WPA/WEP', |
| 298 | + 'ssid' => 'SSID de la red', |
| 299 | + 'password' => 'Password de la red', |
| 300 | + 'hidden' => 'Si la red tiene SSID oculta o no.' |
| 301 | + ]); |
| 302 | + |
| 303 | + //Conecta a una red abierta. |
| 304 | + QrCode::wiFi([ |
| 305 | + 'ssid' => 'Network Name', |
| 306 | + ]); |
| 307 | + |
| 308 | + //Conecta a una red abierta y oculta. |
| 309 | + QrCode::wiFi([ |
| 310 | + 'ssid' => 'Network Name', |
| 311 | + 'hidden' => 'true' |
| 312 | + ]); |
| 313 | + |
| 314 | + //Conecta a una red segura. |
| 315 | + QrCode::wiFi([ |
| 316 | + 'ssid' => 'Network Name', |
| 317 | + 'encryption' => 'WPA', |
| 318 | + 'password' => 'myPassword' |
| 319 | + ]); |
| 320 | + |
| 321 | +>WiFi scanning no es compatible con productos Apple. |
| 322 | +
|
| 323 | +<a id="docs-common-usage"></a> |
| 324 | +##Uso común de QrCode |
| 325 | + |
| 326 | +Puedes usar un prefijo de la tabla dentro de la sección `generate` para crear un QrCode que almacene informacion avanzada: |
| 327 | + |
| 328 | + QrCode::generate('http://www.simplesoftware.io'); |
| 329 | + |
| 330 | + |
| 331 | +| Usage | Prefix | Example | |
| 332 | +| --- | --- | --- | |
| 333 | +| Website URL | http:// | http://www.simplesoftware.io | |
| 334 | +| Secured URL | https:// | https://www.simplesoftware.io | |
| 335 | +| E-mail Address | mailto: | mailto:support@simplesoftware.io | |
| 336 | +| Phone Number | tel: | tel:555-555-5555 | |
| 337 | +| Text (SMS) | sms: | sms:555-555-5555 | |
| 338 | +| Text (SMS) With Pretyped Message | sms: | sms::I am a pretyped message | |
| 339 | +| Text (SMS) With Pretyped Message and Number | sms: | sms:555-555-5555:I am a pretyped message | |
| 340 | +| Geo Address | geo: | geo:-78.400364,-85.916993 | |
| 341 | +| MeCard | mecard: | MECARD:Simple, Software;Some Address, Somewhere, 20430;TEL:555-555-5555;EMAIL:support@simplesoftware.io; | |
| 342 | +| VCard | BEGIN:VCARD | [See Examples](https://en.wikipedia.org/wiki/VCard) | |
| 343 | +| Wifi | wifi: | wifi:WEP/WPA;SSID;PSK;Hidden(True/False) | |
| 344 | + |
| 345 | +<a id="docs-outside-laravel"></a> |
| 346 | +##Uso fuera de Laravel |
| 347 | + |
| 348 | +Puedes usar este paquete fuera de Laravel instanciando una nueva clase `BaconQrCodeGenerator`. |
| 349 | + |
| 350 | + use SimpleSoftwareIO\QrCode\BaconQrCodeGenerator; |
| 351 | + |
| 352 | + $qrcode = new BaconQrCodeGenerator; |
| 353 | + $qrcode->size(500)->generate('Crea un QrCode sin Laravel!'); |
0 commit comments