Passed
Push — master ( 08536e...5223e1 )
by tsms
02:22
created

Calendar_Hour::Calendar_Hour()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 1
dl 0
loc 3
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 4
1
<?php
2
/* vim: set expandtab tabstop=4 shiftwidth=4: */
3
4
/**
5
 * Contains the Calendar_Hour class
6
 *
7
 * PHP versions 4 and 5
8
 *
9
 * LICENSE: Redistribution and use in source and binary forms, with or without
10
 * modification, are permitted provided that the following conditions are met:
11
 * 1. Redistributions of source code must retain the above copyright
12
 *    notice, this list of conditions and the following disclaimer.
13
 * 2. Redistributions in binary form must reproduce the above copyright
14
 *    notice, this list of conditions and the following disclaimer in the
15
 *    documentation and/or other materials provided with the distribution.
16
 * 3. The name of the author may not be used to endorse or promote products
17
 *    derived from this software without specific prior written permission.
18
 *
19
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
20
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22
 * IN NO EVENT SHALL THE FREEBSD PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY
23
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
 *
30
 * @category  Date and Time
31
 * @package   Calendar
32
 * @author    Harry Fuecks <[email protected]>
33
 * @copyright 2003-2007 Harry Fuecks
34
 * @license   http://www.debian.org/misc/bsd.license  BSD License (3 Clause)
35
 * @version   CVS: $Id$
36
 * @link      http://pear.php.net/package/Calendar
37
 */
38
39
/**
40
 * Allows Calendar include path to be redefined
41
 * @ignore
42
 */
43
if (!defined('CALENDAR_ROOT')) {
44
    define('CALENDAR_ROOT', 'Calendar'.DIRECTORY_SEPARATOR);
45
}
46
47
/**
48
 * Load Calendar base class
49
 */
50
require_once CALENDAR_ROOT.'Calendar.php';
51
52
/**
53
 * Represents an Hour and builds Minutes
54
 * <code>
55
 * require_once 'Calendar'.DIRECTORY_SEPARATOR.'Hour.php';
56
 * $Hour = new Calendar_Hour(2003, 10, 21, 15); // Oct 21st 2003, 3pm
57
 * $Hour->build(); // Build Calendar_Minute objects
58
 * while ($Minute = & $Hour->fetch()) {
59
 *     echo $Minute->thisMinute().'<br />';
60
 * }
61
 * </code>
62
 *
63
 * @category  Date and Time
64
 * @package   Calendar
65
 * @author    Harry Fuecks <[email protected]>
66
 * @copyright 2003-2007 Harry Fuecks
67
 * @license   http://www.debian.org/misc/bsd.license  BSD License (3 Clause)
68
 * @link      http://pear.php.net/package/Calendar
69
 * @access    public
70
 */
71
class Calendar_Hour extends Calendar
72
{
73
    /**
74
     * Constructs Calendar_Hour
75
     *
76
     * @param int $y year e.g. 2003
77
     * @param int $m month e.g. 5
78
     * @param int $d day e.g. 11
79
     * @param int $h hour e.g. 13
80
     *
81
     * @access public
82
     */
83
    function Calendar_Hour($y, $m, $d, $h)
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
84
    {
85
        parent::Calendar($y, $m, $d, $h);
86
    }
87
88
    /**
89
     * Builds the Minutes in the Hour
90
     *
91
     * @param array $sDates (optional) Calendar_Minute objects representing selected dates
92
     *
93
     * @return boolean
94
     * @access public
95
     */
96
    function build($sDates = array())
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
97
    {
98
        include_once CALENDAR_ROOT.'Minute.php';
99
        $mIH = $this->cE->getMinutesInHour($this->year, $this->month, $this->day,
100
                           $this->hour);
101
        for ($i=0; $i < $mIH; $i++) {
102
            $this->children[$i] =
103
                new Calendar_Minute($this->year, $this->month, $this->day,
104
                           $this->hour, $i);
105
        }
106
        if (count($sDates) > 0) {
107
            $this->setSelection($sDates);
108
        }
109
        return true;
110
    }
111
112
    /**
113
     * Called from build()
114
     *
115
     * @param array $sDates Calendar_Minute objects representing selected dates
116
     *
117
     * @return void
118
     * @access private
119
     */
120
    function setSelection($sDates)
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
121
    {
122
        foreach ($sDates as $sDate) {
123
            if ($this->year == $sDate->thisYear()
124
                && $this->month == $sDate->thisMonth()
125
                && $this->day == $sDate->thisDay()
126
                && $this->hour == $sDate->thisHour())
127
            {
128
                $key = (int)$sDate->thisMinute();
129
                if (isset($this->children[$key])) {
130
                    $sDate->setSelected();
131
                    $this->children[$key] = $sDate;
132
                }
133
            }
134
        }
135
    }
136
}
137
?>
0 ignored issues
show
Best Practice introduced by
It is not recommended to use PHP's closing tag ?> in files other than templates.

Using a closing tag in PHP files that only contain PHP code is not recommended as you might accidentally add whitespace after the closing tag which would then be output by PHP. This can cause severe problems, for example headers cannot be sent anymore.

A simple precaution is to leave off the closing tag as it is not required, and it also has no negative effects whatsoever.

Loading history...