MooseX::Getopt::ProcessedArgv - MooseX::Getopt::ProcessedArgv - Class containing the results of process_argv

MooseX-Getopt documentation

Contained in the MooseX-Getopt distribution.

Index

NAME
SYNOPSIS
DESCRIPTION
METHODS
AUTHORS
COPYRIGHT AND LICENSE

Code Index:

package MooseX::Getopt::ProcessedArgv
__END__
EOF

NAME

MooseX::Getopt::ProcessedArgv - MooseX::Getopt::ProcessedArgv - Class containing the results of process_argv

SYNOPSIS

  use My::App;

  my $pa = My::App->process_argv(@params);
  my $argv_copy          = $pa->argv_copy();
  my $extra_argv         = $pa->extra_argv();
  my $usage              = $pa->usage();
  my $constructor_params = $pa->constructor_params();
  my $cli_params         = $pa->cli_params();

DESCRIPTION

This object contains the result of a process_argv in MooseX::Getopt call. It contains all the information that new_with_options in MooseX::Getopt uses when calling new.

METHODS

argv_copy

Reference to a copy of the original @ARGV array as it originally existed at the time of new_with_options.

extra_arg

Arrayref of leftover @ARGV elements that Getopt::Long did not parse.

usage

Contains the Getopt::Long::Descriptive::Usage object (if Getopt::Long::Descriptive is used).

constructor_params

Parameters passed to process_argv.

cli_param

Command-line parameters parsed out of @ARGV.

AUTHORS

Stevan Little <stevan@iinteractive.com>
Brandon L. Black <blblack@gmail.com>
Yuval Kogman <nothingmuch@woobling.org>
Ryan D Johnson <ryan@innerfence.com>
Drew Taylor <drew@drewtaylor.com>
Tomas Doran <bobtfish@bobtfish.net>
Florian Ragwitz <rafl@debian.org>
Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
Ævar Arnfjörð Bjarmason <avar@cpan.org>
Chris Prather <perigrin@cpan.org>
Karen Etheridge <ether@cpan.org>
Jonathan Swartz <swartz@pobox.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Infinity Interactive, Inc.

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

MooseX-Getopt documentation

Contained in the MooseX-Getopt distribution.

package MooseX::Getopt::ProcessedArgv;
BEGIN {
  $MooseX::Getopt::ProcessedArgv::AUTHORITY = 'cpan:STEVAN';
}
BEGIN {
  $MooseX::Getopt::ProcessedArgv::VERSION = '0.37';
}
use Moose;
# ABSTRACT: MooseX::Getopt::ProcessedArgv - Class containing the results of process_argv

has 'argv_copy'          => (is => 'ro', isa => 'ArrayRef');
has 'extra_argv'         => (is => 'ro', isa => 'ArrayRef');
has 'usage'              => (is => 'ro', isa => 'Maybe[Object]');
has 'constructor_params' => (is => 'ro', isa => 'HashRef');
has 'cli_params'         => (is => 'ro', isa => 'HashRef');

no Moose;

__PACKAGE__->meta->make_immutable();

1;


__END__