Rob Brown > Getopt-GetArgs-1.03 > Getopt::GetArgs

Download:
Getopt-GetArgs-1.03.tar.gz

Dependencies

Annotate this POD

Related Modules

Getopt::Tiny
Getopt::Long
Getopt::Std
Getopt::ArgvFile
Getopt::Simple
Getopt::Regex
Getopt::Attribute
Getopt::Declare
Getopt::Tabular
CGI::Application
more...
By perlmonks.org
View/Report Bugs
Module Version: 1.03   Source  

NAME ^

GetArgs - Perl module to allow enhanced argument passing, including passing of case-insensitive named arguments as well as positioned arguments.

SYNOPSIS ^

  sub WHATEVER {
    my @DEFAULT_ARGS =
      ( Content => "Default content",
        Verbose => 0 
        );
    my %ARGS=GetArgs(@_,@DEFAULT_ARGS);
    # do some stuff with $ARGS{Content}
    # show all kinds of detail if $ARGS{Verbose}
  }

  # a simple call to WHATEVER
  WHATEVER( "Just deal with my content" );

  # a flexible call to WHATEVER
  WHATEVER({ verbose => 1,
             content => "This is my content",
           });

DESCRIPTION ^

GetArgs needs to know * what your subroutine was passed, * and what it expected to be passed. * If you like, you can also supply default values to use when an argument is not passed.

Using this information, GetArgs will create a hash of arguments for you to use throughout your subroutine. Using GetArgs has several advantages:

  1) Calls to your subroutine can pass named arguments, making the code more readable.
  2) If it's easier to pass a list of arguments as you normally would, that's fine.  
  3) With GetArgs your use of arguments in your subroutine code is more readable.
  4) Your subroutines are no longer limited in the number of arguments they expect.
  5) Arguments can be passed in any order (if passed inside the hash ref), thus 
     only the arguments relevant to that call need to be passed--unnecessary 
     arguments can be ignored.
  6) Case is not important, as GetArgs matches argument names case insensitively.

AUTHOR ^

Special thanks to Sam Mefford who helped design and wrote most of the code for the original version.

Much polishing in preparation for release to CPAN was performed by Earl Cahill. (earl@cpan.org)

Maintained by Rob Brown (rob@roobik.com)

COPYRIGHT ^

Copyright (c) 2001, Rob Brown. All rights reserved. Getopt::GetArgs is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

$Id: GetArgs.pm,v 1.4 2001/06/08 06:26:44 rob Exp $

syntax highlighting: