What exactly does the 'our' declaration do? When it was first introduced, the documentation was not clear. Now, the documentation is better and existing modules offers examples of what it's good for.

First, let's look at it as compared with 'my'. The docs give this example:

use strict;
use warnings;

package Foo;
our $bar;           # declares $Foo::bar for rest of lexical scope
$bar = 20;

package Bar;
print $bar;         # prints 20
[download]

Now if you try the same thing with 'my' instead of 'our',

use strict;
use warnings;

package Foo;
my $bar;           # declares bar as lexical for rest of lexical scope
$bar = 20;

package Bar;
print $bar;         # prints 20
[download]

you get the exact same result. So, the explaination in the docs of how 'our' does the scope thing

An our declaration declares a global variable that will be visible across its entire lexical scope, even across package boundaries. The package in which the variable is entered is determined at the point of the declaration, not at the point of use

is in fact no different from what 'my' does. We're already used to that kind of thing, and this is nothing new. So don't worry about it. (Understanding different scopes is another question, though.)

The difference—the real purpose—is that 'my' variables are not entered into the run-time symbol table. In the second example above, there is no such thing as $Foo::bar, so the $bar variable cannot be accessed outside of its lexical scope or pointed to with a symboloc link. Since $bar is not an abbreviation for $Foo::bar, the fact that it crosses package boundaries is largely unnoticed.

In the first example, our $bar is another name for $Foo::bar, and it is in the symbol table. However, the fact that it can be refered to as plain $bar works in exactly the same way as the 'my'. It's a lexical scope where the name $bar can be used, and where it is so used, it refers to the same memory as $Foo::bar.

So, the difference between 'my' and 'our' is that 'my' variables are not in the symbol table, while 'our' variables are put in the current symbol table where the 'our' is encountered.

In modules, a common use for 'our' is to declare global variables. The way they cross package boundaries is usually not noticed, with one package per class. With strict in effect, package variables would need to be refered to with full names, and an older way around that is with use vars. Anything that must be in the symbol table, such as the $EXPORTS and @ISA and any variables you want to be visible from outside of the module, cannot be 'my'. Previously you would either qualify all uses to them, or use a use vars line. Now, you can declare them with 'our' instead.

---

---

Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!

Titles consisting of a single word are discouraged, and in most cases are disallowed outright.

Read Where should I post X? if you're not absolutely sure you're posting in the right place.

Please read these before you post! —

• How do I compose an effective node title?
• How do I post a question effectively?
• Markup in the Monastery

Posts may use any of the Perl Monks Approved HTML tags:

a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr

You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)

	For:		Use:
	&		&
	<		&lt;
	>		&gt;
	[		&#91;
	]		&#93;

Link using PerlMonks shortcuts! What shortcuts can I use for linking?

See Writeup Formatting Tips and other pages linked from there for more info.