Section(3pm)            LogReport's Lire Documentation            Section(3pm)


NAME
       Lire::Section - Interface to the content of the section's element.

SYNOPSIS
           my $section = Lire::ReportParser::ReportBuilder( "report.xml" );

           foreach my $s ( $report->sections() ) {
               print "Section: '", $s->title(), "' has ", scalar $s->subreports(),
                   " subreports in it\n";
           }

DESCRIPTION
       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.

SEE ALSO
       Lire::ReportParser::ReportBuilder(3pm) Lire::Report(3pm)
       Lire::Report::Subreport(3pm) Lire::Report::Entry(3pm)
       Lire::Report::Group(3pm)

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

COPYRIGHT
       Copyright (C) 2002 Stichting LogReport Foundation
       LogReport@LogReport.org

       This file is part of Lire.

       Lire is free software; you can redistribute it and/or modify it under
       the terms of the GNU General Public License as published by the Free
       Software Foundation; either version 2 of the License, or (at your
       option) any later version.

       This program is distributed in the hope that it will be useful, but
       WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
       General Public License for more details.

       You should have received a copy of the GNU General Public License along
       with this program (see COPYING); if not, check with
       http://www.gnu.org/copyleft/gpl.html.

AUTHOR
       Francis J. Lacoste <flacoste@logreport.org>

Lire 2.1.1                        2020-07-07                      Section(3pm)