Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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::Collection(3pm)					User Contributed Perl Documentation				    Jifty::Collection(3pm)

NAME

       Jifty::Collection - Collection of Jifty::Record objects

SYNOPSIS

	 package Foo::Model::BarCollection
	 use base qw/Jifty::Collection/;

DESCRIPTION

       This is a wrapper over Jifty::DBI::Collection that at the same time is a Jifty::Object.	To use it, subclass it.

       Alternatively, an 'anonymous' collection can be made by creating a new "Jifty::Collection" object, and calling
       "record_class('Application::Model::Foo')" or similar on it.

       In addition, each Jifty::Collection includes a Data::Page object to help with calculations related to paged data.  You should not call the
       "first_row" and "rows_per_page" methods from Jifty::DBI::Collection on a Jifty::Collection.  Instead, if you'd like to use paging, you
       should use the "set_page_info" method to set the number of records per page and first record on the current page, and you should use the
       Data::Page object returned by the "pager" method to get information related to paging.

MODEL

   pager
       Returns a Data::Page object associated with this collection.  This object defaults to 10 entries per page.  You should use only use
       Data::Page methods on this object to get information about paging, not to set it; use "set_page_info" to set paging information.

   results_are_readable
       If your results from the query are guaranteed to be readable by current_user, you can create the collection with "results_are_readable =>
       1".  This causes check_read_rights to bypass normal current_user_can checks.

   as_search_action PARAMHASH
       Returns the Jifty::Action::Record::Search action for the model associated with this collection.

       The PARAMHASH allows you to add additional parameters to pass to "new_action" in Jifty::Web.

   add_record
       If "results_are_readable" is false, only add records to the collection that we can read (by checking "check_read_rights" in Jifty::Record).
       Otherwise, make sure all records added are readable.

   implicit_clauses
       Defaults to ordering by the "id" column.

   jifty_serialize_format
       This returns an array reference of the individual records that make up this collection.

SEE ALSO

       Jifty::DBI::Collection, Jifty::Object, Jifty::Record

LICENSE

       Jifty is Copyright 2005-2010 Best Practical Solutions, LLC.  Jifty is distributed under the same terms as Perl itself.

perl v5.14.2							    2010-12-10						    Jifty::Collection(3pm)
Man Page