Kevin L. Esteb > XAS-0.04 > XAS::Base

Download:
XAS-0.04.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.01   Source   Latest Release: XAS-0.05

NAME ^

XAS::Base - The base class for the XAS environment

SYNOPSIS ^

 use XAS::Class
   version => '0.01',
   base    => 'XAS::Base',
   vars => {
       PARAMS => {}
   }
 ;

DESCRIPTION ^

This module defines a base class for the XAS Environment and inherits from Badger::Base. The package variable $PARAMS is used to hold the parameters that this class uses for initialization. The parameters can be changed or extended by inheriting classes. This is functionality provided by Badger::Class. The parameters are validated using Params::Validate. Any parameters defined in $PARAMS automagically become accessors toward their values.

METHODS ^

new($parameters)

This is used to initialized the class. It takes various parameters defined by the $PARAMS package variable.

config($item)

This method will return an item from the internal class config. Which is usually the parameters passed to new() before any manipulation of those parameters.

$item

The item you want to return,

validation_exception($params, $class)

This method is used by Params::Validate to display it's failure message.

$params

The parameter that caused the exception.

$class

The class that it happened in.

env

A handle to XAS::System::Environment.

SEE ALSO ^

XAS

AUTHOR ^

Kevin L. Esteb, <kevin@kesteb.us>

COPYRIGHT AND LICENSE ^

Copyright (C) 2012 by Kevin L. Esteb

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: