.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Jifty::Plugin::Comment::Mixin::Model::Commented 3pm"
.TH Jifty::Plugin::Comment::Mixin::Model::Commented 3pm "2009-03-09" "perl v5.12.4" "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"
Jifty::Plugin::Comment::Mixin::Model::Commented \- add comments to a model
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  package App::Model::Fooble;
\&
\&  use Jifty::DBI::Schema;
\&  use App::Record schema {
\&      column scribble => type is \*(Aqtext\*(Aq;
\&      column wobble => type is \*(Aqint\*(Aq;
\&  };
\&
\&  use Jifty::Plugin::Comment::Mixin::Model::Commented;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Add this mixin to a model if you'd like to attach comments to it. Comments can be used to allow users of your system to comment upon and discuss the record to which they are attached.
.SH "METHODS"
.IX Header "METHODS"
.SS "import"
.IX Subsection "import"
This method performs some rather devious magic to make everything work easily. It automatically generates an additional model for your application. This model will look something like this:
.PP
.Vb 2
\&  use strict;
\&  use warnings;
\&  
\&  package App::Model::FoobleComment;
\&  use Jifty::DBI::Schema;
\&  
\&  use Jifty::Record schema {
\&      column commented_upon =>
\&          references App::Model::Fooble,
\&          label is \*(AqCommented upon\*(Aq,
\&          is mandatory,
\&          is immutable,
\&          ;
\&  
\&      column the_comment =>
\&          references App::Model::Comment,
\&          label is \*(AqComment\*(Aq,
\&          is mandatory,
\&          is immutable,
\&          is distinct,
\&          ;
\&  };
\&
\&  App::Model::FoobleComment\->add_trigger( before_access => sub {
\&      my $self = shift;
\&      my ($right, %args) = @_;
\&
\&      if ($right eq \*(Aqcreate\*(Aq) {
\&          return \*(Aqallow\*(Aq if $self\->current_user\->id;
\&      }
\&
\&      if ($right eq \*(Aqread\*(Aq) {
\&          return \*(Aqallow\*(Aq;
\&      }
\&
\&      return $self\->App::Model::FoobleComment::current_user_can(@_);
\&  });
.Ve
.PP
You will need to define an \f(CW\*(C`before_access\*(C'\fR trigger for this class if you want it to be useful.
.SS "for_commenting"
.IX Subsection "for_commenting"
Returns a value to be used with the comment views. It's basically just a string identifying the class name and \s-1ID\s0 of the record.
.SS "comments"
.IX Subsection "comments"
Returns a collection of Jifty::Plugin::Comment::Model::Comment objects that have been attached to the current record. (Actually, it returns the a collection of the local application class, e.g. \f(CW\*(C`App::Model::CommentCollection\*(C'\fR.)
.SS "comment_record_class"
.IX Subsection "comment_record_class"
This is the name of the linking class that was created during \*(L"import\*(R".
.SH "AUTHOR"
.IX Header "AUTHOR"
Andrew Sterling Hanenkamp \f(CW\*(C`<hanenkamp@cpan.com>\*(C'\fR
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2007 Boomer Consulting, Inc. All Rights Reserved.
.PP
This program is free software and may be modified and distributed under the same terms as Perl itself.