dtRdr::Library::YAMLLibrary - a library in yaml


dotReader documentation  | view source Contained in the dotReader distribution.

Index


NAME

Top

dtRdr::Library::YAMLLibrary - a library in yaml

SYNOPSIS

Top

Initializer

Top

create

  dtRdr::Library::YAMLLibrary->create($file);

Constructor

Top

new

  my $library = dtRdr::Library::YAMLLibrary->new();

Methods

Top

load_uri

  $library->load_uri($uri);

_dumpload

Ensure that the on-disk and in-memory data are in sync.

  $self->_dumpload;

_dump

  $self->_dump;

_load

  $self->_load;

_setup_info

  $self->_setup_info;

set_id

Allows you to set the library id iff the current value is '_setme_'.

  $lib->set_id($id);

set_name

Change the library name.

  $lib->set_name($name);

set_storage

Set the library's storage location (relative to the library location.) This ends up as the $lib->directory property.

  $lib->set_storage($storage);

add_book

Returns the unique id of the new entry.

  $id = $library->add_book(
    book_id => $id,
    title   => $title,
    uri     => $uri,
    type    => $type
  );

get_info

  my $value = $library->get_info($key);

set_info

  $library->set_info($key, $value);

find_book_by

  $info = $lib->find_book_by($key, $value);

book_data

  $self->book_data;

AUTHOR

Top

Eric Wilhelm <ewilhelm at cpan dot org>

http://scratchcomputing.com/

COPYRIGHT

Top

NO WARRANTY

Top

Absolutely, positively NO WARRANTY, neither express or implied, is offered with this software. You use this software at your own risk. In case of loss, no person or entity owes you anything whatsoever. You have been warned.

LICENSE

Top

The dotReader(TM) is OSI Certified Open Source Software licensed under the GNU General Public License (GPL) Version 2, June 1991. Non-encrypted and encrypted packages are usable in connection with the dotReader(TM). The ability to create, edit, or otherwise modify content of such encrypted packages is self-contained within the packages, and NOT provided by the dotReader(TM), and is addressed in a separate commercial license.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


dotReader documentation  | view source Contained in the dotReader distribution.