Barbie > Data-Phrasebook-Loader-Ini-0.13 > Data::Phrasebook::Loader::Ini

Download:
Data-Phrasebook-Loader-Ini-0.13.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.13   Source   Latest Release: Data-Phrasebook-Loader-Ini-0.14

NAME ^

Data::Phrasebook::Loader::Ini - Absract your phrases with ini files.

SYNOPSIS ^

    use Data::Phrasebook;

    my $q = Data::Phrasebook->new(
        class  => 'Fnerk',
        loader => 'Ini',
        file   => 'phrases.ini',
    );

    # simple keyword to phrase mapping
    my $phrase = $q->fetch($keyword);

    # keyword to phrase mapping with parameters
    $q->delimiters( qr{ \[% \s* (\w+) \s* %\] }x );
    my $phrase = $q->fetch($keyword,{this => 'that'});

ABSTRACT ^

This module provides a loader class for phrasebook implementations using INI files.

DESCRIPTION ^

This module provides a base class for phrasebook implementations.

Phrases can be contained within one or more dictionaries, with each phrase accessible via a unique key. Phrases may contain placeholders, please see Data::Phrasebook for an explanation of how to use these. Groups of phrases are kept in a dictionary. In this implementation a dictionary is considered to be equivilent to a section in an ini file.

An example ini file:

  [BASE]
  foo=\
    Welcome to :my world. \
    It is a nice :place.

Within the phrase text placeholders can be used, which are then replaced with the appropriate values once the get() method is called. The default style of placeholders can be altered using the delimiters() method.

INHERITANCE ^

Data::Phrasebook::Loader::Ini inherits from the base class Data::Phrasebook::Loader::Base. See that module for other available methods and documentation.

METHODS ^

load

Given a file, load it. file must contain a INI style layout.

   $loader->load( $file, $dict );

This method is used internally by Data::Phrasebook::Generic's data method, to initialise the data store.

It must take a file (be it a scalar, or something more complex) and return a handle.

get

Returns the phrase stored in the phrasebook, for a given keyword.

   my $value = $loader->get( $key );

dicts

Returns the list of dictionaries available.

   my @dicts = $loader->dicts();

keywords

Returns the list of keywords available. List is lexically sorted.

   my @dicts = $loader->keywords();

CONTINUATION LINES ^

As this module uses Config::IniFiles, it allows for the use of continuation lines as follows:

  [Section]
  Parameter=this parameter \
    spreads across \
    a few lines

SEE ALSO ^

Data::Phrasebook, Config::IniFiles.

BUGS, PATCHES & FIXES ^

There are no known bugs at the time of this release. However, if you spot a bug or are experiencing difficulties, that is not explained within the POD documentation, please send an email to barbie@cpan.org or submit a bug to the RT system (http://rt.cpan.org/). However, it would help greatly if you are able to pinpoint problems or even supply a patch.

Fixes are dependent upon their severity and my availability. Should a fix not be forthcoming, please feel free to (politely) remind me.

AUTHOR ^

  Barbie, <barbie@cpan.org>
  for Miss Barbell Productions <http://www.missbarbell.co.uk>.

COPYRIGHT AND LICENSE ^

  Copyright (C) 2004-2013 Barbie for Miss Barbell Productions.

  This distribution is free software; you can redistribute it and/or
  modify it under the Artistic License 2.0.
syntax highlighting: