jifty::plugin::comment::notification::commentpublished(3pm) [debian man page]

Jifty::Plugin::Comment::Notification::CommentPublished(3User Contributed Perl DocumentaJifty::Plugin::Comment::Notification::CommentPublished(3pm)

NAME

       Jifty::Plugin::Comment::Notification::CommentPublished - new comments made

SYNOPSIS

       To activate this notification, you must override the notification in your application.

	 use strict;
	 use warnings;

	 package MyApp::Notification::CommentPublished;
	 use base qw/ Jifty::Plugin::Comment::Notification::CommentPublished /;

	 sub setup {
	     my $self = shift;

	     # Send to the author of the post
	     $self->to_list($self->parent->author);

	     $self->SUPER::setup(@_);
	 }

	 sub url {
	     my $self = shift;
	     return Jifty->config->framework('Web')->{'BaseURL'}
		 . $self->parent->permalink
		 . '#comment-'.$self->comment->id;
	 }

	 1;

DESCRIPTION

       This notification (when properly configured) is sent out to any who need to know when a comment has been published.

METHODS

   setup
       This method sets up the notification. This method should be overridden to setup "to_list" in Jifty::Notification to select who will receive
       this message. See the "SYNOPSIS".

   comment
       This will contain the Jifty::Plugin::Comment::Model::Comment that has been published.

   parent
       This will contain the object that the comment has been attached to.

   url
       This returns the URL that the message will link to. This should be overridden to provide application-specific URLs. The default
       implementation returns the BaseURL setting for the application.

SEE ALSO

       Jifty::Notification, Jifty::Plugin::Comment::Notification::CommentNeedsModeration

AUTHOR

       Andrew Sterling Hanenkamp, "<hanenkamp@cpan.org>"

COPYRIGHT AND LICENSE

       Copyright 2008 Boomer Consulting, Inc. All Rights Reserved.

       This program is free software and may be modified and distributed under the same terms as Perl itself.

perl v5.12.4							    2009-03-09	       Jifty::Plugin::Comment::Notification::CommentPublished(3pm)

Jifty::Plugin::Comment::Mixin::Model::Commented(3pm)	User Contributed Perl Documentation   Jifty::Plugin::Comment::Mixin::Model::Commented(3pm)

NAME

       Jifty::Plugin::Comment::Mixin::Model::Commented - add comments to a model

SYNOPSIS

	 package App::Model::Fooble;

	 use Jifty::DBI::Schema;
	 use App::Record schema {
	     column scribble => type is 'text';
	     column wobble => type is 'int';
	 };

	 use Jifty::Plugin::Comment::Mixin::Model::Commented;

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.

METHODS

   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:

	 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 'Commented upon',
		 is mandatory,
		 is immutable,
		 ;

	     column the_comment =>
		 references App::Model::Comment,
		 label is 'Comment',
		 is mandatory,
		 is immutable,
		 is distinct,
		 ;
	 };

	 App::Model::FoobleComment->add_trigger( before_access => sub {
	     my $self = shift;
	     my ($right, %args) = @_;

	     if ($right eq 'create') {
		 return 'allow' if $self->current_user->id;
	     }

	     if ($right eq 'read') {
		 return 'allow';
	     }

	     return $self->App::Model::FoobleComment::current_user_can(@_);
	 });

       You will need to define an "before_access" trigger for this class if you want it to be useful.

   for_commenting
       Returns a value to be used with the comment views. It's basically just a string identifying the class name and ID of the record.

   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. "App::Model::CommentCollection".)

   comment_record_class
       This is the name of the linking class that was created during "import".

AUTHOR

       Andrew Sterling Hanenkamp "<hanenkamp@cpan.com>"

COPYRIGHT AND LICENSE

       Copyright 2007 Boomer Consulting, Inc. All Rights Reserved.

       This program is free software and may be modified and distributed under the same terms as Perl itself.

perl v5.12.4							    2009-03-09		      Jifty::Plugin::Comment::Mixin::Model::Commented(3pm)