General

Parameter

About

What does this plugin do?

This plugin generates a simple QR Code using Google Charts API.
QR Codes are popular among Smartphone user, where with help of QR Code you are able to easily access or save information specified in that code.
With QR Image Plugin generated QR code from Google Charts API is saved in a predefined folder.

Furthermore, Plugin was extended so it can be used with different formats as far supported by GoogleCharts API, like vcard, text, telephone, sms, email and url.
For example:

• url: Creates QR Code containg URL.
• custom: Creates QR Code with custom url encoded text.
• email: Creates QR Code containing email address.
• phone: Creates QR Code cotaining phone number, making it possible to dial directly from your Smartphone.
• sms: Creates QR Code containing phone number and making it possible to send SMS driectly from your Smartphone.
• vcard: Creates QR Code containig vCard information, which can be saved as contact on your Smartphone.
• mecard: Creates QR Code containig meCard information, which can be saved as contact on your Smartphone.

With actions "vcard" or "mecard" you can embed vCard or meCard information in generated QR code.

Generated vCard Information:

BEGIN:VCARD
VERSION:3.0
N:Lastname;Firstname
FN:Lastname Firsname
ORG:Company Name
TITLE:CEO
TEL;TYPE=WORK:99999999
ADR;TYPE=WORK:;;Some Address 99;Some City;LA;99999;United States
LABEL;TYPE=WORK:Some Address 99\nSome City\nLA\n99999\nUnited States
EMAIL;TYPE=PREF,INTERNET:some@email.com
URL:www.domain.com
BDAY:01.01.1979
NOTE:Lorem ipsum
REV:20111217T195243Z
END:VCARD


Generated meCard Information:

MECARD:
N:Lastname,Firstname;
TEL:99999999
ADR:Some Address 99,Some City,LA;99999,United States;
EMAIL:some@email.com;
URL:www.domain.com;
BDAY:01.01.1979;
NOTE:Lorem ipsum;


How do I use it?

Just insert the tag into your template/page like:
{qr_image url='http://www.domain.com' width='120' height='120' title='some title' alt='alt text'}

Using with other Plugins or UDT's

With parameter action='custom' and noencode='1' you can use this Plugin in combination with other Plugins or UDT's.
When updating this plugin i have also had a discussion with Rober Campbell where he has quickly written a standalone vcard Plugin
which you should also find in CMSMS Forge.

Example:
{vcard firstname='robert' lastname='Campbell' pobox='P.O. Box 1944' street='123 Anywhere St' city='Somewhere' state='CA' zip=90210 country='Zimbabwe' teltype=work tel='1 814 495 0338' company='Techcom Consulting' position='guru' assign='card'}
{qr_image width='300' height='300' action='custom' noencode='1' data=$card}

Using it as vCard or meCard

With additional parameter you can use the generated QR Image with VCARD information.
{qr_image action='vcard' firstname='Goran' lastname='Ilic' address='Behind the hill 99' city='Chakalaka' zip='99999' country='Cmsmsania'}

Image Parameter?

• width (optional) - is optional, default setting is 100px.
• height (optional) - is optional, default setting is 100px.
• path (optional) - is optional. You can specify a path where QR images should be saved, default is /uploads/images/qr.
  This path is relative to /uploads/images.
• alt (optional) - alt tag for generated QR image.
• title (optional) - title tag for generated QR image.
• data_uri (optional) - default is disabled. Setting data_uri='1' will generate a base64 encoded image (usefull if you want to reduce http requests.)
  Please note that older browser do not support base64 encoded images.

Data Parameter?

• action (optional) - specifies type of QR Image. Possible values are "phone", "custom", "email", "sms", "vcard", "mecard".
• data (optional) - is used in combination with action='vcard', action='mecard' and action='custom' to enter plain text (Contact note with action "vcard" or "mecard") or custom data like value from other plugin or module (Note: value is url encoded, see: PHP urlencode)
• noencode (optional) - can be used in combaintion with action='custom' and parameter "data". This would disable urlencode for "data" parameter if you enter already encoded data or use another plugin or UDT that returns urlencoded value.
• url (required) when no action parameter was specified - specify url to generate QR code from, also used with action='vcard'or action='mecard'.
  If using it with News or CGBlog module you could simply user url=$entry->url for example.
• email (optional) - used for email address with action='email', action='vcard' or action='mecard'.
• phone (optional) - used for telephone number with action='phone', action='sms', action='vcard' or action='mecard'.
• firstname (optional) - used for firstname with action='vcard' or action='mecard'.
• lastname (optional) - used for lastname with action='vcard' or action='mecard'.
• company (optional) - used for company name with action='vcard'.
• position (optional) - used for position (CEO, Guru, Boss...) with action='vcard'.
• address (optional) - used for street address with action='vcard' or action='mecard'.
• city (optional) - used for city name with action='vcard' or action='mecard'.
• state (optional) - used for state name with action='vcard' or action='mecard'.
• zip (optional) - used for zip number with action='vcard' or action='mecard'.
• country (optional) - used for country name with action='vcard' or action='mecard'.
• bday (optional) - used for birth day date with action='vcard' or action='mecard' (use following format: YYYY-MM-DD).
• type (optional) - this can be used with action='vcard' where you can specify if vCard Contact is of type "home" or "work".

Author: Goran Ilic www.ich-mach-das.at