-Revision history for Package::Stash
+Revision history for Package-Stash
-0.04 2010-06-13
- get_package_symbol now doesn't autovivify stash entries. A new method
- get_or_add_package_symbol can now be used for that behavior.
+{{$NEXT}}
- Update %DB::sub on add_package_symbol (Tim Bunce).
+0.04 2010-06-13
+ - get_package_symbol now doesn't autovivify stash entries. A new method
+ get_or_add_package_symbol can now be used for that behavior.
-0.03 2010-05-14
- Rename from Stash::Manip to Package::Stash
+ - Update %DB::sub on add_package_symbol (Tim Bunce).
-0.02 2010-05-13
- Need to dep on Test::Exception
+0.03 2010-05-14
+ - Rename from Stash::Manip to Package::Stash
-0.01 2010-05-12
- Initial release
+0.02 2010-05-13
+ - Need to dep on Test::Exception
+
+0.01 2010-05-12
+ - Initial release
package Package::Stash;
use strict;
use warnings;
+# ABSTRACT: routines for manipulating stashes
use Carp qw(confess);
use Scalar::Util qw(reftype);
-=head1 NAME
-
-Package::Stash - routines for manipulating stashes
-
=head1 SYNOPSIS
my $stash = Package::Stash->new('Foo');
NOTE: Most methods in this class require a variable specification that includes
a sigil. If this sigil is absent, it is assumed to represent the IO slot.
-=head1 METHODS
-
-=cut
-
-=head2 new $package_name
+=method new $package_name
Creates a new C<Package::Stash> object, for the package given as the only
argument.
return bless { 'package' => $namespace }, $class;
}
-=head2 name
+=method name
Returns the name of the package that this object represents.
return $_[0]->{package};
}
-=head2 namespace
+=method namespace
Returns the raw stash itself.
}
}
-=head2 add_package_symbol $variable $value %opts
+=method add_package_symbol $variable $value %opts
Adds a new package symbol, for the symbol given as C<$variable>, and optionally
gives it an initial value of C<$value>. C<$variable> should be the name of
*{$pkg . '::' . $name} = ref $initial_value ? $initial_value : \$initial_value;
}
-=head2 remove_package_glob $name
+=method remove_package_glob $name
Removes all package variables with the given name, regardless of sigil.
# ... these functions deal with stuff on the namespace level
-=head2 has_package_symbol $variable
+=method has_package_symbol $variable
Returns whether or not the given package variable (including sigil) exists.
}
}
-=head2 get_package_symbol $variable
+=method get_package_symbol $variable
Returns the value of the given package variable (including sigil).
}
}
-=head2 get_or_add_package_symbol $variable
+=method get_or_add_package_symbol $variable
Like C<get_package_symbol>, except that it will return an empty hashref or
arrayref if the variable doesn't exist.
$self->get_package_symbol(@_, vivify => 1);
}
-=head2 remove_package_symbol $variable
+=method remove_package_symbol $variable
Removes the package variable described by C<$variable> (which includes the
sigil); other variables with the same name but different sigils will be
$self->add_package_symbol($io_desc => $io) if defined $io;
}
-=head2 list_all_package_symbols $type_filter
+=method list_all_package_symbols $type_filter
Returns a list of package variable names in the package, without sigils. If a
C<type_filter> is passed, it is used to select package variables of a given
}
}
-=head1 BUGS
-
-No known bugs.
-
-Please report any bugs through RT: email
-C<bug-package-stash at rt.cpan.org>, or browse to
-L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Package-Stash>.
-
=head1 SEE ALSO
-L<Class::MOP::Package> - this module is a factoring out of code that used to
-live here
-
-=head1 SUPPORT
-
-You can find this documentation for this module with the perldoc command.
-
- perldoc Package::Stash
-
-You can also look for information at:
-
=over 4
-=item * AnnoCPAN: Annotated CPAN documentation
+=item * L<Class::MOP::Package>
-L<http://annocpan.org/dist/Package-Stash>
-
-=item * CPAN Ratings
-
-L<http://cpanratings.perl.org/d/Package-Stash>
-
-=item * RT: CPAN's request tracker
-
-L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Package-Stash>
-
-=item * Search CPAN
-
-L<http://search.cpan.org/dist/Package-Stash>
+This module is a factoring out of code that used to live here
=back
-=head1 AUTHOR
-
- Jesse Luehrs <doy at tozt dot net>
-
-Mostly copied from code from L<Class::MOP::Package>, by Stevan Little and the
-Moose Cabal.
-
-=head1 COPYRIGHT AND LICENSE
-
-This software is copyright (c) 2010 by Jesse Luehrs.
-
-This is free software; you can redistribute it and/or modify it under
-the same terms as perl itself.
-
=cut
1;