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

Calendar_Month_Weeks::Calendar_Month_Weeks()   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 3
1
<?php
2
/* vim: set expandtab tabstop=4 shiftwidth=4: */
3
4
/**
5
 * Contains the Calendar_Month_Weeks 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
 * @author    Lorenzo Alberton <[email protected]>
34
 * @copyright 2003-2007 Harry Fuecks, Lorenzo Alberton
35
 * @license   http://www.debian.org/misc/bsd.license  BSD License (3 Clause)
36
 * @version   CVS: $Id$
37
 * @link      http://pear.php.net/package/Calendar
38
 */
39
40
/**
41
 * Allows Calendar include path to be redefined
42
 * @ignore
43
 */
44
if (!defined('CALENDAR_ROOT')) {
45
    define('CALENDAR_ROOT', 'Calendar'.DIRECTORY_SEPARATOR);
46
}
47
48
/**
49
 * Load Calendar base class
50
 */
51
require_once CALENDAR_ROOT.'Calendar.php';
52
53
/**
54
 * Load base month
55
 */
56
require_once CALENDAR_ROOT.'Month.php';
57
58
/**
59
 * Represents a Month and builds Weeks
60
 * <code>
61
 * require_once 'Calendar'.DIRECTORY_SEPARATOR.'Month'.DIRECTORY_SEPARATOR.'Weeks.php';
62
 * $Month = new Calendar_Month_Weeks(2003, 10); // Oct 2003
63
 * $Month->build(); // Build Calendar_Day objects
64
 * while ($Week = & $Month->fetch()) {
65
 *     echo $Week->thisWeek().'<br />';
66
 * }
67
 * </code>
68
 *
69
 * @category  Date and Time
70
 * @package   Calendar
71
 * @author    Harry Fuecks <[email protected]>
72
 * @author    Lorenzo Alberton <[email protected]>
73
 * @copyright 2003-2007 Harry Fuecks, Lorenzo Alberton
74
 * @license   http://www.debian.org/misc/bsd.license  BSD License (3 Clause)
75
 * @link      http://pear.php.net/package/Calendar
76
 * @access    public
77
 */
78
class Calendar_Month_Weeks extends Calendar_Month
79
{
80
    /**
81
     * Instance of Calendar_Table_Helper
82
     * @var Calendar_Table_Helper
83
     * @access private
84
     */
85
    var $tableHelper;
86
87
    /**
88
     * First day of the week
89
     * @access private
90
     * @var string
91
     */
92
    var $firstDay;
93
94
    /**
95
     * Constructs Calendar_Month_Weeks
96
     *
97
     * @param int $y        year e.g. 2003
98
     * @param int $m        month e.g. 5
99
     * @param int $firstDay (optional) first day of week (e.g. 0 for Sunday, 2 for Tuesday etc.)
100
     *
101
     * @access public
102
     */
103
    function Calendar_Month_Weeks($y, $m, $firstDay=null)
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...
104
    {
105
        parent::Calendar_Month($y, $m, $firstDay);
106
    }
107
108
    /**
109
     * Builds Calendar_Week objects for the Month. Note that Calendar_Week
110
     * builds Calendar_Day object in tabular form (with Calendar_Day->empty)
111
     *
112
     * @param array $sDates (optional) Calendar_Week objects representing selected dates
113
     *
114
     * @return boolean
115
     * @access public
116
     */
117
    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...
118
    {
119
        include_once CALENDAR_ROOT.'Table/Helper.php';
120
        $this->tableHelper = new Calendar_Table_Helper($this, $this->firstDay);
0 ignored issues
show
Bug introduced by
$this->firstDay of type string is incompatible with the type integer expected by parameter $firstDay of Calendar_Table_Helper::Calendar_Table_Helper(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

120
        $this->tableHelper = new Calendar_Table_Helper($this, /** @scrutinizer ignore-type */ $this->firstDay);
Loading history...
121
        include_once CALENDAR_ROOT.'Week.php';
122
        $numWeeks = $this->tableHelper->getNumWeeks();
123
        for ($i=1, $d=1; $i<=$numWeeks; $i++,
124
            $d+=$this->cE->getDaysInWeek(
125
                $this->thisYear(),
126
                $this->thisMonth(),
127
                $this->thisDay()
128
            )
129
        ) {
130
            $this->children[$i] = new Calendar_Week(
131
                $this->year, $this->month, $d, $this->tableHelper->getFirstDay());
132
        }
133
        //used to set empty days
134
        $this->children[1]->setFirst(true);
135
        $this->children[$numWeeks]->setLast(true);
136
137
        // Handle selected weeks here
138
        if (count($sDates) > 0) {
139
            $this->setSelection($sDates);
140
        }
141
        return true;
142
    }
143
144
    /**
145
     * Called from build()
146
     *
147
     * @param array $sDates Calendar_Week objects representing selected dates
148
     *
149
     * @return void
150
     * @access private
151
     */
152
    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...
153
    {
154
        foreach ($sDates as $sDate) {
155
            if ($this->year == $sDate->thisYear()
156
                && $this->month == $sDate->thisMonth())
157
            {
158
                $key = $sDate->thisWeek('n_in_month');
159
                if (isset($this->children[$key])) {
160
                    $this->children[$key]->setSelected();
161
                }
162
            }
163
        }
164
    }
165
}
166
?>
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...