internal package Foswiki::Store::VC::Store

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

Child packagesChild packages

internal package Foswiki::Store::VC::Store is a Foswiki::Store

Almost-complete implementation of Foswiki::Store. The methods of this class implement the Foswiki::Store interface.

The store uses a "handler" class to handle all interactions with the actual version control system (and via it with the actual file system). A "handler" is created for each individual file in the file system, and this handler then brokers all requests to open, read, write etc the file. The handler object must implement the interface specified by Foswiki::Store::VC::Handler.

The main additional responsibilities of this class are to support storing Foswiki meta-data in plain text files, and to ensure that the Foswiki::Meta for a page is maintained in synchronisation with the files on disk.

All that is required to create a working store is to subclass this class and override the 'new' method to specify the actual handler to use. See Foswiki::Store::RcsWrap for an example subclass.

For readers who are familiar with Foswiki version 1.0, the functionality in this class previously resided in Foswiki::Store.

These methods are documented in the Foswiki:Store abstract base class