jifty::plugin::classloader(3pm) [debian man page]

Jifty::Plugin::ClassLoader(3pm) 			User Contributed Perl Documentation			   Jifty::Plugin::ClassLoader(3pm)

NAME

       Jifty::Plugin::ClassLoader - Automatically generates application classes

DESCRIPTION

       "Jifty::Plugin::ClassLoader" loads additional model and action classes on behalf of the application out of the configured plugin classes.
       Unlike, "Jifty::ClassLoader", this class will only autogenerate classes if the plugin provides them.  The plugin classes are checked before
       the base Jifty classes, so that a plugin can override the Jifty class, just as any existing application classes will be loaded first.

   new
       Returns a new ClassLoader object.  Doing this installs a hook into @INC that allows Jifty::Plugin::ClassLoader to dynamically create needed
       classes if they do not exist already.  This works because if use/require encounters a blessed reference in @INC, it will invoke the INC
       method with the name of the module it is searching for on the reference.

       Takes two mandatory arguments, "base", which should be the application's base path; and "plugin" which is the plugin classname.

   INC
       The hook that is called when a module has been "require"'d that cannot be found on disk.  The following stub classes are auto-generated:

       Application
	   An empty application base class is created that doesn't provide any methods or inherit from anything.

       Application::Record
	   An empty class that descends from Jifty::Record is created.

       Application::Collection
	   An empty class that descends from Jifty::Collection is created.

       Application::Notification
	   An empty class that descends from Jifty::Notification.

       Application::Dispatcher
	   An empty class that descends from Jifty::Dispatcher.

       Application::Bootstrap
	   An empty class that descends from Jifty::Bootstrap.

       Application::Upgrade
	   An empty class that descends from Jifty::Upgrade.

       Application::CurrentUser
	   An empty class that descends from Jifty::CurrentUser.

       Application::Model::AnythingCollection
	   If "Application::Model::Something" is a valid model class, then it creates a subclass of Jifty::Collection whose "record_class" is
	   "Application::Model::Something".

       Application::Action::(Create or Update or Delete)Anything
	   If "Application::Model::Something" is a valid model class, then it creates a subclass of Jifty::Action::Record::Create,
	   Jifty::Action::Record::Update, or Jifty::Action::Record::Delete whose record_class is "Application::Model::Something".

   require
       Loads all of the application's Actions and Models.  It additionally "require"'s all Collections and Create/Update actions for each Model
       base class -- which will auto-create them using the above code if they do not exist on disk.

   DESTROY
       When the ClassLoader gets garbage-collected, its entry in @INC needs to be removed.

perl v5.14.2							    2010-12-08					   Jifty::Plugin::ClassLoader(3pm)

Check Out this Related Man Page

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)

Linux and UNIX Man Pages

jifty::plugin::classloader(3pm) [debian man page]

Check Out this Related Man Page