1MetaCPAN::Client::File(U3s)er Contributed Perl DocumentatMieotnaCPAN::Client::File(3)
2
3
4

NAME

6       MetaCPAN::Client::File - A File data object
7

VERSION

9       version 2.030000
10

DESCRIPTION

12       A MetaCPAN file entity object.
13

ATTRIBUTES

15   status
16       Returns a release status like "backpan", "cpan", or "latest".
17
18   date
19       An ISO8601 datetime string like "2016-11-19T12:41:46" indicating when
20       the file was uploaded.
21
22   author
23       The author's PAUSE id.
24
25   maturity
26       This will be either "release" or "developer".
27
28   directory
29       A boolean indicating whether or not the path represents a directory.
30
31   indexed
32       A boolean indicating whether or not the content is indexed.
33
34   documentation
35       The name of the module for which this file contains docs. This may be
36       "undef"
37
38   id
39       The file's internal MetaCPAN id.
40
41   authorized
42       A boolean indicating whether or not this file was part of an authorized
43       upload.
44
45   version
46       The distribution version that contains this file.
47
48   version_numified
49       The numified version of the distribution that contains the file.
50
51   release
52       The release that contains this file, which will be something like
53       "Moose-2.2004".
54
55   binary
56       A boolean indicating whether or not this file contains binary content.
57
58   name
59       The File's name, without any directory path included.
60
61   path
62       The file's path within the distribution archive, relative to the root
63       of the archive.
64
65   abstract
66       If the file contains POD with a "NAME" section, then this attribute
67       will include the abstract portion of the name.
68
69   deprecated
70       The deprecated field value for this file.
71
72   description
73       If the file contains POD with a "DESCRIPTION" section, then this
74       attribute will contain that description.
75
76   distribution
77       The name of the distribution that contains the file.
78
79   level
80       A 0-indexed indication of how many directories deep this file is,
81       relative to the archive root.
82
83   sloc
84       If the file contains code, this will contain the number of lines of
85       code in the file.
86
87   slop
88       If the file contains POD, this will contain the number of lines of POD
89       in the file.
90
91   mime
92       The file's mime type.
93
94   module
95       If the file contains module indexed by PAUSE, then this attribute
96       contains an arrayref of hashrefs, one for each module. The hashrefs
97       have the following keys:
98
99       •   name
100
101           The module name.
102
103       •   indexed
104
105           Whether or not the file is indexed by MetaCPAN.
106
107       •   authorized
108
109           Whether or not the module is part of an authorized upload.
110
111       •   version
112
113           The version of the module that this file contains.
114
115       •   version_numified
116
117           The numified version of the module that this file contains.
118
119       •   associated_pod
120
121           A path you can use with the "MetaCPAN::Client->file" method to get
122           the file that contains POD for this module. In most cases, that
123           will be the same file as that one that contains this "module" data.
124
125   pod_lines
126       An arrayref.
127
128   stat
129       A hashref containing "stat()" all information about the file. The keys
130       are:
131
132       •   mtime
133
134           The Unix epoch of the file's last modified time.
135
136       •   mode
137
138           The file's mode (as an integer, not an octal representation).
139
140       •   size
141
142           The file's size in bytes.
143
144   download_url
145       A URL for the distribution archive that contains this file.
146

METHODS

148   pod
149           my $pod = $module->pod(); # default = plain
150           my $pod = $module->pod($type);
151
152       Returns the POD content for the module/file.
153
154       Takes a type as argument.
155
156       Supported types: plain, html, x-pod, x-markdown.
157
158   source
159           my $source = $module->source();
160
161       Returns the source code for the file.
162
163   metacpan_url
164       Returns a link to the file source page on MetaCPAN.
165

AUTHORS

167       •   Sawyer X <xsawyerx@cpan.org>
168
169       •   Mickey Nasriachi <mickey@cpan.org>
170

172       This software is copyright (c) 2016 by Sawyer X.
173
174       This is free software; you can redistribute it and/or modify it under
175       the same terms as the Perl 5 programming language system itself.
176
177
178
179perl v5.36.0                      2022-08-22         MetaCPAN::Client::File(3)
Impressum