pod fixes

[catagits/Catalyst-Plugin-ConfigLoader.git] / lib / Catalyst / Plugin / ConfigLoader / YAML.pm

package Catalyst::Plugin::ConfigLoader::YAML;\r
\r
use strict;\r
use warnings;\r
\r
use File::Slurp;\r
\r
=head1 NAME\r
\r
Catalyst::Plugin::ConfigLoader::YAML - Load YAML config files\r
\r
=head1 DESCRIPTION\r
\r
Loads YAML files. Example:\r
\r
    ---\r
    name: TestApp\r
    Controller::Foo:\r
        foo: bar\r
\r
=head1 METHODS\r
\r
=head2 extensions( )\r
\r
return an array of valid extensions (C<yml>, C<yaml>).\r
\r
=cut\r
\r
sub extensions {\r
    return qw( yml yaml );\r
}\r
\r
=head2 load( $file )\r
\r
Attempts to load C<$file> as a YAML file.\r
\r
=cut\r
\r
sub load {\r
    my $class = shift;\r
    my $file  = shift;\r
\r
    eval { require YAML::Syck; };\r
    if( $@ ) {\r
        require YAML;\r
        return YAML::LoadFile( $file );\r
    }\r
    else {\r
        my $content = read_file( $file );\r
        return YAML::Syck::Load( $content );\r
    }\r
}\r
\r
=head1 AUTHOR\r
\r
=over 4 \r
\r
=item * Brian Cassidy E<lt>bricas@cpan.orgE<gt>\r
\r
=back\r
\r
=head1 COPYRIGHT AND LICENSE\r
\r
Copyright 2006 by Brian Cassidy\r
\r
This library is free software; you can redistribute it and/or modify\r
it under the same terms as Perl itself. \r
\r
=head1 SEE ALSO\r
\r
=over 4 \r
\r
=item * L<Catalyst>\r
\r
=item * L<Catalyst::Plugin::ConfigLoader>\r
\r
=back\r
\r
=cut\r
\r
1;