Adam Kennedy > Object-Signature > Object::Signature::File

Download:
Object-Signature-1.07.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 1.07   Source  

NAME ^

Object::Signature::File - Extended signature API for storing objects in file

DESCRIPTION ^

Whereas the basic Object::Signature class provides for only a raw cryptographic signature, Object::Signature::File extends the signature method to add specialised information for objects that want some control over how they are stored as files.

For example, some objects may want the cached object to have a matching file extension (for example a gif image) so that web-accessible cache path could be used in a web page.

The image would then be sent out to the browser with the correct mime type.

METHODS ^

signature_ext

The signature_ext method indicates the preferable file extension for the content of the object, if applicable.

If the method returns a string, it indicates the object should be stored in a file with a specific extension.

If the method returns a null string, it indicates that the file should be stored with no extension.

If the method return undef (the default value), it indicates no preference for the extention the file.

signature_name

This signature_name method is the least-useful part of this extended API, and is rarely used. It is included mostly for completeness.

If the method returns a string, it indicates the name part of a file name that the object should be stored in, if possible.

If the method return a null string, it explicitly indicates there is no file name or a file name is not possible.

If the method returns undef (the default value), it indicates no preference for the name of the file.

AUTHOR ^

Adam Kennedy <adamk@cpan.org>

COPYRIGHT ^

Copyright 2004 - 2007 Adam Kennedy.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

syntax highlighting: