Nilson Santos Figueiredo Júnior > Catalyst-Plugin-ConfigurablePathTo-0.01 > Catalyst::Plugin::ConfigurablePathTo

Download:
Catalyst-Plugin-ConfigurablePathTo-0.01.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.01   Source  

NAME ^

Catalyst::Plugin::ConfigurablePathTo - Provides a configurable path_to()

VERSION ^

Version 0.01

SYNOPSIS ^

This plugin provides a way to have generic configurable paths in Catalyst.

  # in myapp.yml
  
  path_to:
  
    profiles: /usr/local/profiles
  
    tempfiles: /tmp/myapp_tempfiles
  
    ...

  # in some Catalyst controller
  
    # 'profiles' is defined in the config file, so you'll
    # get '/usr/local/profiles' back
    my $profiles_path = $c->path_to('profiles');

    # it also correctly creates the paths, using Path::Class
    # you'll get '/tmp/myapp_tempfiles/file.tmp' back
    my $temp_path = $c->path_to('tempfiles', 'file.tmp');

    # performs as the original path_to() would if it's not defined
    # in the config file
    my #other_path = $c->path_to('other');

METHODS ^

$c->path_to( @path )

If $path[0] represents an already configured path in the application config file, $path[0] is replaced with the configured path and @path is merged into a Path::Class object.

Otherwise, @path is merged with $c->config->{home} into a Path::Class object.

AUTHOR ^

Nilson Santos Figueiredo Júnior, <nilsonsfj at cpan.org>

BUGS ^

Please report any bugs or feature requests directly to the author. If you ask nicely it will probably get fixed or implemented.

SUPPORT ^

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

    perldoc Catalyst::Plugin::ConfigurablePathTo

You can also look for information at:

ACKNOWLEDGEMENTS ^

COPYRIGHT & LICENSE ^

Copyright 2006 Nilson Santos Figueiredo Junior, all rights reserved.

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

syntax highlighting: