Emmanuel Rodriguez > Xacobeo-0.15 > Xacobeo::Conf

Download:
Xacobeo-0.15.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Source  

NAME ^

Xacobeo::Conf - Application's configuration.

SYNOPSIS ^

        use Xacobeo::Conf;
        
        my $conf = Xacobeo::Conf->get_conf;
        
        my $icon = $conf->share_file('images', 'xacobeo.png'); # /usr/share/images/xacobeo.png
        my $po_folder = $conf->share_folder('locale');         # /usr/share/locale

DESCRIPTION ^

Utility class that provides a way for accessing all configuration parameters that are needed at runtime..

PROPERTIES ^

The following properties are defined:

dir

The root directory where the application has been installed.

METHODS ^

The following methods are available:

get_conf

Returns the current configuration instance. This class is a singleton so there's no constructor.

share_dir

Returns the path of a folder in the application's share directory.

Parameters:

share_file

Returns the path of a file in the application's share directory.

Parameters:

app_name

Returns the application's name.

plugin_folders

Returns the folders that are scanned for plugins.

AUTHORS ^

Emmanuel Rodriguez <potyl@cpan.org>.

COPYRIGHT AND LICENSE ^

Copyright (C) 2008,2009 by Emmanuel Rodriguez.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: