|
| 1 | + |
| 2 | +Simple QrCode |
| 3 | +======================== |
| 4 | + |
| 5 | +[](https://travis-ci.org/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 | +[](https://packagist.org/packages/simplesoftwareio/simple-qrcode) |
| 10 | + |
| 11 | +- [Introduction](#docs-introduction) |
| 12 | +- [Traductions](#docs-translations) |
| 13 | +- [Configuration](#docs-configuration) |
| 14 | +- [Utilisations Simples](#docs-ideas) |
| 15 | +- [Usage](#docs-usage) |
| 16 | +- [Helpers](#docs-helpers) |
| 17 | +- [Usage Courant De QrCode](#docs-common-usage) |
| 18 | +- [Usage Hors De Laravel](#docs-outside-laravel) |
| 19 | + |
| 20 | +<a id="docs-introduction"></a> |
| 21 | +## Introduction |
| 22 | +Simple QrCode est un adaptateur facile d'utilisation pour le framework Laravel et qui s'appuie sur le magnifique travail fourni par [Bacon/BaconQrCode](https://github.com/Bacon/BaconQrCode). Nous avons conçu une interface intuitive, facile d'installation et familière aux utilisateurs de Laravel. |
| 23 | + |
| 24 | +<a id="docs-translations"></a> |
| 25 | +## Traductions |
| 26 | +Nous recherchons des utilisateurs parlant arabe, espagnol, français, coréen ou japonnais pour nous aider à traduire cette documentation. Si vous vous en sentez capable, créez une pull request ! |
| 27 | + |
| 28 | +<a id="docs-configuration"></a> |
| 29 | +## Configuration |
| 30 | + |
| 31 | +#### Composer |
| 32 | + |
| 33 | +Commencez par ajouter le paquet QrCode à la section `require` de votre fichier `composer.json`: |
| 34 | + |
| 35 | + "require": { |
| 36 | + "simplesoftwareio/simple-qrcode": "~1" |
| 37 | + } |
| 38 | + |
| 39 | +Lancez ensuite la commande `composer update`. |
| 40 | + |
| 41 | +#### Service Provider |
| 42 | + |
| 43 | +###### Laravel 4 |
| 44 | +Ajouter l'entrée `SimpleSoftwareIO\QrCode\QrCodeServiceProvider` au tableau `providers` du fichier de configuration `app/config/app.php`. |
| 45 | + |
| 46 | +###### Laravel 5 |
| 47 | +Ajouter l'entrée `SimpleSoftwareIO\QrCode\QrCodeServiceProvider::class` au tableau `providers` du fichier de configuration `config/app.php`. |
| 48 | + |
| 49 | +#### Alias |
| 50 | + |
| 51 | +###### Laravel 4 |
| 52 | +Enfin, ajoutez l'entrée `'QrCode' => 'SimpleSoftwareIO\QrCode\Facades\QrCode'` au tableau `aliases` du fichier de configuration `app/config/app.php`. |
| 53 | + |
| 54 | +###### Laravel 5 |
| 55 | +Enfin, ajoutez l'entrée `'QrCode' => SimpleSoftwareIO\QrCode\Facades\QrCode::class` au tableau `aliases` du fichier de configuration `config/app.php`. |
| 56 | + |
| 57 | +<a id="docs-ideas"></a> |
| 58 | +## Utilisations Simples |
| 59 | + |
| 60 | +#### Print View |
| 61 | + |
| 62 | +L'un des pricipaux usages que nous faisons de ce paquet et d'avoir des QrCodes dans toutes nos vues d'impression. Cela donne la possibilité à nos clients qui le flashent de revenir à la page d'origine du document après que celui-ci a été imprimé. Nous obtenons cette fonctionnalité en ajoutant le code suivant au fichier footer.blade.php. |
| 63 | + |
| 64 | + <div class="visible-print text-center"> |
| 65 | + {!! QrCode::size(100)->generate(Request::url()); !!} |
| 66 | + <p>Flashez-moi pour revenir à la page d'origine.</p> |
| 67 | + </div> |
| 68 | + |
| 69 | +#### Embarquer Un QrCode |
| 70 | + |
| 71 | +Vous pouvez embarquer un qrcode dans un courriel pour permettre à vos utilisateurs de le flasher. Voici un exemple pour mettre ceci en œuvre dans Laravel : |
| 72 | + |
| 73 | + // Dans un template blade. |
| 74 | + <img src="{!!$message->embedData(QrCode::format('png')->generate('Embarquez-moi dans un courriel!'), 'QrCode.png', 'image/png')!!}"> |
| 75 | + |
| 76 | +<a id="docs-usage"></a> |
| 77 | +## Usage |
| 78 | + |
| 79 | +#### Usage De Base |
| 80 | + |
| 81 | +L'utilisation du Générateur de QrCode est très simple. La syntaxe minimale est : |
| 82 | + |
| 83 | + QrCode::generate('Transformez-moi en QrCode !'); |
| 84 | + |
| 85 | +Cela créera un QrCode qui dit "Transformez-moi en QrCode !" |
| 86 | + |
| 87 | +#### Generate |
| 88 | + |
| 89 | +`Generate` sert à fabriquer un QrCode. |
| 90 | + |
| 91 | + QrCode::generate('Transformez-moi en QrCode !'); |
| 92 | + |
| 93 | +>Attention! Cette méthode doit être appelée en dernier si vous l'utilisez dans un appel chaîné. |
| 94 | +
|
| 95 | +Par défaut, `Generate` retournera le contenu d'une image SVG sous forme de chaîne. Vous pouvez afficher cette image directement avec un navigateur moderne dans un template Blade de Laravel de cette façon : |
| 96 | + |
| 97 | + {!! QrCode::generate('Transformez-moi en QrCode !'); !!} |
| 98 | + |
| 99 | +La méthode `generate` accepte un second paramètre pour définir un nom de fichier où enregistrer le QrCode. |
| 100 | + |
| 101 | + QrCode::generate('Transformez-moi en QrCode !', '../public/qrcodes/qrcode.svg'); |
| 102 | + |
| 103 | +#### Changement De Format |
| 104 | + |
| 105 | +>Le générateur de QrCode est prévu pour retourner une image SVG par défaut. |
| 106 | +
|
| 107 | +>Attention! La méthode `format` doit être appelée avant toute autre option de formatage, telles que `size`, `color`, `backgroundColor` et `margin`. |
| 108 | +
|
| 109 | +Trois formats sont actuellement supportés : PNG, EPS et SVG. Pour changer de format, utilisez le code suivant : |
| 110 | + |
| 111 | + QrCode::format('png'); // retourne une image PNG |
| 112 | + QrCode::format('eps'); // retourne une image EPS |
| 113 | + QrCode::format('svg'); // retourne une image SVG |
| 114 | + |
| 115 | +#### Changement De Taille |
| 116 | + |
| 117 | +>Le générateur de QrCode retournera par défaut le QrCode dans la plus petite taille possible en pixels. |
| 118 | +
|
| 119 | +Vous pouvez changer la taille du QrCode par la méthode `size` qui prend comme paramètre la taille désirée en pixels : |
| 120 | + |
| 121 | + QrCode::size(100); |
| 122 | + |
| 123 | +#### Changement De Couleur |
| 124 | + |
| 125 | +>Changez les couleurs de vos QrCode avec précaution car certains lecteurs rencontrent des difficultés avec les QrCodes en couleur. |
| 126 | +
|
| 127 | +Toutes les couleurs doivent être exprimées en RGB (rouge, vert, bleu). Vous pouvez changer la couleur de trait du QrCode par la méthode `color` : |
| 128 | + |
| 129 | + QrCode::color(255,0,255); |
| 130 | + |
| 131 | +La couleur de fond peut être définie de la même façon par la méthode `backgroundColor` : |
| 132 | + |
| 133 | + QrCode::backgroundColor(255,255,0); |
| 134 | + |
| 135 | +#### Changement Des Marges |
| 136 | + |
| 137 | +Vous pouvez définir une marge autour du QrCode par la méthode `margin` : |
| 138 | + |
| 139 | + QrCode::margin(100); |
| 140 | + |
| 141 | +#### Correction D'Erreur |
| 142 | + |
| 143 | +Il est très aisé de changer le niveau de correction d'erreur. Utilisez la syntaxe suivante : |
| 144 | + |
| 145 | + QrCode::errorCorrection('H'); |
| 146 | + |
| 147 | +Voici la liste des options supportées pour la méthode `errorCorrection`. |
| 148 | + |
| 149 | +| Correction d'Erreur | Capacité De Correction | |
| 150 | +| --- | --- | |
| 151 | +| L | 7% de redondance. | |
| 152 | +| M | 15% de redondance. | |
| 153 | +| Q | 25% de redondance. | |
| 154 | +| H | 30% de redondance. | |
| 155 | + |
| 156 | +>L'élévation du niveau de correction d'erreur se fait au détriment de la taille du QrCode et de la quantité de données qu'il peut stocker. Pour en savoir plus, consultez [error correction](http://en.wikipedia.org/wiki/QR_code#Error_correction) (en anglais). |
| 157 | +
|
| 158 | +#### Encodage |
| 159 | + |
| 160 | +La norme de codage par défaut des caractères contenus dans le QrCode est l'`ISO-8859-1`. Pour en savoir plus sur le codage, voyez [codage des caractères](http://fr.wikipedia.org/wiki/Codage_des_caractères). Vous pouvez changer le codage par le code suivant : |
| 161 | + |
| 162 | + QrCode::encoding('UTF-8')->generate('Transformez-moi en QrCode avec des symboles ♠♥!!'); |
| 163 | + |
| 164 | +| Codage Des Caractères | |
| 165 | +| --- | |
| 166 | +| ISO-8859-1 | |
| 167 | +| ISO-8859-2 | |
| 168 | +| ISO-8859-3 | |
| 169 | +| ISO-8859-4 | |
| 170 | +| ISO-8859-5 | |
| 171 | +| ISO-8859-6 | |
| 172 | +| ISO-8859-7 | |
| 173 | +| ISO-8859-8 | |
| 174 | +| ISO-8859-9 | |
| 175 | +| ISO-8859-10 | |
| 176 | +| ISO-8859-11 | |
| 177 | +| ISO-8859-12 | |
| 178 | +| ISO-8859-13 | |
| 179 | +| ISO-8859-14 | |
| 180 | +| ISO-8859-15 | |
| 181 | +| ISO-8859-16 | |
| 182 | +| SHIFT-JIS | |
| 183 | +| WINDOWS-1250 | |
| 184 | +| WINDOWS-1251 | |
| 185 | +| WINDOWS-1252 | |
| 186 | +| WINDOWS-1256 | |
| 187 | +| UTF-16BE | |
| 188 | +| UTF-8 | |
| 189 | +| ASCII | |
| 190 | +| GBK | |
| 191 | +| EUC-KR | |
| 192 | + |
| 193 | +>Une erreur du type `Could not encode content to ISO-8859-1` signifie qu'un mauvais codage est utilisé. Nous recommendons `UTF-8` si vous n'êtes pas sûr. |
| 194 | +
|
| 195 | +#### Merge |
| 196 | + |
| 197 | +La méthode `merge` fusionne une image sur un QrCode. C'est une pratique courante pour placer un logo dans un QrCode. |
| 198 | + |
| 199 | + QrCode::merge($nom_de_fichier, $pourcentage, $absolu); |
| 200 | + |
| 201 | + // Génère un QrCode avec une image centrée. |
| 202 | + QrCode::format('png')->merge('chemin-vers-l-image.png')->generate(); |
| 203 | + |
| 204 | + // Génère un QrCode avec une image centrée. L'image recouvre jusque 30% du QrCode. |
| 205 | + QrCode::format('png')->merge('chemin-vers-l-image.png', .3)->generate(); |
| 206 | + |
| 207 | + // Génère un QrCode avec une image centrée. L'image recouvre jusque 30% du QrCode. |
| 208 | + QrCode::format('png')->merge('http://www.google.com/someimage.png', .3, true)->generate(); |
| 209 | + |
| 210 | +>La méthode `merge` ne supporte que les images PNG. |
| 211 | +>Le chemin vers l'image est relatif au chemin de base de l'application si $absolu est à `false`. Changez cette variable à `true` pour utiliser des chemins absolus. |
| 212 | +
|
| 213 | +> Vous devriez utiliser un haut niveau de correction d'erreur avec la méthode `merge` pour assurer la bonne lecture du QrCode. Nous recommandons l'utilisation de `errorCorrection('H')`. |
| 214 | +
|
| 215 | + |
| 216 | + |
| 217 | +#### Fusion De Chaîne Binaire |
| 218 | + |
| 219 | +La méthode `mergeString` est semblable à la méthode `merge` si ce n'est qu'elle prend comme paramètre le contenu du fichier sous forme de chaîne au lieu du nom du fichier. C'est particulièrement utile lorsque vous travaillez avec une façade `Storage`. L'interface de `mergeString` est très similaire à celle de `merge`. |
| 220 | + |
| 221 | + QrCode::mergeString(Storage::get('chemin/vers/image.png'), $percentage); |
| 222 | + |
| 223 | + // Génère un QrCode avec une image centrée. |
| 224 | + QrCode::format('png')->mergeString(Storage::get('chemin/vers/image.png'))->generate(); |
| 225 | + |
| 226 | + // Génère un QrCode avec une image centrée. L'image recouvre jusque 30% du QrCode. |
| 227 | + QrCode::format('png')->mergeString(Storage::get('chemin/vers/image.png'), .3)->generate(); |
| 228 | + |
| 229 | +>A l'instar de la méthode `merge`, seul le format d'image PNG est supporté. Les même recommandations relatives à la correction d'erreur s'appliquent. |
| 230 | +
|
| 231 | +#### Utilisation Avancée |
| 232 | + |
| 233 | +Toutes les méthodes supportent le chaînage. La méthode `generate` doit être appelée en dernier et toute modification du `format` en premier. Vous pourriez par exemple écrire : |
| 234 | + |
| 235 | + QrCode::size(250)->color(150,90,10)->backgroundColor(10,14,244)->generate('Transformez-moi en QrCode!'); |
| 236 | + QrCode::format('png')->size(399)->color(40,40,40)->generate('Transformez-moi en QrCode!'); |
| 237 | + |
| 238 | +Vous pouvez afficher une image PNG sans enregistrer de fichier en spécifiant une chaîne brute encodée avec `base64_encode`. |
| 239 | + |
| 240 | + <img src="data:image/png;base64, {!! base64_encode(QrCode::format('png')->size(100)->generate('Transformez-moi en QrCode!')) !!} "> |
| 241 | + |
| 242 | +<a id="docs-helpers"></a> |
| 243 | +## Helpers |
| 244 | + |
| 245 | +#### Que sont les helpers? |
| 246 | + |
| 247 | +Les helpers facilitent la création de QrCodes qui déclenchent une action du lecteur lorsqu'ils sont flashés. |
| 248 | + |
| 249 | +#### E-Mail |
| 250 | + |
| 251 | +Cet helper génère un QrCode pour l'envoi de courriel dont les destinataire, sujet et contenu peuvent être prédéfinis. |
| 252 | + |
| 253 | + QrCode::email($destinataire, $sujet, $contenu); |
| 254 | + |
| 255 | + // Renseigne l'adresse du destinataire |
| 256 | + QrCode::email('foo@bar.com'); |
| 257 | + |
| 258 | + // Renseigne le destinataire, le sujet et le contenu du courriel |
| 259 | + QrCode::email('foo@bar.com', 'Ceci est le sujet.', 'Ceci est le contenu.'); |
| 260 | + |
| 261 | + // Ne renseigne que le sujet et le contenu du courriel |
| 262 | + QrCode::email(null, 'Ceci est le sujet.', 'Ceci est le contenu.'); |
| 263 | + |
| 264 | +#### Geo |
| 265 | + |
| 266 | +Cet helper génère un QrCode avec des coordonnées géographiques (latitude et longitude) qui pourront être ouvertes par une application Google Maps ou similaire. |
| 267 | + |
| 268 | + QrCode::geo($latitude, $longitude); |
| 269 | + |
| 270 | + QrCode::geo(37.822214, -122.481769); |
| 271 | + |
| 272 | +#### Numéro de Téléphone |
| 273 | + |
| 274 | +Cet helper génère un QrCode qui lorsqu'il est flashé compose un numéro de téléphone. |
| 275 | + |
| 276 | + QrCode::phoneNumber($numeroDeTelephone); |
| 277 | + |
| 278 | + QrCode::phoneNumber('555-555-5555'); |
| 279 | + QrCode::phoneNumber('1-800-Laravel'); |
| 280 | + |
| 281 | +#### SMS (Messages Texte) |
| 282 | + |
| 283 | +Cet helper génère un QrCode d'envoi de SMS dont le destinataire et le message peuvent être prédéfinis. |
| 284 | + |
| 285 | + QrCode::SMS($numeroDeTelephone, $message); |
| 286 | + |
| 287 | + // Crée un SMS pour un numéro de téléphone |
| 288 | + QrCode::SMS('555-555-5555'); |
| 289 | + |
| 290 | + // Crée un SMS pour un numéro de téléphone avec un message |
| 291 | + QrCode::SMS('555-555-5555', 'Corps du message'); |
| 292 | + |
| 293 | +#### WiFi |
| 294 | + |
| 295 | +Cet helper génère un QrCode qui permet la connexion à un réseau WiFi. |
| 296 | + |
| 297 | + QrCode::wiFi([ |
| 298 | + 'encryption' => 'WPA/WEP', |
| 299 | + 'ssid' => 'SSID du réseau', |
| 300 | + 'password' => 'Mot de passe de connexion', |
| 301 | + 'hidden' => 'Indique si le SSID du réseau est masqué ou non.' |
| 302 | + ]); |
| 303 | + |
| 304 | + // Connexion à un réseau WiFi ouvert |
| 305 | + QrCode::wiFi([ |
| 306 | + 'ssid' => 'Nom du réseau', |
| 307 | + ]); |
| 308 | + |
| 309 | + // Connexion à un réseau WiFi ouvert et masqué |
| 310 | + QrCode::wiFi([ |
| 311 | + 'ssid' => 'Nom du réseau', |
| 312 | + 'hidden' => 'true' |
| 313 | + ]); |
| 314 | + |
| 315 | + // Connexion à un réseau WiFi sécurisé |
| 316 | + QrCode::wiFi([ |
| 317 | + 'ssid' => 'Nom du réseau', |
| 318 | + 'encryption' => 'WPA', |
| 319 | + 'password' => 'Mot de passe' |
| 320 | + ]); |
| 321 | + |
| 322 | +>La recherche de réseaux WiFi n'est actuellement pas supportée par les produis Apple. |
| 323 | +
|
| 324 | +<a id="docs-common-usage"></a> |
| 325 | +## Usage Courant des QrCodes |
| 326 | + |
| 327 | +Vous pouvez utiliser un des pseudos-protocoles du tableau suivant comme paramètre de la méthode `generate` pour créer un QrCode contenant des informations avancées : |
| 328 | + |
| 329 | + QrCode::generate('http://www.simplesoftware.io'); |
| 330 | + |
| 331 | + |
| 332 | +| Usage | Protocole | Exemple | |
| 333 | +| --- | --- | --- | |
| 334 | +| URL de site internet | http:// | http://www.simplesoftware.io | |
| 335 | +| URL de site internet sécurisé | https:// | https://www.simplesoftware.io | |
| 336 | +| Adresse de courriel | mailto: | mailto:support@simplesoftware.io | |
| 337 | +| Numéro de téléphone | tel: | tel:555-555-5555 | |
| 338 | +| SMS | sms: | sms:555-555-5555 | |
| 339 | +| SMS avec message pré-défini | sms: | sms::I am a pretyped message | |
| 340 | +| SMS avec message et numéro de téléphone pré-définis | sms: | sms:555-555-5555:I am a pretyped message | |
| 341 | +| Coordonnées géographiques | geo: | geo:-78.400364,-85.916993 | |
| 342 | +| MeCard | mecard: | MECARD:Simple, Software;Some Address, Somewhere, 20430;TEL:555-555-5555;EMAIL:support@simplesoftware.io; | |
| 343 | +| VCard | BEGIN:VCARD | [See Examples](https://en.wikipedia.org/wiki/VCard) | |
| 344 | +| Wifi | wifi: | wifi:WEP/WPA;SSID;PSK;Hidden(True/False) | |
| 345 | + |
| 346 | +<a id="docs-outside-laravel"></a> |
| 347 | +##Usage Hors De Laravel |
| 348 | + |
| 349 | +Vous pouvez utiliser ce paquet en dehors de Laravel en instanciant un objet de classe `BaconQrCodeGenerator`. |
| 350 | + |
| 351 | + use SimpleSoftwareIO\QrCode\BaconQrCodeGenerator; |
| 352 | + |
| 353 | + $qrcode = new BaconQrCodeGenerator; |
| 354 | + $qrcode->size(500)->generate('Créer un qrcode sans Laravel!'); |
0 commit comments