Initial import of Config::Any (refactored from Catalyst::Plugin::ConfigLoader), and...

[p5sagit/Config-Any.git] / lib / Config / Any / General.pm

package Config::Any::General;\r
\r
use strict;\r
use warnings;\r
\r
=head1 NAME\r
\r
Config::Any::General - Load Config::General files\r
\r
=head1 DESCRIPTION\r
\r
Loads Config::General files. Example:\r
\r
    name = TestApp\r
    <Component Controller::Foo>\r
        foo bar\r
    </Component>\r
    <Model Baz>\r
        qux xyzzy\r
    </Model>\r
\r
=head1 METHODS\r
\r
=head2 extensions( )\r
\r
return an array of valid extensions (C<cnf>, C<conf>).\r
\r
=cut\r
\r
sub extensions {\r
    return qw( cnf conf );\r
}\r
\r
=head2 load( $file )\r
\r
Attempts to load C<$file> via Config::General.\r
\r
=cut\r
\r
sub load {\r
    my $class = shift;\r
    my $file  = shift;\r
\r
    require Config::General;\r
    my $configfile = Config::General->new( $file );\r
    my $config     = { $configfile->getall };\r
    \r
    return $config;\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<Config::Any>\r
\r
=item * L<Config::General>\r
\r
=back\r
\r
=cut\r
\r
1;