Data::Object::Args - Args Class
Args Class for Perl 5
package main; use Data::Object::Args; local @ARGV = qw(--help execute); my $args = Data::Object::Args->new( named => { flag => 0, command => 1 } ); # $args->flag; # $ARGV[0] # $args->get(0); # $ARGV[0] # $args->get(1); # $ARGV[1] # $args->action; # $ARGV[1] # $args->exists(0); # exists $ARGV[0] # $args->exists('flag'); # exists $ARGV[0] # $args->get('flag'); # $ARGV[0]
This package provides methods for accessing @ARGS items.
@ARGS
This package integrates behaviors from:
Data::Object::Role::Buildable
Data::Object::Role::Proxyable
Data::Object::Role::Stashable
This package uses type constraints from:
Types::Standard
This package has the following attributes:
named(HashRef)
This attribute is read-only, accepts (HashRef) values, and is optional.
(HashRef)
This package implements the following methods:
exists(Str $key) : Any
The exists method takes a name or index and returns truthy if an associated value exists.
# given: synopsis $args->exists(0); # truthy
# given: synopsis $args->exists('flag'); # truthy
# given: synopsis $args->exists(2); # falsy
get(Str $key) : Any
The get method takes a name or index and returns the associated value.
# given: synopsis $args->get(0); # --help
# given: synopsis $args->get('flag'); # --help
# given: synopsis $args->get(2); # undef
name(Str $key) : Any
The name method takes a name or index and returns index if the the associated value exists.
# given: synopsis $args->name('flag'); # 0
set(Str $key, Maybe[Any] $value) : Any
The set method takes a name or index and sets the value provided if the associated argument exists.
# given: synopsis $args->set(0, '-?'); # -?
# given: synopsis $args->set('flag', '-?'); # -?
# given: synopsis $args->set('verbose', 1); # undef # is not set
stashed() : HashRef
The stashed method returns the stashed data associated with the object.
# given: synopsis $args->stashed
unnamed() : ArrayRef
The unnamed method returns an arrayref of values which have not been named using the named attribute.
named
package main; use Data::Object::Args; local @ARGV = qw(--help execute --format markdown); my $args = Data::Object::Args->new( named => { flag => 0, command => 1 } ); $args->unnamed # ['--format', 'markdown']
package main; use Data::Object::Args; local @ARGV = qw(execute phase-1 --format markdown); my $args = Data::Object::Args->new( named => { command => 1 } ); $args->unnamed # ['execute', '--format', 'markdown']
Al Newkirk, awncorp@cpan.org
awncorp@cpan.org
Copyright (C) 2011-2019, Al Newkirk, et al.
This is free software; you can redistribute it and/or modify it under the terms of the The Apache License, Version 2.0, as elucidated in the "license file".
Wiki
Project
Initiatives
Milestones
Contributing
Issues
To install Data::Object::Args, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Data::Object::Args
CPAN shell
perl -MCPAN -e shell install Data::Object::Args
For more information on module installation, please visit the detailed CPAN module installation guide.