Download the PHP package nfourtythree/vcard without Composer
On this page you can find all versions of the php package nfourtythree/vcard. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nfourtythree/vcard
More information about nfourtythree/vcard
Files in nfourtythree/vcard
Package vcard
Short Description vCard generator plugin for Craft CMS 5
License MIT
Informations about the package vcard
vCard plugin for Craft CMS 5.x
vCard generator plugin for Craft CMS 5
Requirements
This plugin requires Craft CMS 5.0.0 or later.
Installation
To install the plugin, follow these instructions.
-
Open your terminal and go to your Craft project:
cd /path/to/project
-
Then tell Composer to load the plugin:
composer require nfourtythree/vcard
- In the Control Panel, go to Settings → Plugins and click the “Install” button for vCard.
vCard Overview
This plugin generates a link to download a vCard from data you specify
Configuring vCard
There is only one setting for this plugin which is salt
this is a string
used for salting the encoded data when generating the vCard link.
This can be set by creating a vcard.php
config file in the config/
directory. Below is an example of the config file:
Using vCard
The only thing that is really required
is first name. Everything else is optional
Usage
There is a link variable available for usage in templates craft.vCard.link(options)
Options
Name | Type | Example |
---|---|---|
firstName | String | Johnny |
lastName | String | Appleseed |
additional | String | Jim (commonly a middle name) |
prefix | String | Mr |
suffix | String | Esq |
company | String | Apple Inc |
jobTitle | String | Demo Data Guru |
String/Array | See email docs | |
url | String/Array | See url docs |
address | String/Array | See address docs |
phoneNumber | String/Array | See phoneNumber docs |
birthday | String | 1985-10-26 (YYYY-MM-DD format) |
note | String | Johnny is amazing |
photo | String | http://example.com/images/avatar.jpg (Url to image) |
This can be specified as either a string [email protected]
or an array (or even a mix!)
Name | Type | Example |
---|---|---|
address | String | [email protected] |
type | String | type may be PREF, WORK, HOME or any combination of these: e.g. "PREF;WORK". This is not required |
url
This can be specified as either a string http://apple.com
or an array (or even a mix!)
Name | Type | Example |
---|---|---|
address | String | http://apple.com |
type | String | type may be WORK, HOME This is not required |
phoneNumber
This can be specified as either a string +1 234 567 89
or an array (or even a mix!)
Name | Type | Example |
---|---|---|
number | String | +1 234 567 89 |
type | String | Type may be PREF, WORK, HOME, VOICE, FAX, MSG, CELL, PAGER, BBS, CAR, MODEM, ISDN, VIDEO or any sensible combination, e.g. "PREF;WORK;VOICE" |
address
This can be either a single or multi array
Name | Type | Example |
---|---|---|
name | String | Apple |
extended | String | Suite 1 |
street | String | 1 Infinite Loop |
city | String | Cupertino |
region | String | CA |
zip | String | 95014 |
country | String | USA |
type | String | type may be DOM, INTL, POSTAL, PARCEL, HOME, WORK or any combination of these: e.g. "WORK;PARCEL;POSTAL" |
ToDo
- Clean up / refactor code to tidy code that was done quickly
Brought to you by Nathaniel Hammond (nfourtythree)
Thanks to
- Jeroen Desloovere - https://github.com/jeroendesloovere/vcard
- nystudio107 - https://github.com/nystudio107/generator-craftplugin (for just making life easier / quicker)
- Chris Rowe - http://chrisrowe.net for the idea to make this plugin