.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "RDF::vCard::Importer 3pm"
.TH RDF::vCard::Importer 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
RDF::vCard::Importer \- import RDF data from vCard format
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& use RDF::vCard;
\& use RDF::TrineShortcuts qw\*(Aq:all\*(Aq;
\& 
\& my $importer = RDF::vCard::Importer\->new;
\& print $_
\&        foreach $importer\->import_file(\*(Aqcontacts.vcf\*(Aq);
\& print rdf_string($importer\->model => \*(AqRDFXML\*(Aq);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module reads vCards and writes RDF.
.SS Constructor
.IX Subsection "Constructor"
.IP \(bu 4
\&\f(CWnew(%options)\fR
.Sp
Returns a new RDF::vCard::Importer object and initialises it.
.Sp
The only valid option currently is \fBua\fR which can be set to an LWP::UserAgent
for those rare occasions that the Importer needs to fetch stuff from the Web.
.SS Methods
.IX Subsection "Methods"
.IP \(bu 4
\&\f(CW\*(C`init\*(C'\fR
.Sp
Reinitialise the importer. Forgets any cards that have already been imported.
.IP \(bu 4
\&\f(CW\*(C`model\*(C'\fR
.Sp
Return an RDF::Trine::Model containing data for all cards that have been
imported since the importer was last initialised.
.IP \(bu 4
\&\f(CW\*(C`import_file($filename, %options)\*(C'\fR
.Sp
Imports vCard data from a file on the file system.
.Sp
The data is added to the importer's model (and can be retrieved using the
\&\f(CW\*(C`model\*(C'\fR method).
.Sp
This function returns a list of RDF::vCard::Entity objects, so it's
also possible to access the data that way.
.Sp
There is currently only one supported option: \f(CW\*(C`lang\*(C'\fR which takes an
ISO language code indicating the default language of text within the vCard
data.
.IP \(bu 4
\&\f(CW\*(C`import_fh($filehandle, %options)\*(C'\fR
.Sp
As per \f(CW\*(C`import_file\*(C'\fR, but operates on a file handle.
.IP \(bu 4
\&\f(CW\*(C`import_string($string, %options)\*(C'\fR
.Sp
As per \f(CW\*(C`import_file\*(C'\fR, but operates on vCard data in a string.
.IP \(bu 4
\&\f(CWimport_url($url)\fR
.Sp
As per \f(CW\*(C`import_file\*(C'\fR, but fetches vCard data from a Web address.
.Sp
Sends an HTTP Accept header of:
.Sp
.Vb 4
\&  text/directory;profile=vCard,
\&  text/vcard,
\&  text/x\-vcard,
\&  text/directory;q=0.1
.Ve
.SS "vCard Input"
.IX Subsection "vCard Input"
vCard 3.0 should be supported fairly completely. Some vCard 4.0 constructs
will also work.
.PP
Much of the heavy lifting is performed by Text::vFile::asData, so this
module may be affected by bugs in that distribution.
.SS "RDF Output"
.IX Subsection "RDF Output"
Output uses the newer of the 2010 revision of the W3C's vCard vocabulary
<http://www.w3.org/Submission/vcard\-rdf/>. (Note that even though this
was revised in 2010, the term URIs include "2006" in them.)
.PP
Some extensions from the namespace <http://buzzword.org.uk/rdf/vcardx#>
are also output.
.PP
The AGENT property is currently omitted from output. This will be added
in a later version.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
RDF::vCard.
.PP
<http://www.w3.org/Submission/vcard\-rdf/>.
.PP
<http://www.perlrdf.org/>.
.SH AUTHOR
.IX Header "AUTHOR"
Toby Inkster <tobyink@cpan.org>.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2011 Toby Inkster
.PP
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.