1Object::Signature::FileU(s3e)r Contributed Perl DocumentaOtbijoenct::Signature::File(3)
2
3
4

NAME

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

DESCRIPTION

10       Whereas the basic Object::Signature class provides for only a raw
11       cryptographic signature, Object::Signature::File extends the signature
12       method to add specialised information for objects that want some
13       control over how they are stored as files.
14
15       For example, some objects may want the cached object to have a matching
16       file extension (for example a gif image) so that web-accessible cache
17       path could be used in a web page.
18
19       The image would then be sent out to the browser with the correct mime
20       type.
21

METHODS

23   signature_ext
24       The "signature_ext" method indicates the preferable file extension for
25       the content of the object, if applicable.
26
27       If the method returns a string, it indicates the object should be
28       stored in a file with a specific extension.
29
30       If the method returns a null string, it indicates that the file should
31       be stored with no extension.
32
33       If the method return "undef" (the default value), it indicates no
34       preference for the extension of the file.
35
36   signature_name
37       This signature_name method is the least-useful part of this extended
38       API, and is rarely used. It is included mostly for completeness.
39
40       If the method returns a string, it indicates the name part of a file
41       name that the object should be stored in, if possible.
42
43       If the method return a null string, it explicitly indicates there is no
44       file name or a file name is not possible.
45
46       If the method returns "undef" (the default value), it indicates no
47       preference for the name of the file.
48

AUTHOR

50       Adam Kennedy <adamk@cpan.org>
51

53       Copyright 2004 - 2007 Adam Kennedy.
54
55       This program is free software; you can redistribute it and/or modify it
56       under the same terms as Perl itself.
57
58       The full text of the license can be found in the LICENSE file included
59       with this module.
60
61
62
63perl v5.36.0                      2023-01-20        Object::Signature::File(3)
Impressum