-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
254 lines (181 loc) · 6.32 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
NAME
Random::Day - Class for random day generation.
SYNOPSIS
use Random::Day;
my $obj = Random::Day->new(%params);
my $dt = $obj->get;
my $dt = $obj->random;
my $dt = $obj->random_day($day);
my $dt = $obj->random_day_month($day, $month);
my $dt = $obj->random_day_month_year($day, $month, $year);
my $dt = $obj->random_day_year($day, $year);
my $dt = $obj->random_month($month);
my $dt = $obj->random_month_year($month, $year);
my $dt = $obj->random_year($year);
METHODS
"new"
my $obj = Random::Day->new(%params);
Constructor.
* "day"
Day.
Default value is undef.
* "dt_from"
DateTime object from.
Default value is DateTime object for 1900 year.
* "dt_to"
DateTime object to.
Default value is DateTime object for 2050 year.
* "month"
Month.
Default value is undef.
* "year"
Year.
Default value is undef.
Returns instance of object.
"get"
my $dt = $obj->get;
Get random date defined by constructor parameters.
Returns DateTime object for date.
"random"
my $dt = $obj->random;
Get random date.
Returns DateTime object for date.
"random_day"
my $dt = $obj->random_day($day);
Get random date defined by day.
Returns DateTime object for date.
"random_day_month"
my $dt = $obj->random_day_month($day, $month);
Get random date defined by day and month.
Returns DateTime object for date.
"random_day_year"
my $dt = $obj->random_day_year($day, $year);
Get random date defined by day and year.
Returns DateTime object for date.
"random_day_month_year"
my $dt = $obj->random_day_month_year($day, $month, $year);
Get random date defined by day, month and year.
Returns DateTime object for date.
"random_month"
my $dt = $obj->random_month($month);
Get random date defined by month.
Returns DateTime object for date.
"random_month_year"
my $dt = $obj->random_month_year($month, $year);
Get random date defined by month and year.
Returns DateTime object for date.
"random_year"
my $dt = $obj->random_year($year);
Get random date defined by year.
Returns DateTime object for date.
ERRORS
new():
From Class::Utils::set_params():
Unknown parameter '%s'.
From Mo::utils::check_isa():
Parameter 'dt_from' must be a 'DateTime' object.
Value: %s
Reference: %s
Parameter 'dt_to' must be a 'DateTime' object.
Value: %s
Reference: %s
Parameter 'dt_from' must have older or same date than 'dt_to'.
Date from: %s
Date to: %s
random_day():
Day cannot be a zero.
Day isn't positive number.
random_day_month():
Cannot create DateTime object.
Day cannot be a zero.
Day isn't positive number.
random_day_month_year():
Begin of expected month is lesser than minimal date.
Expected year: %s
Expected month: %s
Expected day: %s
Minimal year: %s
Minimal month: %s
Minimal day: %s
Cannot create DateTime object.
Error: %s
Day cannot be a zero.
Day isn't positive number.
End of expected month is greater than maximal date.
Expected year: %s
Expected month: %s
Expected day: %s
Maximal year: %s
Maximal month: %s
Maximal day: %s
random_day_year():
Day cannot be a zero.
Day is greater than maximal possible date.
Day is greater than possible day.
Day: %s
Day is lesser than minimal possible date.
Day isn't positive number.
Day not fit between start and end dates.
Year is lesser than minimal year.
Expected year: %s
Minimal year: %s
Year is greater than maximal year.
Expected year: %s
Maximal year: %s
random_month():
Cannot create DateTime object.
Error: %s
random_month_year():
Begin of expected month is lesser than minimal date.
Expected year: %s
Expected month: %s
Minimal year: %s
Minimal month: %s
Cannot create DateTime object.
Error: %s
End of expected month is greater than maximal date.
Expected year: %s
Expected month: %s
Maximal year: %s
Maximal month: %s
random_year():
Year is greater than maximal year.
Expected year: %s
Maximal year: %s
Year is lesser than minimal year.
Expected year: %s
Minimal year: %s
EXAMPLE
use strict;
use warnings;
use Random::Day;
# Object.
my $obj = Random::Day->new;
# Get date.
my $dt = $obj->get;
# Print out.
print $dt->ymd."\n";
# Output like:
# \d\d\d\d-\d\d-\d\d
DEPENDENCIES
Class::Utils, DateTime, DateTime::Event::Random,
DateTime::Event::Recurrence, English, Error::Pure, Mo::utils.
SEE ALSO
Data::Random
Perl module to generate random data
DateTime::Event::Random
DateTime extension for creating random datetimes.
Random::Day::InTheFuture
Class for random day generation in the future.
Random::Day::InThePast
Class for random day generation in the past.
REPOSITORY
<https://github.com/michal-josef-spacek/Random-Day>
AUTHOR
Michal Josef Špaček <mailto:skim@cpan.org>
<http://skim.cz>
LICENSE AND COPYRIGHT
© 2013-2024 Michal Josef Špaček
BSD 2-Clause License
VERSION
0.17