NAME
SIOC::Exporter -- SIOC RDF exporter class
VERSION
This documentation refers to SIOC::Exporter version 1.0.0.
SYNOPSIS
use SIOC::Exporter;
# create SIOC object instance, e.g. a SIOC::User
use SIOC::User;
my $user = SIOC::User->new(...);
# create exporter instance
my $exporter = SIOC::Exporter->new({
host => 'http://www.example.com',
});
# pass object to exporter
$exporter->export_object($user);
# output the object's information as RDF data
print $exporter->output(), "\n";DESCRIPTION
This module implements a SIOC exporter class. It will output the RDF representation of SIOC objects passed to it.
ATTRIBUTES
- host
-
The host attribute stores the URL of the website whose information is exported.
This attribute is required and must be set in the creation of a class instance with new().
- encoding
-
The encoding attribute stores the character encoding used. This information will be used in the XML processing instruction and in the charset header generated by the output() method.
- generator
-
The generator attribute stores the identification of the software using SIOC::Exporter to generate SIOC information.
- export_email
-
The export_email attribute stores a boolean value that determines if email addresses will be included in the RDF output.
SUBROUTINES/METHODS
new(\%attributes)
Creates a new class instance. Arguments are passed as a hash reference. See the ATTRIBUTES section above for required arguments.
register_object($sioc_object)
This method registers a SIOC object with the exporter, assigning a SIOC exporter URL to it. This URL is necessary to reference the object in RDF.
export_object
Pass the SIOC object you want to export with output() as an argument to this method.
object_export_url
This method generates the URL at which the SIOC data of the object passed as an argument will be provided. It's used by register_object().
Change this method in a derived subclass to reflect your website configuration.
output
DIAGNOSTICS
For diagnostics information, see the SIOC base class.
CONFIGURATION AND ENVIRONMENT
This module doesn't need configuration.
DEPENDENCIES
This module depends on the following modules:
Moose -- OOP framework (CPAN)
SIOC -- SIOC abstract base class (part of this module's distribution)
INCOMPATIBILITIES
There are no known incompatibilities.
BUGS AND LIMITATIONS
There are no known bugs in this module.
Please report problems via the bug tracking system on the perl-SIOC project website: http://developer.berlios.de/projects/perl-sioc/.
Patches are welcome.
AUTHOR
Jochen Lillich <geewiz@cpan.org>
LICENSE AND COPYRIGHT
Copyright (c) 2008, Jochen Lillich <geewiz@cpan.org> All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* The names of its contributors may not be used to endorse or promote
products derived from this software without specific prior written
permission.THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.