OpenInteract2 Documentation: OpenInteract2::Manage::Website

NAME

OpenInteract2::Manage::Website - Parent for website management tasks

SYNOPSIS

 package My::Manage::Task;

 use strict;
 use base qw( OpenInteract2::Manage::Website );
 use OpenInteract2::Context qw( CTX );

 sub run_task {
     my ( $self ) = @_;
     my $website_dir = CTX->lookup_directory( 'website' );;
     ... # CTX is setup automatically in setup_task()
 }

DESCRIPTION

Provides common initialization and other tasks for managment tasks operating on a website.

METHODS

Task Execution Methods

list_param_require()

Returns [ 'website_dir' ] as a required parameter. If your subclass has additional parameters required, you should override the method and either include 'website_dir' as one of the entries or call SUPER and capture the return.

list_param_require()

Returns [ 'website_dir' ] as a parameter that must be validated, using the built-in validation from OpenInteract2::Manage. If your subclass has additional parameters to be validated, you should override the method and either include 'website_dir' as one of the entries or call SUPER and capture the return. You should also implement the method validate_param() as discussed in OpenInteract2::Manage.

setup_task()

Call _setup_context() from OpenInteract2::Manage which sets up a OpenInteract2::Context object you can examine the website.

If your task does not need this, override setup_task() with an empty method or to do whatever you need.

Common Functionality

_install_packages( $dir, \@package_names )

_match_system_packages( $dir )

COPYRIGHT

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHORS

Chris Winters <chris@cwinters.com>

Generated from the OpenInteract 1.99_06 source.