Passed
Pull Request — master (#2)
by tsms
01:39
created

Year::build()   A

Complexity

Conditions 3
Paths 4

Size

Total Lines 12
Code Lines 8

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
eloc 8
nc 4
nop 2
dl 0
loc 12
rs 10
c 0
b 0
f 0
1
<?php
2
/* vim: set expandtab tabstop=4 shiftwidth=4: */
3
4
/**
5
 * Contains the Calendar_Minute 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
namespace Pear\Calendar;
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
 * Represents a Year and builds Months<br>
55
 * <code>
56
 * require_once 'Calendar'.DIRECTORY_SEPARATOR.'Year.php';
57
 * $Year = & new Calendar_Year(2003, 10, 21); // 21st Oct 2003
58
 * $Year->build(); // Build Calendar_Month objects
59
 * while ($Month = & $Year->fetch()) {
60
 *     echo $Month->thisMonth().'<br />';
61
 * }
62
 * </code>
63
 *
64
 * @category  Date and Time
65
 * @package   Calendar
66
 * @author    Harry Fuecks <[email protected]>
67
 * @copyright 2003-2007 Harry Fuecks
68
 * @license   http://www.debian.org/misc/bsd.license  BSD License (3 Clause)
69
 * @link      http://pear.php.net/package/Calendar
70
 * @access    public
71
 */
72
class Year extends Calendar
73
{
74
    /**
75
     * Constructs Calendar_Year
76
     *
77
     * @param int $y year e.g. 2003
78
     *
79
     * @access public
80
     */
81
    function __construct($y)
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...
82
    {
83
        parent::__construct($y);
84
    }
85
86
    /**
87
     * Builds the Months of the Year.<br>
88
     * <b>Note:</b> by defining the constant CALENDAR_MONTH_STATE you can
89
     * control what class of Calendar_Month is built e.g.;
90
     * <code>
91
     * require_once 'Calendar/Calendar_Year.php';
92
     * define ('CALENDAR_MONTH_STATE',CALENDAR_USE_MONTH_WEEKDAYS); // Use Calendar_Month_Weekdays
93
     * // define ('CALENDAR_MONTH_STATE',CALENDAR_USE_MONTH_WEEKS); // Use Calendar_Month_Weeks
94
     * // define ('CALENDAR_MONTH_STATE',CALENDAR_USE_MONTH); // Use Calendar_Month
95
     * </code>
96
     * It defaults to building Calendar_Month objects.
97
     *
98
     * @param array $sDates   (optional) array of Calendar_Month objects
99
     *                        representing selected dates
100
     * @param int   $firstDay (optional) first day of week
101
     *                        (e.g. 0 for Sunday, 2 for Tuesday etc.)
102
     *
103
     * @return boolean
104
     * @access public
105
     */
106
    function build($sDates = array(), $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...
107
    {
108
        include_once CALENDAR_ROOT.'Factory.php';
109
        $this->firstDay = $this->defineFirstDayOfWeek($firstDay);
0 ignored issues
show
Bug Best Practice introduced by
The property firstDay does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.
Loading history...
110
        $monthsInYear   = $this->cE->getMonthsInYear($this->thisYear());
111
        for ($i=1; $i <= $monthsInYear; $i++) {
112
            $this->children[$i] = Factory::create('Month', $this->year, $i);
0 ignored issues
show
Bug Best Practice introduced by
The method Pear\Calendar\Factory::create() is not static, but was called statically. ( Ignorable by Annotation )

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

112
            /** @scrutinizer ignore-call */ 
113
            $this->children[$i] = Factory::create('Month', $this->year, $i);
Loading history...
113
        }
114
        if (count($sDates) > 0) {
115
            $this->setSelection($sDates);
116
        }
117
        return true;
118
    }
119
120
    /**
121
     * Called from build()
122
     *
123
     * @param array $sDates array of Calendar_Month objects representing selected dates
124
     *
125
     * @return void
126
     * @access private
127
     */
128
    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...
129
    {
130
        foreach ($sDates as $sDate) {
131
            if ($this->year == $sDate->thisYear()) {
132
                $key = $sDate->thisMonth();
133
                if (isset($this->children[$key])) {
134
                    $sDate->setSelected();
135
                    $this->children[$key] = $sDate;
136
                }
137
            }
138
        }
139
    }
140
}
141