Dave Rolsky > Chloro > Chloro::Group

Download:
Chloro-0.06.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.06   Source  

NAME ^

Chloro::Group - A field in a form

VERSION ^

version 0.06

SYNOPSIS ^

See Chloro.

DESCRIPTION ^

This class represents a group in a form.

METHODS ^

This class has the following methods:

Chloro::Group->new()

You'll probably make groups by using the group() subroutine exported by Chloro, but you can make one using this constructor.

The constructor accepts the following parameters:

$group->name()

The name as passed to the constructor.

$group->human_name()

A more friendly name, which defaults to the same value as $group->name().

$group->fields()

Returns a list of Chloro::Field objects for this group

$group->get_field($name)

Given a name, returns the field of that name in the group, if one exists.

$group->repetition_key()

The name of the repetition key field for this group.

$group->is_empty_checker()

Returns the method used to determine whether the group is empty. This defaults to _group_is_empty, a method provided by Chloro::Role::Form.

$group->dump()

Returns a data structure representing the group definition. This exists primarily for testing.

ROLES ^

This class consumes the Chloro::Role::FormComponent role.

AUTHOR ^

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE ^

This software is Copyright (c) 2011 by Dave Rolsky.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)
syntax highlighting: