Daniel P. Berrangé > Test-AutoBuild > Test::AutoBuild::Group

Download:
Test-AutoBuild-1.2.4.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Source  

NAME ^

Test::AutoBuild::Group - Simple grouping of modules

SYNOPSIS ^

  use Test::AutoBuild::Group

  my $group = Test::AutoBuild::Group->new(name => $name,
                                          label => $label,
                                          modules => \@modules,
                                          options => \%options);

  my $name = $group->name([$newname]);
  my $label = $group->label([$newlabel]);
  my $admin = $group->admin([$newadmin]);
  my \@modules = $group->modules([\@modules]);
  my $value = $group->option($name[, $newvalue]);

DESCRIPTION ^

The Test::AutoBuild::Group module provides for simple grouping of modules. Its primary purpose is to allow the list of modules in HTML status pages to be split up into groups for easy browsing.

CONFIGURATION ^

The valid configuration options for the groups block are

METHODS ^

my $group = Test::AutoBuild::Group->new(name => $name, label => $label, [modules => \@modules,] [admin => $admin,] [options => \%options]);

Creates a new group object. modules is an array ref of Test::AutoBUild::Module objects representing the members of the group. name is a short alphanumeric token for the name of the group. label is a free text title for the group. admin is the name/contact details of the group administrator. options is a hash ref of arbitrary options for the group.

my $name = $group->name([$newname]);

Gets the name of the group. The name is a short alphanumeric token. If the newname parameter is supplied then the name is updated.

my $label = $group->label([$newlabel]);

Gets the label of the group. The label is a free text title for the group. If the newlabel parameter is supplied then the label is updated.

my $admin = $group->admin([$newadmin]);

Gets the admin of the group. The admin property is free text representing the group admin name and contact details. If the newadmin parameter is supplied then the admin property is updated.

my \@modules = $group->modules([\@newmodules]);

Gets an array ref representing the members of the group. Each element in the array is an instance of the Test::AutoBuild::Module class. If the newmodules array ref is supplied, then the members of the group are updated.

my $value = $group->option($name, [$newvalue]);

Gets the value corresponding to the option name. If the second newvalue parameter is specified then the value for the option is updated.

AUTHORS ^

Daniel Berrange <dan@berrange.com>

COPYRIGHT ^

Copyright (C) 2002-2004 Daniel Berrange <dan@berrange.com>

SEE ALSO ^

perl(1)

syntax highlighting: