GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PERL::CRITIC::POLICY::VARIABLES::PROHIBITPACKAGEVARS (3)

.ds Aq ’

NAME

Perl::Critic::Policy::Variables::ProhibitPackageVars - Eliminate globals declared with "our" or "use vars".

CONTENTS

AFFILIATION

This Policy is part of the core Perl::Critic distribution.

DESCRIPTION

Conway suggests avoiding package variables completely, because they expose your internals to other packages. Never use a package variable when a lexical variable will suffice. If your package needs to keep some dynamic state, consider using an object or closures to keep the state private.

This policy assumes that you’re using strict vars so that naked variable declarations are not package variables by default. Thus, it complains you declare a variable with our or use vars, or if you make reference to variable with a fully-qualified package name.



    $Some::Package::foo = 1;    # not ok
    our $foo            = 1;    # not ok
    use vars $foo;            # not ok
    $foo = 1;                   # not allowed by strict
    local $foo = 1;             # bad taste, but technically ok.
    use vars $FOO;            # ok, because its ALL CAPS
    my $foo = 1;                # ok



In practice though, its not really practical to prohibit all package variables. Common variables like $VERSION and @EXPORT need to be global, as do any variables that you want to Export. To work around this, the Policy overlooks any variables that are in ALL_CAPS. This forces you to put all your exported variables in ALL_CAPS too, which seems to be the usual practice anyway.

CONFIGURATION

There is room for exceptions. Some modules, like the core File::Find module, use package variables as their only interface, and others like Data::Dumper use package variables as their most common interface. These module can be specified from your .perlcriticrc file, and the policy will ignore them.



    [Variables::ProhibitPackageVars]
    packages = Data::Dumper File::Find FindBin Log::Log4perl



This is the default setting. Using packages = will override these defaults.

You can also add packages to the defaults like so:



    [Variables::ProhibitPackageVars]
    add_packages = My::Package



You can add package main to the list of packages, but that will only OK variables explicitly in the main package.

SEE ALSO

Perl::Critic::Policy::Variables::ProhibitPunctuationVars

Perl::Critic::Policy::Variables::ProhibitLocalVars

AUTHOR

Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT

Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PERL::CRITIC::POLICY::VARIABLES::PROHIBITPACKAGEVARS (3) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.