load¶

Given a "file", load it. "file" must contain a valid phrase map.

   my $file = 'english.txt';
   $loader->load( $file );

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

To utilise the dictionary framework for a Plain Text phrasebook, the idea is to use a directory of files, where the directory is passed via the "file" argument and the dictionary, the specific name of the file, is passed via the "dictionary" argument.

   my $file = '/tmp/phrasebooks';
   my $dictionary = 'english.txt';
   $loader->load( $file, $dictionary );

get¶

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

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

dicts¶

Having instantiated the "Data::Phrasebook" object class, and using the "file" attribute as a directory path, the object can return a list of the current dictionaries available as:

  my $pb = Data::Phrasebook->new(
    loader => 'Text',
    file   => '/tmp/phrasebooks',
  );
  my @dicts = $pb->dicts;

or

  my @dicts = $pb->dicts( $path );

keywords¶

Having instantiated the "Data::Phrasebook" object class, using the "file" and "dict" attributes as required, the object can return a list of the current keywords available as:

  my $pb = Data::Phrasebook->new(
    loader => 'Text',
    file   => '/tmp/phrasebooks',
    dict   => 'TEST',
  );
  my @keywords = $pb->keywords;

or

  my @keywords = $pb->keywords( $path, $dict );

Note that $path can either be the directory path, where $dict must be the specific file name of the dictionary, or the full path of the dictionary file.

In the second instance, the function will not load a dictionary, but can be used to interrogate the contents of a known dictionary.