Lire::Report::Section(3pm)

Lire::Report::Section3pm

Interface to the content of the section's element.

Usage

    my $section = Lire::ReportParser::ReportBuilder( "report.xml" );
    foreach my $s ( $report->sections() ) {
        print "Section: '", $s->title(), "' has ", scalar $s->subreports(),
            " subreports in it\n";
    }

Overview

This class offers an API to the section's elements of a Lire report.

Constructor

new( [$title] )

Creates a new Lire::Report::Section. The section's title will be set to the $title parameter if present.

Object methods

title( [$title] )

Returns the section's title, if it has one. The section's title will be changed $title if that parameter is set.

description( [$description] )

Returns this section's description. The description is encoded in DocBook XML.

If the $description parameter is set, this method will set this section's description to this new value. If the $description parameter is undef, that description will be removed.

subreports()

Returns the subreport's included in that section. This will be an array of Lire::Report::Subreport objects.

add_subreport( $subreport )

Adds a subreport to this report. The $subreport parameter should be a Lire::Report::Subreport object.

subreports_by_type( $type )

Returns all the subreports in this section of a the type $type. The subreport's type is the id of the report specification used to compute the reports. The subreports are returned as an array of Lire::Report::Subreport objects.

Version

$Id: Section.pm,v 1.16 2006/07/23 13:16:31 vanbaal Exp $

Releases

6 releases since Debian 3.1 (Sarge); the text changed 5 times.

  1. 3.1
  2. 4.0
  3. 5.0
  4. 6.0
  5. 7
  6. Arch

Author

Francis J. Lacoste <[email protected]>

From lire 2.1.1-8 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.