[Openinteract-commits] CVS: OpenInteract2/pkg/base/OpenInteract2/App Base.pm,NONE,1.1

[Chris W. <la...@us...>]

Update of /cvsroot/openinteract/OpenInteract2/pkg/base/OpenInteract2/App
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27837/base/OpenInteract2/App

Added Files:
	Base.pm 
Log Message:
OIN-72: move all docs to ::App class

--- NEW FILE: Base.pm ---
package OpenInteract2::App::Base;

use strict;
use base qw( Exporter OpenInteract2::App );
use OpenInteract2::Manage;

$OpenInteract2::App::Base::VERSION = sprintf("%d.%02d", q$Revision: 1.1 $ =~ /(\d+)\.(\d+)/);
@OpenInteract2::App::Base::EXPORT  = qw( install );

sub get_brick_name {
    return 'base';
}

# Not a method, just an exported sub
sub install {
    my ( $website_dir ) = @_;
    my $manage = OpenInteract2::Manage->new( 'install_package' );
    $manage->param( website_dir   => $website_dir );
    $manage->param( package_class => __PACKAGE__ );
    return $manage->execute;
}

__END__

=pod

=head1 NAME

OpenInteract2::App::Base - The parts of OpenInteract that don't fit anywhere else

=head1 DESCRIPTION

This package has a few pieces of OI that don't really fit anywhere
else, including SQL files for sessions and site-wide HTML images
(bullet, OI logo, 'powered-by' buttons).

=head1 OBJECTS

No objects created by this package

=head1 ACTIONS

B<logout>

Logs out the current user. Currently this displays a 'You have logged
out page', but this might change.

Class: L<OpenInteract2::Action::Logout|OpenInteract2::Action::Logout>

B<package>

Lists packages installed to your website and allows you to drill down
into a package to display its details.

Class: L<OpenInteract2::Action::Package|OpenInteract2::Action::Package>

=head1 RULESETS

No rulesets created by this package.

=head1 AUTHORS

Chris Winters E<lt>ch...@cw...E<gt>

=cut