Anansi::Script::Shell - Defines the mechanisms specific to handling command line execution.
my $OBJECT = Anansi::Script::Shell->new();
This module is designed to be an optional component module for use by the Anansi::Script component management module. It defines the processes specific to handling both input and output from Perl scripts that are executed from a command line. Uses Anansi::ComponentManager (indirectly), Anansi::ScriptComponent and base.
Declared in Anansi::Component.
$OBJECT->SUPER::finalise(); $OBJECT->Anansi::Script::Shell::finalise();
Declared in Anansi::Class. Overridden by this module.
Declared in Anansi::Class. Intended to be overridden by an extending module.
Declared in Anansi::Class.
$OBJECT->SUPER::initialise(); $OBJECT->Anansi::Script::Shell::initialise();
my $contents = $OBJECT->content(); if(1 == $OBJECT->content(undef, undef)); if(1 == $OBJECT->channel('CONTENT', undef)); if(1 == $OBJECT->content(undef, 'some content')); if(1 == $OBJECT->channel('CONTENT', 'some content'));
Either returns the existing content or redefines the content.
$OBJECT->loadParameters();
Loads all of the argument values from the command line, assigning any names that are supplied to the values.
my $medium = Anansi::Script::Shell->medium(); my $medium = $OBJECT->medium(); my $medium = $OBJECT->channel('MEDIUM');
Returns the STRING description of the medium this module is designed to handle.
my $parameters = $OBJECT->parameter(); my $parameters = $OBJECT->channel('PARAMETER'); my $parameterValue = $OBJECT->parameter(undef, 'parameter name'); my $parameterValue = $OBJECT->channel('PARAMETER', 'parameter name'); if($OBJECT->parameter(undef, 'parameter name' => 'parameter value', 'another parameter' => undef)); if($OBJECT->channel('PARAMETER', 'parameter name' => 'parameter value', 'another parameter' => undef));
Either returns an ARRAY of all the existing parameter names or returns the value of a specific parameter or sets the value of one or more parameters. Assigning an "undef" value has the effect of deleting the parameter.
my $valid = $OBJECT->validate(); my $valid = $OBJECT->channel('VALIDATE_AS_APPROPRIATE');
Determines whether this module is the correct one to use for handling Perl script execution.
This module is designed to make it simple, easy and quite fast to code your design in perl. If for any reason you feel that it doesn't achieve these goals then please let me know. I am here to help. All constructive criticisms are also welcomed.
Kevin Treleaven <kevin AT treleaven DOT net>
To install Anansi::Script::Shell, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Anansi::Script::Shell
CPAN shell
perl -MCPAN -e shell install Anansi::Script::Shell
For more information on module installation, please visit the detailed CPAN module installation guide.