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

Year   A

Complexity

Total Complexity 8

Size/Duplication

Total Lines 64
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
eloc 16
dl 0
loc 64
rs 10
c 0
b 0
f 0
wmc 8

3 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 3 1
A setSelection() 0 8 4
A build() 0 12 3
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
 * Represents a Year and builds Months<br>
42
 * <code>
43
 * require_once 'Calendar'.DIRECTORY_SEPARATOR.'Year.php';
44
 * $Year = & new Calendar_Year(2003, 10, 21); // 21st Oct 2003
45
 * $Year->build(); // Build Calendar_Month objects
46
 * while ($Month = & $Year->fetch()) {
47
 *     echo $Month->thisMonth().'<br />';
48
 * }
49
 * </code>
50
 *
51
 * @category  Date and Time
52
 * @package   Calendar
53
 * @author    Harry Fuecks <[email protected]>
54
 * @copyright 2003-2007 Harry Fuecks
55
 * @license   http://www.debian.org/misc/bsd.license  BSD License (3 Clause)
56
 * @link      http://pear.php.net/package/Calendar
57
 * @access    public
58
 */
59
class Year extends Calendar
60
{
61
    /**
62
     * Constructs Calendar_Year
63
     *
64
     * @param int $y year e.g. 2003
65
     *
66
     * @access public
67
     */
68
    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...
69
    {
70
        parent::__construct($y);
71
    }
72
73
    /**
74
     * Builds the Months of the Year.<br>
75
     * <b>Note:</b> by defining the constant CALENDAR_MONTH_STATE you can
76
     * control what class of Calendar_Month is built e.g.;
77
     * <code>
78
     * require_once 'Calendar/Calendar_Year.php';
79
     * define ('CALENDAR_MONTH_STATE',CALENDAR_USE_MONTH_WEEKDAYS); // Use Calendar_Month_Weekdays
80
     * // define ('CALENDAR_MONTH_STATE',CALENDAR_USE_MONTH_WEEKS); // Use Calendar_Month_Weeks
81
     * // define ('CALENDAR_MONTH_STATE',CALENDAR_USE_MONTH); // Use Calendar_Month
82
     * </code>
83
     * It defaults to building Calendar_Month objects.
84
     *
85
     * @param array $sDates   (optional) array of Calendar_Month objects
86
     *                        representing selected dates
87
     * @param int   $firstDay (optional) first day of week
88
     *                        (e.g. 0 for Sunday, 2 for Tuesday etc.)
89
     *
90
     * @return boolean
91
     * @access public
92
     */
93
    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...
94
    {
95
        include_once CALENDAR_ROOT.'Factory.php';
96
        $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...
97
        $monthsInYear   = $this->cE->getMonthsInYear($this->thisYear());
98
        for ($i=1; $i <= $monthsInYear; $i++) {
99
            $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

99
            /** @scrutinizer ignore-call */ 
100
            $this->children[$i] = Factory::create('Month', $this->year, $i);
Loading history...
100
        }
101
        if (count($sDates) > 0) {
102
            $this->setSelection($sDates);
103
        }
104
        return true;
105
    }
106
107
    /**
108
     * Called from build()
109
     *
110
     * @param array $sDates array of Calendar_Month objects representing selected dates
111
     *
112
     * @return void
113
     * @access private
114
     */
115
    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...
116
    {
117
        foreach ($sDates as $sDate) {
118
            if ($this->year == $sDate->thisYear()) {
119
                $key = $sDate->thisMonth();
120
                if (isset($this->children[$key])) {
121
                    $sDate->setSelected();
122
                    $this->children[$key] = $sDate;
123
                }
124
            }
125
        }
126
    }
127
}
128