The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Apache::AxKit::Provider::FileWrite - File provider class with write support

SYNOPSIS

Override the base ContentProvider class and enable it using:

    AxContentProvider Apache::AxKit::Provider::FileWrite
    

Using this with the StyleProvider directive is not very useful at the moment. This might change depending on processor features.

DESCRIPTION

Warning: This is experimental. It was included for testing purposes. The API might change, or the module might be removed again.

This provider provides the bare minimum of write access. Use this like any other provider.

This class supports the following additional interfaces:

  • $provider->get_fh(1)

    Get a file handle for writing. The old contents of that file are erased, if any. $provider->get_fh() or an explicit $provider->get_fh(0) work like before. Directories are not currently supported.

  • $provider->remove()

    Remove the file from the filesystem.

  • $provider->set_strref(\$text)

    Store a string in the file, the opposite of $provider->get_strref().

This is the minimum set of operations to manage files. If you need locking, you have to implement that yourself. Metadata can be queried through the AxHandleDirs extension, but cannot yet be set. are no provisions for locking or metadata - you have to do that yourself. These primitives are abstract enough to apply to other sources as well, for example a XML database. If you implement other providers with write support, please stick to this API.

AUTHOR

Jörg Walter <jwalt@cpan.org>

SEE ALSO

AxKit, Apache::AxKit::Provider

1 POD Error

The following errors were encountered while parsing the POD:

Around line 114:

Non-ASCII character seen before =encoding in 'Jörg'. Assuming CP1252