Lire::OutputJob.3pm

Langue: en

Autres versions - même langue

Version: 2006-07-23 (mandriva - 22/10/07)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

Lire::OutputJob - Object used to represent a configured formatting of a report

SYNOPSIS

   use Lire::OutputJob;
   use Lire::OutputFormat;
 
 

   my $email = new Lire::OutputJob( 'email', $output, $output_cfg,
                                    'emails' => [ 'email@domain.org' ] );
 
 

   $email->run( 'report.xml' );
 
 

   my $file = new Lire::OutputJob( 'file', $output, $output_cfg,
                                   'filename' => '/var/www/reports/daily-%Y%m%d'  );
   $file->run( 'report.xml' );

DESCRIPTION

The Lire::OutputJob objects are used to represent how a report should formatted. These objects are most often created from the Lire configuration. (The 'output_jobs' specification.)

new( $destination_type, $format, $format_cfg, ... );

Create a new Lire::OutputJob object. Two parameters are required:
$destination_type
Can be either 'email' or 'file'.
$format
A Lire::OutputFormat object.
$format
The configuration data that will be passed to the OutputFormat object.

The method will returns an instance of Lire::EmailOutputJob or Lire::FileOutputJob.

format

Returns the Lire::OutputFormat associated with this OutputJob.

format_cfg

Returns the configuration data that will be used when formatting the report.

run( $report_file )


run( $report_file )

Formats and sends or save the XML report $report_file according the OutputJob parameters.

Lire::EmailOutputJob


Extra parameters for 'email' type

emails
An array reference to the emails that will receive the formatted report.
subjet
The subject of the email.
extra_file
An additional text file that will be appended to text report or attach to other report types.
*

emails()

Returns as an array the emails to which the report will be sent.

subject()

Returns the subject of the email.

extra_file()

Returns the filename that will be appended to the text report or attach to the message for other report's type.

Lire::FileOutputJob


Extra parameters for 'file' type.

file
A file path with possible strftime(3pm) interpolation. This will be were the formatted report will be saved.

file()

Returns this OutputJob destination file.

output_file( [$time] )

Returns the destination file with strftime(3) specifier interpolated.

SEE ALSO

Lire::ReportJob(3pm) Lire::OutputFormat(3pm)

AUTHOR

   Francis J. Lacoste <flacoste@logreport.org>

VERSION

$Id: OutputJob.pm,v 1.8 2006/07/23 13:16:29 vanbaal Exp $ Copyright (C) 2004 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.