NAME

DBIx::Class::Schema::Critic::Violation - A violation of a DBIx::Class::Schema::Critic::Policy

VERSION

version 0.004

SYNOPSIS

use DBIx::Class::Schema::Critic::Violation;

my $violation = DBIx::Class::Schema::Critic::Violation->new(
    description => 'Violated policy',
    explanation => 'Consult the rulebook',
    description => 'The frob table is improperly swizzled.',
);
print "$violation\n";

DESCRIPTION

This class represents DBIx::Class::Schema::Critic::Policy violations flagged by DBIx::Class::Schema::Critic.

ATTRIBUTES

description

A short string briefly describing what's wrong. Only settable at construction.

explanation

A string giving a longer general description of the problem. Only settable at construction.

details

A string describing the issue as it specifically applies to the "element" being critiqued.

element

The schema element that violated a DBIx::Class::Schema::Critic::Policy, as an instance of DBICType. Only settable at construction.

METHODS

stringify

Returns a string representation of the object. The same method is called if the object appears in double quotes.

SUPPORT

Perldoc

You can find documentation for this module with the perldoc command.

perldoc DBIx::Class::Schema::Critic

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

• Search CPAN

  The default CPAN search engine, useful to view POD in HTML format.

  http://search.cpan.org/dist/DBIx-Class-Schema-Critic

• AnnoCPAN

  The AnnoCPAN is a website that allows community annonations of Perl module documentation.

  http://annocpan.org/dist/DBIx-Class-Schema-Critic

• CPAN Ratings

  The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.

  http://cpanratings.perl.org/d/DBIx-Class-Schema-Critic

• CPANTS

  The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

  http://cpants.perl.org/dist/overview/DBIx-Class-Schema-Critic

• CPAN Testers

  The CPAN Testers is a network of smokers who run automated tests on uploaded CPAN distributions.

  http://www.cpantesters.org/distro/D/DBIx-Class-Schema-Critic

• CPAN Testers Matrix

  The CPAN Testers Matrix is a website that provides a visual way to determine what Perls/platforms PASSed for a distribution.

  http://matrix.cpantesters.org/?dist=DBIx-Class-Schema-Critic

• CPAN Testers Dependencies

  The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

  http://deps.cpantesters.org/?module=DBIx::Class::Schema::Critic

Bugs / Feature Requests

Please report any bugs or feature requests through the web interface at https://github.com/mjgardner/DBIx-Class-Schema-Critic/issues. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

https://github.com/mjgardner/DBIx-Class-Schema-Critic

git clone git://github.com/mjgardner/DBIx-Class-Schema-Critic.git

AUTHOR

Mark Gardner <mjgardner@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Mark Gardner.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm DBIx::Class::Schema::Critic

perl -MCPAN -e shell
install DBIx::Class::Schema::Critic