NAME

Data::Object::Opts

ABSTRACT

Data-Object Command-line Options

SYNOPSIS

  use Data::Object::Opts;

  my $opts = Data::Object::Opts->new(
    args => ['--resource', 'users', '--help'],
    spec => ['resource|r=s', 'help|h'],
    named => { method => 'resource' } # optional
  );

  $opts->method; # $resource
  $opts->get('resource'); # $resource

  $opts->help; # $help
  $opts->get('help'); # $help

DESCRIPTION

This package provides an object-oriented interface to the process' command-line options.

INTEGRATIONS

This package integrates behaviors from:

Data::Object::Role::Stashable

LIBRARIES

This package uses type constraints defined by:

Data::Object::Library

ATTRIBUTES

This package has the following attributes.

args

  args(ArrayRef[Str])

The attribute is read-only, accepts (ArrayRef[Str]) values, and is optional.

spec

  spec(ArrayRef[Str])

The attribute is read-only, accepts (ArrayRef[Str]) values, and is optional.

named

  named(HashRef)

The attribute is read-only, accepts (HashRef) values, and is optional.

METHODS

This package implements the following methods.

exists

  exists(Str $key) : Any

The exists method takes a name and returns truthy if an associated value exists.

exists example

  $opts->exists('method'); # exists $resource
  $opts->exists('resource'); # exists $resource

get

  get(Str $key) : Any

The get method takes a name and returns the associated value.

get example

  $opts->get('method'); # $resource
  $opts->get('resource'); # $resource

name

  name(Str $key) : Any

The name method takes a name and returns the stash key if the the associated value exists.

name example

  $opts->name('method'); # resource
  $opts->name('resource'); # resource

parse

  parse(Maybe[ArrayRef] $config) : HashRef

The parse method optionally takes additional Getopt::Long parser configuration options and retuns the options found based on the object args and spec values.

parse example

  my $options = $opts->parse;
  my $options = $opts->parse(['bundle']);

set

  set(Str $key, Maybe[Any] $value) : Any

The set method takes a name and sets the value provided if the associated argument exists.

set example

  $opts->set('method', 'people'); # people
  $opts->set('resource', 'people'); # people

stashed

  stashed() : HashRef

The stashed method returns the stashed data associated with the object.

stashed example

  $opts->stashed; # {...}

warned

  warned() : Num

The warned method returns the number of warnings emitted during option parsing.

warned example

  my $warned = $opts->warned; # $count

warnings

  warnings() : ArrayRef[ArrayRef[Str]]

The warnings method returns the set of warnings emitted during option parsing.

warnings example

  my $warnings = $opts->warnings;
  my $warning = $warnings->[0][0];

  die $warning;

CREDITS

Al Newkirk, +309

Anthony Brummett, +10

Adam Hopkins, +2

José Joaquín Atria, +1

AUTHOR

Al Newkirk, awncorp@cpan.org

LICENSE

Copyright (C) 2011-2019, Al Newkirk, et al.

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

PROJECT

Wiki

Project

Initiatives

Milestones

Contributing

Issues

SEE ALSO

To get the most out of this distribution, consider reading the following:

Do

Data::Object

Data::Object::Class

Data::Object::ClassHas

Data::Object::Role

Data::Object::RoleHas

Data::Object::Library

cpanm Do

perl -MCPAN -e shell
install Do