perldoc > Class::MOP::Package

man perldoc info pydoc3 ri search

📛 NAME

Class::MOP::Package - Package Meta Object

🚀 Quick Reference

Use Case	Command	Description
Get or create a metaclass for a package	Class::MOP::Package->initialize($package_name)	Returns an existing metaclass or creates a new one
Force reinitialize a package metaclass	Class::MOP::Package->reinitialize($package, %options)	Removes existing metaclass, then calls initialize
Create a new anonymous package	Class::MOP::Package->create_anon(%options)	Creates an anonymous package, optionally cached
Check if package is anonymous	$metapackage->is_anon	Returns true if anonymous
Get package name	$metapackage->name	Returns the package name
Get namespace symbol table	$metapackage->namespace	Returns hashref of symbol table
Add a package variable	$metapackage->add_package_symbol($variable_name, $initial_value)	Creates a variable in the symbol table
Get a package variable	$metapackage->get_package_symbol($variable_name)	Returns variable as reference or undef
Get or create a package variable	$metapackage->get_or_add_package_symbol($variable_name)	Returns existing or default variable
Check if package variable exists	$metapackage->has_package_symbol($variable_name)	Returns true if defined
Remove a package variable	$metapackage->remove_package_symbol($variable_name)	Removes the variable from symbol table
Remove a glob by name	$metapackage->remove_package_glob($glob_name)	Removes all variables and subs with that name
List all glob names	$metapackage->list_all_package_symbols($type_filter)	Returns list of glob names (no sigils)
Get all glob names and values	$metapackage->get_all_package_symbols($type_filter)	Returns hashref of name => value
Get metaclass of this class	Class::MOP::Package->meta	Returns a Class::MOP::Class instance

📦 VERSION

version 2.2200

📖 DESCRIPTION

The Package Protocol provides an abstraction of a Perl 5 package. A package is basically a namespace, and this module provides methods for looking at and changing that namespace's symbol table.

🔧 METHODS

• Class::MOP::Package->initialize($package_name, %options) — This method creates a new Class::MOP::Package instance which represents the specified package. If an existing metaclass object exists for the package, that will be returned instead. No options are valid at the package level.
• Class::MOP::Package->reinitialize($package, %options) — This method forcibly removes any existing metaclass for the package before calling initialize. In contrast to initialize, you may also pass an existing Class::MOP::Package instance instead of just a package name as $package. Do not call this unless you know what you are doing.
• Class::MOP::Package->create($package, %options) — Creates a new Class::MOP::Package instance which represents the specified package, and also does some initialization of that package. Currently, this just does the same thing as initialize, but is overridden in subclasses, such as Class::MOP::Class.
• Class::MOP::Package->create_anon(%options) — Creates a new anonymous package. Valid keys for %options are:
  • cache — If this will be true (the default is false), the instance will be cached in Class::MOP's metaclass cache.
  • weaken — If this is true (the default true when cache is false), the instance stored in Class::MOP's metaclass cache will be weakened, so that the anonymous package will be garbage collected when the returned instance goes out of scope.
• $metapackage->is_anon — Returns true if the package is an anonymous package.
• $metapackage->name — Returns the package's name, as passed to the constructor.
• $metapackage->namespace — Returns a hash reference to the package's symbol table. The keys are symbol names and the values are typeglob references.
• $metapackage->add_package_symbol($variable_name, $initial_value) — Accepts a variable name and an optional initial value. The $variable_name must contain a leading sigil. Creates the variable in the package's symbol table, and sets it to the initial value if provided.
• $metapackage->get_package_symbol($variable_name) — Given a variable name, returns the variable as a reference or undef if it does not exist. The $variable_name must contain a leading sigil.
• $metapackage->get_or_add_package_symbol($variable_name) — Given a variable name, returns the variable as a reference. If it does not exist, a default value will be generated if possible. The $variable_name must contain a leading sigil.
• $metapackage->has_package_symbol($variable_name) — Returns true if there is a package variable defined for $variable_name. The $variable_name must contain a leading sigil.
• $metapackage->remove_package_symbol($variable_name) — Removes the package variable specified by $variable_name. The $variable_name must contain a leading sigil.
• $metapackage->remove_package_glob($glob_name) — Given the name of a glob, removes that glob from the package's symbol table. Glob names do not include a sigil. Removing the glob removes all variables and subroutines with the specified name.
• $metapackage->list_all_package_symbols($type_filter) — Lists all the glob names associated with the current package. These names do not have leading sigils. Optional type filter: one of SCALAR, ARRAY, HASH, or CODE.
• $metapackage->get_all_package_symbols($type_filter) — Works like list_all_package_symbols, but returns a hash reference. Keys are glob names, values are references to the value for that name.
• Class::MOP::Package->meta — Returns a Class::MOP::Class instance for this class.

✍️ AUTHORS

• Stevan Little <stevan AT cpan.org>
• Dave Rolsky <autarch AT urth.org>
• Jesse Luehrs <doy AT cpan.org>
• Shawn M Moore <sartak AT cpan.org>
• יובל קוג'מן (Yuval Kogman) <nothingmuch AT woobling.org>
• Karen Etheridge <ether AT cpan.org>
• Florian Ragwitz <rafl AT debian.org>
• Hans Dieter Pearcey <hdp AT cpan.org>
• Chris Prather <chris AT prather.org>
• Matt S Trout <mstrout AT cpan.org>

📄 COPYRIGHT AND LICENSE

This software is copyright (c) 2006 by Infinity Interactive, Inc.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

📛 NAME 🚀 Quick Reference 📦 VERSION 📖 DESCRIPTION 🔧 METHODS ✍️ AUTHORS 📄 COPYRIGHT AND LICENSE