Examples updated

Author: jeroendesloovere

README.md

@@ -64,6 +64,9 @@ return $vcard->download();
 The parser can either get passed a VCard string, like so:
 
 ```php
+// load VCardParser classes
+use JeroenDesloovere\VCard\VCardParser;
+
 $parser = new VCardParser($vcardString);
 echo $parser->getCardAtIndex(0)->fullname; // Prints the full name.
 ```
@@ -74,6 +77,7 @@ Or by using a factory method with a file name:
 $parser = VCardParser::parseFromFile('path/to/file.vcf');
 echo $parser->getCardAtIndex(0)->fullname; // Prints the full name.
 ```
+> [View the parsing example](/examples/example_parsing.php) or check the [the VCardParser class](/src/VCardParser.php) class.
 
 **Support for frameworks**
 

examples/assets/contacts.vcf

@@ -0,0 +1,63 @@
+BEGIN:VCARD
+VERSION:3.0
+FN:Thies-Tillman Jacobsen
+N:Jacobsen;Thies-Tillman;;;
+BDAY:1908-10-25
+CATEGORIES:Sportverein
+TZ:+0100
+NOTE:Lieblingsfarbe: Violett
+END:VCARD
+
+BEGIN:VCARD
+VERSION:3.0
+FN:Lenn Biernoth
+N:Biernoth;Lenn;;;
+X-MAIDENNAME:Iser
+BDAY:1951-11-22
+BIRTHPLACE:Hörstel
+TITLE:Strassenreiniger
+CATEGORIES:Familie
+TZ:+0100
+EMAIL;TYPE=INTERNET;TYPE=HOME;TYPE=PREF:[email protected]
+NOTE:Interessen: Internet trollen, Kekse backen, Videos schneiden\nLieblingsessen: Chillibrot mit Kartoffelpuffer
+END:VCARD
+
+BEGIN:VCARD
+VERSION:3.0
+FN:Ludwig-Götz Graßl
+N:Graßl;Ludwig-Götz;;;
+X-MAIDENNAME:Schoen
+BDAY:1943-02-07
+BIRTHPLACE:Kaltennordheim
+TITLE:Rentner
+CATEGORIES:Piratenpartei
+TZ:+0100
+EMAIL;TYPE=INTERNET;TYPE=HOME;TYPE=PREF:[email protected]
+NOTE:Interessen: Stofftiere, Basketball\nLieblingsessen: Reiberouladen
+END:VCARD
+
+BEGIN:VCARD
+VERSION:3.0
+FN:Marita Kreutzer
+N:Kreutzer;Marita;;;
+NICKNAME:mkr
+X-MAIDENNAME:Sievers
+BDAY:1943-07-26
+TITLE:Rentnerin
+CATEGORIES:CCC
+TZ:+0100
+NOTE:Interessen: Handarbeiten\nLieblingsfarbe: Weiß\nLieblingsessen: Orangen
+END:VCARD
+
+BEGIN:VCARD
+VERSION:3.0
+FN:Kathi Hoelzl
+N:Hoelzl;Kathi;;;
+BDAY:2002-07-11
+BIRTHPLACE:Grevenbroich
+CATEGORIES:Piratenpartei
+TZ:+0100
+EMAIL;TYPE=INTERNET;TYPE=HOME;TYPE=PREF:[email protected]
+URL;TYPE=HOME:http://kho.me/
+END:VCARD
+

examples/example.php

@@ -2,8 +2,6 @@
 
 /**
  * VCard generator test - can save to file or output as a download
- *
- * @author Jeroen Desloovere <[email protected]>
  */
 
 require_once __DIR__ . '/../vendor/autoload.php';
@@ -52,4 +50,3 @@
 
 // echo message
 // echo 'A personal vCard is saved in this folder: ' . __DIR__;
-

examples/example_parsing.php

@@ -0,0 +1,24 @@
+<?php
+
+/**
+ * VCardParser test - can parse bundled VCF file into CSV
+ */
+
+require_once __DIR__ . '/../vendor/autoload.php';
+require_once __DIR__ . '/../src/VCardParser.php';
+
+// load VCardParser classes
+use JeroenDesloovere\VCard\VCardParser;
+
+$pathToVCardExample = __DIR__ . '/assets/contacts.vcf';
+$parser = VCardParser::parseFromFile($pathToVCardExample);
+
+foreach($parser as $vcard) {
+    $lastname = $vcard->lastname;
+    $firstname = $vcard->firstname;
+    $birthday = $vcard->birthday->format('Y-m-d');
+    
+    printf("\"%s\",\"%s\",\"%s\"", $lastname, $firstname, $birthday);
+    
+    echo PHP_EOL;
+}