Randy J Ray > Catalyst-Model-ISBNDB-0.22 > Catalyst::Helper::Model::ISBNDB

Download:
Catalyst-Model-ISBNDB-0.22.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.12   Source  

NAME ^

Catalyst::Helper::Model::ISBNDB - Catalyst::Helper assist for ISBNDB

SYNOPSIS ^

    perl script/myapp_create.pl model MyISBNDB ISBNDB API_KEY

DESCRIPTION ^

This is a Catalyst::Helper component to allow you to add model components deriving from the Catalyst::Model::ISBNDB class, using the Catalyst-generated create.pl helper-script.

When run via the creation-helper, a new model class and a simple test suite for it will be added to your Catalyst application. The class will be added in the same directory as your other models, and the test added to the t/ directory in the top-level of the project.

USAGE ^

When the helper script is invoked, you provide it with 3 or 4 arguments:

model

This is always model, when adding a model component.

MyClass

The name of the new class you want to add.

ISBNDB

The name of the model class you are deriving from, ISBNDB in this case.

API_KEY

(This parameter is optional.)

The isbndb.com API key your application will be using, if you wish to have it explicitly defined in the configuration block of the new class.

You can provide just model and ISBNDB alone (two arguments), in which case the new class will be given a name using your project's class hierarchy and ending in ISBNDB, and no default API key will be configured.

METHODS ^

This class defines the following two methods:

mk_compclass($SELF, $HELPER, [$KEY])

Creates the class by using the Catalyst::Helper instance pointed to by $HELPER. If $KEY is passed and is non-null, the call to config in the generated class will set the value as the default API key used for data calls to isbndb.com.

mk_comptest($SELF, $HELPER)

Creates the unit test suite for the new model. Does this by using the Catalyst::Helper instance pointed to by $HELPER.

SEE ALSO ^

Catalyst::Model::ISBNDB, Catalyst::Helper

BUGS ^

Please report any bugs or feature requests to bug-catalyst-model-isbndb at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-Model-ISBNDB. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

COPYRIGHT & LICENSE ^

This file and the code within are copyright (c) 2009 by Randy J. Ray.

Copying and distribution are permitted under the terms of the Artistic License 2.0 (http://www.opensource.org/licenses/artistic-license-2.0.php) or the GNU LGPL 2.1 (http://www.opensource.org/licenses/lgpl-2.1.php).

AUTHOR ^

Randy J. Ray <rjray@blackperl.com>

syntax highlighting: