DOKK / manpages / debian 12 / libmoosex-app-perl / MooseX::App::Plugin::Depends.3pm.en
MooseX::App::Plugin::Depends(3pm) User Contributed Perl Documentation MooseX::App::Plugin::Depends(3pm)

MooseX::App::Plugin::Depends - Adds dependent options

In your base class:

 package MyApp;
 use MooseX::App qw(Depends);
 
 use Moose::Util::TypeConstraints;
 option 'FileFormat' => (
   is  => 'ro',
   isa => enum( [qw(tsv csv xml)] ),
 );
 option 'WriteToFile' => (
   is       => 'ro',
   isa      => 'Bool',
   depends => [qw(FileFormat)],
 );

In your script:

 #!/usr/bin/env perl
 use strict;
 use warnings;
 use MyApp;
 MyApp->new_with_options( WriteToFile => 1 );
 # generates Error
 # Option 'WriteToFile' requires 'FileFormat' to be defined
 MyApp->new_with_options( WriteToFile => 1, FileFormat => 'tsv );
 # generates no errors
 MyApp->new_with_options();
 # generates no errors

In many real-world scenarios, sets of options are, by design, needed to be specified together. This plugin adds the ability to create dependent options to your application, options that require one or more other options for your application to perform properly.

2022-10-16 perl v5.34.0