| MooseX::App::Meta::Role::Class::Base(3pm) | User Contributed Perl Documentation | MooseX::App::Meta::Role::Class::Base(3pm) |
MooseX::App::Meta::Role::Class::Base - Meta class role for application base class
This meta class role will automatically be applied to the application base class. This documentation is only of interest if you intend to write plugins for MooseX-App.
Message class for generating error messages. Defaults to MooseX::App::Message::Block. The default can be overwritten by altering the "_build_app_messageclass" method. Defaults to MooseX::App::Message::Block
Usually MooseX::App will take the package name of the base class as the namespace for commands. This namespace can be changed.
Exclude namespaces included in app_namespace
Usually MooseX::App will take the name of the calling wrapper script to construct the program name in various help messages. This name can be changed via the app_base accessor. Defaults to the base name of $0
Boolean flag that controls if command names and attributes should be matched exactly or fuzzy. Defaults to true.
Coderef attribute that controls how package names are translated to command names and attributes. Defaults to &MooseX::App::Utils::class_to_command
Hashref with command to command class map.
Boolean flag that controls if an application with superfluous/unknown positional parameters should terminate with an error message or not. If disabled all extra parameters will be copied to the extra_argv command class attribute.
By default, arguments passed to new_with_command and new_with_options have a higher priority than the command line options. This boolean flag will give the command line an higher priority.
Boolean flag that controls if command line arguments that take multiple values (ie ArrayRef or HashRef type constraints) can be permuted.
Runs sanity checks on options and parameters. Will usually only be executed if either HARNESS_ACTIVE or APP_DEVELOPER environment are set.
$self->command_register($command_moniker,$command_class);
Registers an additional command
my $command_class = $self->command_register($command_moniker);
Returns a command class for the given command moniker
my $command_moniker = $meta->command_class_to_command($command_class);
Returns the command moniker for the given command class.
my $message = $meta->command_message(
header => $header,
type => 'error',
body => $message
);
Generates a message object (using the class from app_messageclass)
my @attributes = $meta->command_usage_attributes($metaclass);
Returns a list of attributes/command options for the given meta class.
my @messages = $meta->command_usage_command($command_metaclass);
Returns a list of messages containing the documentation for a given command meta class.
my $message = $meta->command_usage_description($command_metaclass);
Returns a messages with the basic command description.
my @messages = $meta->command_usage_global();
Returns a list of messages containing the documentation for the application.
my $message = $meta->command_usage_header(); my $message = $meta->command_usage_header($command_meta_class);
Returns a message containing the basic usage documentation
my @commands = $meta->command_find($commands_arrayref);
Returns a list of command names matching the user input
my $commands = $meta->command_candidates($user_command_input);
Returns either a single command or an arrayref of possibly matching commands.
my ($result,$errors) = $meta->command_proto($command_meta_class);
Returns all parsed options (as hashref) and erros (as arrayref) for the proto command. Is a wrapper around command_parse_options.
my ($options,$errors) = $self->command_args($command_meta_class);
Returns all parsed options (as hashref) and erros (as arrayref) for the main command. Is a wrapper around command_parse_options.
my ($options,$errors) = $self->command_parse_options(\@attribute_metaclasses);
Tries to parse the selected attributes from @ARGV.
my %namespaces = $self->command_scan_namespace($namespace);
Scans a namespace for command classes. Returns a hash with command names as keys and package names as values.
my @attributes = $self->command_process_attribute($attribute_metaclass,$matches);
TODO ###Returns a list of all attributes with the given type
my $usage = $self->command_usage_options($metaclass,$headline);
Returns the options usage as a message object
my $usage = $self->command_usage_parameters($metaclass,$headline);
Returns the positional parameters usage as a message object
$errors = $self->command_check_attributes($command_metaclass,$errors,$params)
Checks all attributes. Returns/alters the $errors arrayref
$self->command_parser_hints($self,$metaclass)
Generates parser hints as required by MooseX::App::ParsedArgv
| 2017-10-02 | perl v5.26.0 |