Rodrigo de Oliveira Gonzalez > CatalystX-Features > CatalystX::Features::Role::Feature

Download:
CatalystX-Features-0.25.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.25   Source  

NAME ^

CatalystX::Features::Role::Feature - Role for implementing a single feature.

VERSION ^

version 0.25

DESCRIPTION ^

This role is an interface. No code here.

REQUIRED ATTRIBUTES ^

path

Needed by the constructor. Receives a full path to the feature, i.e.

        /home/myapp/features/my.simple.feature_1.0.0

backend

Needed by the constructor. Passed the instance of the controller. Should have a type of CatalystX::Features::Role::Backend.

        has 'backend' => ( is=>'ro', isa=>'CatalystX::Features::Role::Backend', required=>1 );

REQUIRED METHODS ^

id

The last folder in the feature path, say my.feature_1.0. It's used as a unique identifier for this feature.

name

The name of the feature, say my.simple.feature. This is also a unique identifier application wide. There should not exist 2 or more features with the same name loaded at any given time.

version

A version token of any format.

version_number

A version long integer that can be compared easily.

root

Returns the full path to the /root dir for a given feature. Used by many View modifiers.

lib

Returns the full path of the /lib dir for a given feature. Used by @INC modifiers or any plugins.

AUTHORS ^

        Rodrigo de Oliveira (rodrigolive), C<rodrigolive@gmail.com>

LICENSE ^

This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: