summaryrefslogtreecommitdiff
path: root/FS/FS/sched_avail.pm
blob: bd6ff247ab7109b29bd99365498ee4540574a757 (plain)
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
package FS::sched_avail;
use base qw( FS::Record );

use strict;
#use FS::Record qw( qsearch qsearchs );

=head1 NAME

FS::sched_avail - Object methods for sched_avail records

=head1 SYNOPSIS

  use FS::sched_avail;

  $record = new FS::sched_avail \%hash;
  $record = new FS::sched_avail { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::sched_avail object represents an availability period/interval.
FS::sched_avail inherits from FS::Record.  The following fields are currently
supported:

=over 4

=item availnum

primary key

=item itemnum

itemnum

=item wday

wday

=item stime

stime

=item etime

etime

=item override_date

override_date


=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new period.  To add the period to the database, see L<"insert">.

Note that this stores the hash reference, not a distinct copy of the hash it
points to.  You can ask the object for a copy with the I<hash> method.

=cut

sub table { 'sched_avail'; }

=item insert

Adds this record to the database.  If there is an error, returns the error,
otherwise returns false.

=item delete

Delete this record from the database.

=item replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database.  If there is an error,
returns the error, otherwise returns false.

=item check

Checks all fields to make sure this is a valid period.  If there is
an error, returns the error, otherwise returns false.  Called by the insert
and replace methods.

=cut

sub check {
  my $self = shift;

  my $error = 
    $self->ut_numbern('availnum')
    || $self->ut_foreign_key('itemnum', 'sched_item', 'itemnum')
    || $self->ut_number('wday')
    || $self->ut_number('stime')
    || $self->ut_number('etime')
    || $self->ut_numbern('override_date')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=item stime_pretty

=item etime_pretty

=cut

sub stime_pretty { shift->_time_pretty('stime', @_); }
sub etime_pretty { shift->_time_pretty('etime', @_); }

sub _time_pretty {
  my( $self, $field ) = @_;

  pretty_time( $self->$field() );
}

#helper sub
sub pretty_time {
  my $t = shift;

  return 'Midnight' if $t == 0 || $t == 1440;
  return 'Noon'     if $t == 720;

  my $h = int( $t / 60 );
  my $m = $t % 60;

  my $ap = 'AM';
  if    ( $h == 0 || $h == 24 ) { $h = 12; }
  elsif ( $h == 12 )           { $ap = 'PM'; }
  elsif ( $h > 12 )            { $ap = 'PM'; $h -= 12; }

  sprintf('%02d:%02d'." $ap", $h, $m);

}

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::sched_item>, L<FS::Record>

=cut

1;