James E Keenan > ExtUtils-ModuleMaker > ExtUtils::ModuleMaker::Initializers

Download:
ExtUtils-ModuleMaker-0.52.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Module Version: 0.52   Source  

NAME ^

ExtUtils::ModuleMaker::Initializers - Methods used within ExtUtils::ModuleMaker::new() and ExtUtils::ModuleMaker::Interactive::Main_Menu

DESCRIPTION ^

The methods described below are 'quasi-private' methods which are called by certain publicly available methods of ExtUtils::ModuleMaker and ExtUtils::ModuleMaker::Interactive. They are 'quasi-private' in the sense that they are not intended to be called by the everyday user of ExtUtils::ModuleMaker. Nothing prevents a user from calling these methods, but they are documented here primarily so that users writing plug-ins for ExtUtils::ModuleMaker will know what methods need to be subclassed. Since they are not part of the public interface, their names and functionality may change in future versions of ExtUtils::ModuleMaker.

The methods below are called in ExtUtils::ModuleMaker::new() but not in that same package's complete_build. For methods called in complete_build, please see ExtUtils::ModuleMaker::StandardText. Some of the methods below are also called within methods in ExtUtils::ModuleMaker::Interactive.

Subclassers: At ExtUtils::ModuleMaker's current state of development, it is recommended that you not subclass these methods but instead focus your efforts on subclassing the methods in ExtUtils::ModuleMaker::StandardText. The latter package's methods focus more closely on the structure and content of the files built by ExtUtils::ModuleMaker.

Happy subclassing!

METHODS ^

Methods Called within new()

set_author_composite

  Usage     : $self->set_author_composite() within new() and
              Interactive::Main_Menu()
  Purpose   : Sets $self key COMPOSITE by composing it from $self keys AUTHOR,
              CPANID, ORGANIZATION, EMAIL and WEBSITE
  Returns   : n/a
  Argument  : n/a
  Comment   : 

set_file_composite

  Usage     : $self->set_file_composite() within new()
  Purpose   : Sets $self key COMPOSITE by composing it from $self key NAME
  Returns   : n/a
  Argument  : n/a
  Comment   : 

set_dates()

  Usage     : $self->set_dates() within new()
  Purpose   : Sets 3 keys in $self:  year, timestamp and COPYRIGHT_YEAR
  Returns   : n/a
  Argument  : n/a
  Comment   : 

validate_values()

  Usage     : $self->validate_values() within complete_build() and 
              Interactive::Main_Menu()
  Purpose   : Verify module values are valid and complete.
  Returns   : Error message if there is a problem
  Argument  : n/a
  Throws    : Will die with a death_message if errors and not interactive.
  Comment   : References many $self keys

initialize_license

  Usage     : $self->initialize_license() within new() and
              Interactive::License_Menu
  Purpose   : Gets appropriate license and, where necessary, fills in 'blanks'
              with information such as COPYRIGHT_YEAR, AUTHOR and
              ORGANIZATION; sets $self keys LICENSE and LicenseParts
  Returns   : n/a
  Argument  : n/a 
  Comment   :

SEE ALSO ^

ExtUtils::ModuleMaker.

syntax highlighting: