/usr/share/perl5/Rose/DB/Object/MakeMethods/Time.pm is in librose-db-object-perl 1:0.797-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 | package Rose::DB::Object::MakeMethods::Time;
use strict;
use Carp();
use Rose::Object::MakeMethods;
our @ISA = qw(Rose::Object::MakeMethods);
use Rose::DB::Object::Constants
qw(PRIVATE_PREFIX FLAG_DB_IS_PRIVATE STATE_IN_DB STATE_LOADING
STATE_SAVING MODIFIED_COLUMNS MODIFIED_NP_COLUMNS SET_COLUMNS);
use Rose::DB::Object::Util qw(column_value_formatted_key);
our $VERSION = '0.771';
sub interval
{
my($class, $name, $args) = @_;
my $key = $args->{'hash_key'} || $name;
my $interface = $args->{'interface'} || 'get_set';
my $column_name = $args->{'column'} ? $args->{'column'}->name : $name;
my $undef_overrides_default = $args->{'undef_overrides_default'} || 0;
my $formatted_key = column_value_formatted_key($key);
my $default = $args->{'default'};
my $eomm = $args->{'end_of_month_mode'};
my $mod_columns_key = ($args->{'column'} ? $args->{'column'}->nonpersistent : 0) ?
MODIFIED_NP_COLUMNS : MODIFIED_COLUMNS;
my %methods;
if($interface eq 'get_set')
{
$methods{$name} = sub
{
my $self = shift;
my $db = $self->db or die "Missing Rose::DB object attribute";
my $driver = $db->driver || 'unknown';
if(@_)
{
if(defined $_[0])
{
if($self->{STATE_LOADING()})
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = $_[0];
}
else
{
my $dt_duration = $db->parse_interval($_[0], $eomm);
Carp::croak $db->error unless(defined $dt_duration);
if(ref $dt_duration)
{
$self->{$key} = $dt_duration;
$self->{$formatted_key,$driver} = undef;
}
else
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = $dt_duration;
}
$self->{$mod_columns_key}{$column_name} = 1;
}
}
else
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = undef;
$self->{$mod_columns_key}{$column_name} = 1
unless($self->{STATE_LOADING()});
}
}
return unless(defined wantarray);
unless(!defined $default || defined $self->{$key} || defined $self->{$formatted_key,$driver} ||
($undef_overrides_default && ($self->{$mod_columns_key}{$column_name} ||
($self->{STATE_IN_DB()} && !($self->{SET_COLUMNS()}{$column_name} || $self->{$mod_columns_key}{$column_name})))))
{
my $dt_duration = $db->parse_interval($default, $eomm);
Carp::croak $db->error unless(defined $dt_duration);
if(ref $dt_duration)
{
$self->{$key} = $dt_duration;
$self->{$formatted_key,$driver} = undef;
}
else
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = $dt_duration;
}
$self->{$mod_columns_key}{$column_name} = 1
unless($self->{STATE_IN_DB()});
}
if($self->{STATE_SAVING()})
{
return ($self->{$key} || $self->{$formatted_key,$driver}) ?
($self->{$formatted_key,$driver} ||= $db->format_interval($self->{$key})) : undef;
}
return $self->{$key} ? $self->{$key} :
$self->{$formatted_key,$driver} ?
($self->{$key} = $db->parse_interval($self->{$formatted_key,$driver}, $eomm)) : undef;
};
}
elsif($interface eq 'get')
{
$methods{$name} = sub
{
my $self = shift;
my $db = $self->db or die "Missing Rose::DB object attribute";
my $driver = $db->driver || 'unknown';
unless(!defined $default || defined $self->{$key} || defined $self->{$formatted_key,$driver} ||
($undef_overrides_default && ($self->{$mod_columns_key}{$column_name} ||
($self->{STATE_IN_DB()} && !($self->{SET_COLUMNS()}{$column_name} || $self->{$mod_columns_key}{$column_name})))))
{
my $dt_duration = $db->parse_interval($default, $eomm);
Carp::croak $db->error unless(defined $dt_duration);
if(ref $dt_duration)
{
$self->{$key} = $dt_duration;
$self->{$formatted_key,$driver} = undef;
}
else
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = $dt_duration;
}
$self->{$mod_columns_key}{$column_name} = 1;
}
if($self->{STATE_SAVING()})
{
return ($self->{$key} || $self->{$formatted_key,$driver}) ?
($self->{$formatted_key,$driver} ||= $db->format_interval($self->{$key})) : undef;
}
return $self->{$key} ? $self->{$key} :
$self->{$formatted_key,$driver} ?
($self->{$key} = $db->parse_interval($self->{$formatted_key,$driver}, $eomm)) : undef;
};
}
elsif($interface eq 'set')
{
$methods{$name} = sub
{
my $self = shift;
my $db = $self->db or die "Missing Rose::DB object attribute";
my $driver = $db->driver || 'unknown';
Carp::croak "Missing argument in call to $name" unless(@_);
if(defined $_[0])
{
if($self->{STATE_LOADING()})
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = $_[0];
}
else
{
my $dt_duration = $db->parse_interval($_[0], $eomm);
Carp::croak $db->error unless(defined $dt_duration);
if(ref $dt_duration)
{
$self->{$key} = $dt_duration;
$self->{$formatted_key,$driver} = undef;
}
else
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = $dt_duration;
}
}
}
else
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = undef;
}
$self->{$mod_columns_key}{$column_name} = 1;
return unless(defined wantarray);
unless(!defined $default || defined $self->{$key} || defined $self->{$formatted_key,$driver} ||
($undef_overrides_default && ($self->{$mod_columns_key}{$column_name} ||
($self->{STATE_IN_DB()} && !($self->{SET_COLUMNS()}{$column_name} || $self->{$mod_columns_key}{$column_name})))))
{
my $dt_duration = $db->parse_interval($default, $eomm);
Carp::croak $db->error unless(defined $dt_duration);
if(ref $dt_duration)
{
$self->{$key} = $dt_duration;
$self->{$formatted_key,$driver} = undef;
}
else
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = $dt_duration;
}
}
if($self->{STATE_SAVING()})
{
return ($self->{$key} || $self->{$formatted_key,$driver}) ?
($self->{$formatted_key,$driver} ||= $db->format_interval($self->{$key})) : undef;
}
return $self->{$key} ? $self->{$key} :
$self->{$formatted_key,$driver} ?
($self->{$key} = $db->parse_interval($self->{$formatted_key,$driver}, $eomm)) : undef;
};
}
else { Carp::croak "Unknown interface: $interface" }
return \%methods;
}
sub time
{
my($class, $name, $args) = @_;
my $key = $args->{'hash_key'} || $name;
my $interface = $args->{'interface'} || 'get_set';
my $column_name = $args->{'column'} ? $args->{'column'}->name : $name;
my $undef_overrides_default = $args->{'undef_overrides_default'} || 0;
my $formatted_key = column_value_formatted_key($key);
my $default = $args->{'default'};
my $precision = $args->{'precision'};
my $mod_columns_key = ($args->{'column'} ? $args->{'column'}->nonpersistent : 0) ?
MODIFIED_NP_COLUMNS : MODIFIED_COLUMNS;
my %methods;
if($interface eq 'get_set')
{
$methods{$name} = sub
{
my $self = shift;
my $db = $self->db or die "Missing Rose::DB object attribute";
my $driver = $db->driver || 'unknown';
if(@_)
{
if(defined $_[0])
{
if($self->{STATE_LOADING()})
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = $_[0];
}
else
{
my $time = $db->parse_time($_[0]);
Carp::croak $db->error unless(defined $time);
if(ref $time)
{
$self->{$key} = $time;
$self->{$formatted_key,$driver} = undef;
}
else
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = $time;
}
$self->{$mod_columns_key}{$column_name} = 1;
}
}
else
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = undef;
$self->{$mod_columns_key}{$column_name} = 1
unless($self->{STATE_LOADING()});
}
}
return unless(defined wantarray);
unless(!defined $default || defined $self->{$key} || defined $self->{$formatted_key,$driver} ||
($undef_overrides_default && ($self->{$mod_columns_key}{$column_name} ||
($self->{STATE_IN_DB()} && !($self->{SET_COLUMNS()}{$column_name} || $self->{$mod_columns_key}{$column_name})))))
{
my $time = $db->parse_time($default);
Carp::croak $db->error unless(defined $time);
if(ref $time)
{
$self->{$key} = $time;
$self->{$formatted_key,$driver} = undef;
}
else
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = $time;
}
$self->{$mod_columns_key}{$column_name} = 1
unless($self->{STATE_IN_DB()});
}
if($self->{STATE_SAVING()})
{
return ($self->{$key} || $self->{$formatted_key,$driver}) ?
($self->{$formatted_key,$driver} ||= $db->format_time($self->{$key}, $precision)) : undef;
}
return $self->{$key} ? $self->{$key} :
$self->{$formatted_key,$driver} ?
($self->{$key} = $db->parse_time($self->{$formatted_key,$driver})) : undef;
};
}
elsif($interface eq 'get')
{
$methods{$name} = sub
{
my $self = shift;
my $db = $self->db or die "Missing Rose::DB object attribute";
my $driver = $db->driver || 'unknown';
unless(!defined $default || defined $self->{$key} || defined $self->{$formatted_key,$driver} ||
($undef_overrides_default && ($self->{$mod_columns_key}{$column_name} ||
($self->{STATE_IN_DB()} && !($self->{SET_COLUMNS()}{$column_name} || $self->{$mod_columns_key}{$column_name})))))
{
my $time = $db->parse_time($default);
Carp::croak $db->error unless(defined $time);
if(ref $time)
{
$self->{$key} = $time;
$self->{$formatted_key,$driver} = undef;
}
else
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = $time;
}
$self->{$mod_columns_key}{$column_name} = 1;
}
if($self->{STATE_SAVING()})
{
return ($self->{$key} || $self->{$formatted_key,$driver}) ?
($self->{$formatted_key,$driver} ||= $db->format_time($self->{$key}, $precision)) : undef;
}
return $self->{$key} ? $self->{$key} :
$self->{$formatted_key,$driver} ?
($self->{$key} = $db->parse_time($self->{$formatted_key,$driver})) : undef;
};
}
elsif($interface eq 'set')
{
$methods{$name} = sub
{
my $self = shift;
my $db = $self->db or die "Missing Rose::DB object attribute";
my $driver = $db->driver || 'unknown';
Carp::croak "Missing argument in call to $name" unless(@_);
if(defined $_[0])
{
if($self->{STATE_LOADING()})
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = $_[0];
}
else
{
my $time = $db->parse_time($_[0]);
Carp::croak $db->error unless(defined $time);
if(ref $time)
{
$self->{$key} = $time;
$self->{$formatted_key,$driver} = undef;
}
else
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = $time;
}
}
}
else
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = undef;
}
$self->{$mod_columns_key}{$column_name} = 1;
return unless(defined wantarray);
unless(!defined $default || defined $self->{$key} || defined $self->{$formatted_key,$driver} ||
($undef_overrides_default && ($self->{$mod_columns_key}{$column_name} ||
($self->{STATE_IN_DB()} && !($self->{SET_COLUMNS()}{$column_name} || $self->{$mod_columns_key}{$column_name})))))
{
my $time = $db->parse_time($default);
Carp::croak $db->error unless(defined $time);
if(ref $time)
{
$self->{$key} = $time;
$self->{$formatted_key,$driver} = undef;
}
else
{
$self->{$key} = undef;
$self->{$formatted_key,$driver} = $time;
}
}
if($self->{STATE_SAVING()})
{
return ($self->{$key} || $self->{$formatted_key,$driver}) ?
($self->{$formatted_key,$driver} ||= $db->format_time($self->{$key}, $precision)) : undef;
}
return $self->{$key} ? $self->{$key} :
$self->{$formatted_key,$driver} ?
($self->{$key} = $db->parse_time($self->{$formatted_key,$driver})) : undef;
};
}
else { Carp::croak "Unknown interface: $interface" }
return \%methods;
}
1;
__END__
=head1 NAME
Rose::DB::Object::MakeMethods::Time - Create time-related methods for Rose::DB::Object-derived objects.
=head1 SYNOPSIS
package MyDBObject;
use base 'Rose::DB::Object';
use Rose::DB::Object::MakeMethods::Time
(
interval =>
[
t1 => { scale => 6 },
t2 => { default => '3 days 6 minutes 5 seconds' },
],
time =>
[
start => { scale => 5 },
end => { default => '12:34:56' },
],
);
...
$o->t1('5 minutes 0.003 seconds');
$dt_dur = $o->t1; # DateTime::Duration object
print $o->t1->minutes; # 5
print $o->t1->nanosecond; # 3000000
$o->start('12:34:56.12345');
print $o->start->nanosecond; # 123450000
print $o->start->as_string; # 12:34:56.12345
$o->end('6pm');
$tc = $o->end; # Time::Clock object
print $o->end->hour; # 18
print $o->end->ampm; # PM
print $o->end->format('%I:%M %p'); # 6:00 PM
$o->end->add(hours => 1);
print $o->end->format('%I:%M %p'); # 7:00 PM
=head1 DESCRIPTION
C<Rose::DB::Object::MakeMethods::Time> creates methods that deal with times, and inherits from L<Rose::Object::MakeMethods>. See the L<Rose::Object::MakeMethods> documentation to learn about the interface. The method types provided by this module are described below.
All method types defined by this module are designed to work with objects that are subclasses of (or otherwise conform to the interface of) L<Rose::DB::Object>. In particular, the object is expected to have a L<db|Rose::DB::Object/db> method that returns a L<Rose::DB>-derived object. See the L<Rose::DB::Object> documentation for more details.
=head1 METHODS TYPES
=over 4
=item B<interval>
Create get/set methods for interval (years, months, days, hours, minutes, seconds) attributes.
=over 4
=item Options
=over 4
=item C<default>
Determines the default value of the attribute.
=item C<end_of_month_mode>
This mode determines how math is done on duration objects. If defined, the C<end_of_month> setting for each L<DateTime::Duration> object created by this method will be set to the specified mode. Otherwise, the C<end_of_month> parameter will not be passed to the L<DateTime::Duration> constructor.
Valid modes are C<wrap>, C<limit>, and C<preserve>. See the documentation for L<DateTime::Duration> for a full explanation.
=item C<hash_key>
The key inside the hash-based object to use for the storage of this
attribute. Defaults to the name of the method.
=item C<interface>
Choose the interface. The default is C<get_set>.
=item C<scale>
An integer number of places past the decimal point preserved for fractional seconds. Defaults to 0.
=back
=item Interfaces
=over 4
=item C<get_set>
Creates a get/set method for a interval (years, months, days, hours, minutes, seconds) attribute. When setting the attribute, the value is passed through the L<parse_interval|Rose::DB/parse_interval> method of the object's L<db|Rose::DB::Object/db> attribute. If that fails, a fatal error will occur.
When saving to the database, the method will pass the attribute value through the L<format_interval|Rose::DB/format_interval> method of the object's L<db|Rose::DB::Object/db> attribute before returning it.
This method is designed to allow interval values to make a round trip from and back into the database without ever being "inflated" into L<DateTime::Duration> objects. Any use of the attribute (get or set) outside the context of loading from or saving to the database will cause the value to be "inflated" using the L<parse_interval|Rose::DB/parse_interval> method of the object's L<db|Rose::DB::Object/db> attribute.
=item C<get>
Creates an accessor method for a interval (years, months, days, hours, minutes, seconds) attribute. This method behaves like the C<get_set> method, except that the value cannot be set.
=item C<set>
Creates a mutator method for a interval (years, months, days, hours, minutes, seconds) attribute. This method behaves like the C<get_set> method, except that a fatal error will occur if no arguments are passed.
=back
=back
Example:
package MyDBObject;
use base 'Rose::DB::Object';
use Rose::DB::Object::MakeMethods::Time
(
time =>
[
't1' => { scale => 6 },
't2' => { default => '3 days 6 minutes 5 seconds' },
],
);
...
$o->t1('5 minutes 0.003 seconds');
$dt_dur = $o->t1; # DateTime::Duration object
print $o->t1->minutes; # 5
print $o->t1->nanosecond; # 3000000
=item B<time>
Create get/set methods for time (hours, minutes, seconds) attributes. Fractional seconds up to nanosecond precision are supported.
=over 4
=item Options
=over 4
=item C<default>
Determines the default value of the attribute.
=item C<hash_key>
The key inside the hash-based object to use for the storage of this
attribute. Defaults to the name of the method.
=item C<interface>
Choose the interface. The default is C<get_set>.
=item C<scale>
An integer number of places past the decimal point preserved for fractional seconds. Defaults to 0. The maximum value is 9.
=back
=item Interfaces
=over 4
=item C<get_set>
Creates a get/set method for a time attribute. When setting the attribute, the value is passed through the L<parse_time|Rose::DB/parse_time> method of the object's L<db|Rose::DB::Object/db> attribute. If that fails, a fatal error will occur.
When saving to the database, the method will pass the attribute value through the L<format_time|Rose::DB/format_time> method of the object's L<db|Rose::DB::Object/db> attribute before returning it.
This method is designed to allow time values to make a round trip from and back into the database without ever being "inflated" into L<Time::Clock> objects. Any use of the attribute (get or set) outside the context of loading from or saving to the database will cause the value to be "inflated" using the L<parse_time|Rose::DB/parse_time> method of the object's L<db|Rose::DB::Object/db> attribute.
=item C<get>
Creates an accessor method for a time attribute. This method behaves like the C<get_set> method, except that the value cannot be set.
=item C<set>
Creates a mutator method for a time attribute. This method behaves like the C<get_set> method, except that a fatal error will occur if no arguments are passed.
=back
=back
Example:
package MyDBObject;
use base 'Rose::DB::Object';
use Rose::DB::Object::MakeMethods::Time
(
time =>
[
start => { scale => 5 },
end => { default => '12:34:56' },
],
);
...
$o->start('12:34:56.12345');
print $o->start->nanosecond; # 123450000
print $o->start->as_string; # 12:34:56.12345
$o->end('6pm');
$tc = $o->end; # Time::Clock object
print $o->end->hour; # 18
print $o->end->ampm; # PM
print $o->end->format('%I:%M %p'); # 6:00 PM
$o->end->add(hours => 1);
print $o->end->format('%I:%M %p'); # 7:00 PM
=back
=head1 AUTHOR
John C. Siracusa (siracusa@gmail.com)
=head1 LICENSE
Copyright (c) 2010 by John C. Siracusa. All rights reserved. This program is
free software; you can redistribute it and/or modify it under the same terms
as Perl itself.
|