Statocles::Store - A repository for Documents and Pages
version 0.028
A Statocles::Store reads and writes documents and files (mostly pages).
This class handles the parsing and inflating of "document objects".
Documents are formatted with a YAML document on top, and Markdown content on the bottom, like so:
--- title: This is a title author: preaction --- # This is the markdown content This is a paragraph
The path to the directory containing the documents.
All the documents currently read by this store.
Clear the cached documents in this Store.
Read the directory path and create the document objects inside.
path
Read a single document in either pure YAML or combined YAML/Markdown (Frontmatter) format and return a datastructure suitable to be given to Statocles::Document.
Write a document to the store. Returns the full path to the newly-updated document.
The document is written in Frontmatter format.
Read the file from the given path.
Returns true if a file exists with the given path.
NOTE: This should not be used to check for directories, as not all stores have directories.
Write the given content to the given path. This is mostly used to write out page objects.
content
Doug Bell <preaction@cpan.org>
This software is copyright (c) 2014 by Doug Bell.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Statocles, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Statocles
CPAN shell
perl -MCPAN -e shell install Statocles
For more information on module installation, please visit the detailed CPAN module installation guide.