Index
- NAME
- VERSION
- SYNOPSIS
- DESCRIPTION
- CLASS ATTRIBUTES
- SUBROUTINES/METHODS
- DIAGNOSTICS
- CONFIGURATION AND ENVIRONMENT
- DEPENDENCIES
- INCOMPATIBILITIES
- BUGS AND LIMITATIONS
- AUTHOR
- LICENSE AND COPYRIGHT
Code Index:
NAME
SIOC::Forum -- SIOC Forum class
VERSION
This documentation refers to SIOC::Forum version 1.0.0.
SYNOPSIS
use SIOC::Forum;
DESCRIPTION
Forums can be thought of as channels or discussion area on which Posts are made. A Forum can be linked to the Site that hosts it. Forums will usually discuss a certain topic or set of related topics, or they may contain discussions entirely devoted to a certain community group or organisation. A Forum will have a moderator who can veto or edit posts before or after they appear in the Forum.
Forums may have a set of subscribed Users who are notified when new Posts are made. The hierarchy of Forums can be defined in terms of parents and children, allowing the creation of structures conforming to topic categories as defined by the Site administrator. Examples of Forums include mailing lists, message boards, Usenet newsgroups and weblogs.
The SIOC Types Ontology Module defines come more specific subclasses of SIOC::Forum.
CLASS ATTRIBUTES
- host
-
The Site that hosts this Forum.
- moderators
-
Users who are moderators of this Forum.
- scopes
-
Roles that have a scope of this Forum.
SUBROUTINES/METHODS
host([$new_host])
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.
add_moderator($new_moderator)
Adds a new value to the corresponding array attribute.
add_scope($new_scope)
Adds a new value to the corresponding array attribute.
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.