Log::Di...::Output(3)

🌸 NAME 🌸

Hey bestie, welcome to Log::Di...::Output(3)! This is the page for Log::Dispatch::Output — the base class for all Log::Dispatch::* objects. Periodt. 💅

💖 VERSION 💖

version 2.71 — yes, that's the version, no cap.

✨ SYNOPSIS ✨

okay so here's the whole starter-pack vibe. Copy this, bestie:

package Log::Dispatch::MySubclass;

use Log::Dispatch::Output;
use base qw( Log::Dispatch::Output );

sub new {
    my $proto = shift;
    my $class = ref $proto || $proto;

    my %p = @_;

    my $self = bless {}, $class;

    $self->_basic_init(%p);

    # Do more if you like

    return $self;
}

sub log_message {
    my $self = shift;
    my %p    = @_;

    # Do something with message in $p{message}
}

1;

🦋 DESCRIPTION 🦋

This module is the base class from which all Log::Dispatch::* objects should be derived. That's it, that's the whole gig. 💜

🎀 CONSTRUCTOR 🎀

The constructor, new, must be overridden in a subclass. If you want the deets on the common parameters accepted by this constructor, check out Output Classes — it's giving "look there for the common params." 🫶

👑 METHODS 👑

This class provides the following methods:

• $output->_basic_init(%p) — call this from your subclass's constructor. Make sure to pass the arguments in @_ to it. It sets the object's name and minimum level from the passed parameters. It also sets up two other attributes used by other Log::Dispatch::Output methods: level_names and level_numbers. Subclasses will perform parameter validation in this method, and they must also call the superclass's method. No skipping, bestie. 💅
• $output->name — returns the object's name.
• $output->min_level — returns the object's minimum log level.
• $output->max_level — returns the object's maximum log level.
• $output->accepted_levels — returns a list of the object's accepted levels (by name) from minimum to maximum.
• $output->log( level => $, message => $ ) — sends a message if the level is greater than or equal to the object's minimum level. This method applies any message formatting callbacks that the object may have.
• $output->_should_log ($) — this method is called from the log() method with the log level of the message to be logged as an argument. It returns a boolean value indicating whether or not the message should be logged by this particular object. The log() method will not process the message if the return value is false.
• $output->_level_as_number ($) — this method takes a log level as a string (or a number) and returns the number of that log level. If it's not given an argument, it returns the calling object's log level instead. If it cannot determine the level, then it will croak.
• $output->add_callback( $code ) — adds a callback (like those given during construction). It is added to the end of the list of callbacks.
• $dispatch->remove_callback( $code ) — removes the given callback from the list of callbacks.

🌈 SUBCLASSING 🌈

This class should be used as the base class for all logging objects you create that you'd like to work under the Log::Dispatch architecture. Subclassing is fairly trivial. For most subclasses, if you simply copy the code in the SYNOPSIS and then put some functionality into the log_message method, then you should be all set. Please make sure to use the _basic_init method as described above. 🧚

The actual logging implementation should be done in a log_message method that you write. Do not override log! That's the rule, periodt.

💀 SUPPORT 💀

Bugs may be submitted at <https://github.com/houseabsolute/Log-Dispatch/issues>. Please don't suffer in silence, bestie.

⭐ SOURCE ⭐

The source code repository for Log-Dispatch can be found at <https://github.com/houseabsolute/Log-Dispatch>. Go peek, iykyk.

🌸 AUTHOR 🌸

Dave Rolsky <autarch@urth.org>. Iconic.

🎀 COPYRIGHT AND LICENSE 🎀

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

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)

The full text of the license can be found in the LICENSE file included with this distribution. Read the license, bestie — it's literally right there.

---

okay that's the whole page! 🌈 This was Log::Di...::Output(3) from perl v5.42.0, dated 2023-04-21. Yes, that's the footer, and yes, I mentioned it. Periodt. 🫶💖