/ 
SIOC-v1.0.0
River stage zero No dependents
/ SIOC::Post

NAME

SIOC::Post - SIOC Post class

VERSION

This documentation refers to SIOC::Post version 1.0.0.

SYNOPSIS

use SIOC::Post;

DESCRIPTION

A Post is an article or message posted by a User to a Forum. A series of Posts may be threaded if they share a common subject and are connected by reply or by date relationships. Posts will have content and may also have attached files, which can be edited or deleted by the Moderator of the Forum that contains the Post.

The SIOC Types Ontology Module describes some additional, more specific subclasses of SIOC::Post.

Class attributes

content

The content of the Post in plain text format.

This attribute is required and must be set in the creation of a class instance with new().

encoded_content

Used to describe the encoded content of a Post, contained in CDATA areas.

This attribute is required and must be set in the creation of a class instance with new().

attachments

The URIs of files attached to a Post.

Related Posts for this Post, perhaps determined implicitly from topics or references.

siblings

A Post may have a sibling or a twin that exists in a different Forum, but the siblings may differ in some small way (for example, language, category, etc.). The sibling of this Post should be self-describing (that is, it should contain all available information).

note

A note associated with this Post, for example, if it has been edited by a User.

reply_count

The number of replies that this Post has. Useful for when the reply structure is absent.

SUBROUTINES/METHODS

content([$content])

Accessor for the attribute of the same name. Call without argument to read the current value of the attribute; sets attribute when called with new value as argument.

encoded_content([$content])

Accessor for the attribute of the same name. Call without argument to read the current value of the attribute; sets attribute when called with new value as argument.

set_attachment($name => $data)

Sets a key/value pair in the corresponding hash attribute.

get_attachment($name)

Queries a key/value pair in the corresponding hash attribute.

add_related($item)

Adds a new value to the corresponding array attribute.

add_sibling($item)

Adds a new value to the corresponding array attribute.

note([$note])

Accessor for the attribute of the same name. Call without argument to read the current value of the attribute; sets attribute when called with new value as argument.

reply_count([$num])

Accessor for the attribute of the same name. Call without argument to read the current value of the attribute; sets attribute when called with new value as argument.

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.