Zim::Store::Files.3pm

Langue: en

Autres versions - même langue

Version: 2009-02-23 (debian - 07/07/09)

Section: 3 (Bibliothèques de fonctions)

NAME

Zim::Store::Files - A file system based store

DESCRIPTION

This module implements a file system based store for zim. See Zim::Store for the interface documentation.

METHODS

"new(PARENT, NAMESPACE, DIR)"
Simple constructor. DIR is the root directory of the store. NAMESPACE is the namespace that maps to that directory.
"get_page(PAGE_NAME)"
Returns an object of the type Zim::Page.
"resolve_case(\@LINK, \@PAGE)"
See Zim::Store.
"copy_page(SOURCE, TARGET, UPDATE_LINKS)"
"move_page(SOURCE, TARGET)"
"delete_page(PAGE)"
"search()"
TODO

Private methods

"page2file(PAGE, NOCASE)"
Returns a File object for a page name.

NOCASE is a boolean that triggers a case in-sensitive lookup when true.

"page2dir(PAGE, NOCASE)"
Returns the dir that maps to the namespace below this page.

NOCASE is a boolean that triggers a case in-sensitive lookup when true.

"file2page(FILE)"
Returns the page name corresponding to FILE. FILE does not actually need to exist and can be a directory as well as a file.

BUGS

Please mail the author if you find any bugs.

AUTHOR

Jaap Karssenberg || Pardus [Larus] <pardus@cpan.org>

Copyright (c) 2005 Jaap G Karssenberg. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

Zim, Zim::Store::Cached, Zim::Page