Scalar::Footnote 0.99_02

Scalar::Footnote is a Perl module that can attach hidden scalars to references.

SYNOPSIS

use Data::Dumper;
use Scalar::Footnote;

my $obj = Foo->new;

# attach invisible footnote to $obj:
$obj->Scalar::Footnote::set( my_key => my footnote );
print Dumper( $obj );

# get it back:
my $note = $obj->Scalar::Footnote::get( my_key );
print "footnote: $noten";

# remove it:
my $note = $obj->Scalar::Footnote::remove( my_key );

Scalar::Footnote lets you attach scalar footnotes to an object (or any kind of reference, really) that are essentially invisible from Perl. For example, if you try dumping an object that has a footnote attached to it, you wont actually see the footnote:

my $obj = bless [qw( foo bar )], Foo;
$obj->Scalar::Footnote::set( Foo => foo note );
print Dumper( $obj );
prints:
$VAR1 = bless [
foo,
bar
], Foo;

You can of course still access the footnote with Scalar::Footnote::get.