Thomas Sibley > Data-ICal-0.19 > Data::ICal::Property

Download:
Data-ICal-0.19.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  5
Open  3
View/Report Bugs
Module Version: 0.06   Source   Latest Release: Data-ICal-0.21

NAME ^

Data::ICal::Property - Represents a property on an entry in an iCalendar file

DESCRIPTION ^

A Data::ICal::Property object represents a single property on an entry in an iCalendar file. Properties have parameters in addition to their value.

You shouldn't need to create Data::ICal::Property values directly -- just use add_property in Data::ICal::Entry.

The encoding parameter value is only interpreted by Data::ICal in the decoded_value and encode methods: all other methods access the encoded version directly (if there is an encoding).

Currently, the only supported encoding is QUOTED-PRINTABLE.

METHODS ^

new $key, $value, [$parameter_hash]

Creates a new Data::ICal::Property with key $key and value $value.

If $parameter_hash is provided, sets the property's parameters to it. The parameter hash should have keys equal to the names of the parameters (case insensitive; parameter hashes should not contain two different keys which are the same when converted to upper case); the values should either be a string if the parameter has a single value or an array reference of strings if the parameter has multiple values.

key [$key]

Gets or sets the key name of this property.

value [$value]

Gets or sets the value of this property.

parameters [$param_hash]

Gets or sets the parameter hash reference of this property. Parameter keys are converted to upper case.

vcal10 [$bool]

Gets or sets a boolean saying whether this should be interpreted as vCalendar 1.0 (as opposed to iCalendar 2.0). Generally, you can just set this on your main Data::ICal object when you construct it; add_entry automatically makes sure that sub-entries end up with the same value as their parents, and add_property makes sure that properties end up with the same value as their entry.

decoded_value

Gets the value of this property, converted from the encoding specified in its encoding parameter. (That is, value will return the encoded version; this will apply the encoding.) If the encoding is not specified or recognized, just returns the raw value.

encode $encoding

Calls decoded_value to get the current decoded value, then encodes it in $encoding, sets the value to that, and sets the encoding parameter to $encoding. ($encoding is first converted to upper case.)

If $encoding is undef, deletes the encoding parameter and sets the value to the decoded value. Does nothing if the encoding is not recognized.

as_string ARGS

Returns the property formatted as a string (including trailing newline).

Takes named arguments:

fold

Defaults to true. pass in a false value if you need to generate non-rfc-compliant calendars.

crlf

Defaults to \x0d\x0a, per RFC 2445 spec. This option is primarily for backwards compatibility with version of this module prior to 0.16, which used \x0a.

AUTHOR ^

Jesse Vincent <jesse@bestpractical.com> with David Glasser, Simon Wistow, and Alex Vandiver

LICENCE AND COPYRIGHT ^

Copyright (c) 2005 - 2009, Best Practical Solutions, LLC. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: