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

Calendar_Year::Calendar_Year()   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 1
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
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 a Year and builds Months<br>
54
 * <code>
55
 * require_once 'Calendar'.DIRECTORY_SEPARATOR.'Year.php';
56
 * $Year = & new Calendar_Year(2003, 10, 21); // 21st Oct 2003
57
 * $Year->build(); // Build Calendar_Month objects
58
 * while ($Month = & $Year->fetch()) {
59
 *     echo $Month->thisMonth().'<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_Year extends Calendar
72
{
73
    /**
74
     * Constructs Calendar_Year
75
     *
76
     * @param int $y year e.g. 2003
77
     *
78
     * @access public
79
     */
80
    function Calendar_Year($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...
81
    {
82
        parent::Calendar($y);
83
    }
84
85
    /**
86
     * Builds the Months of the Year.<br>
87
     * <b>Note:</b> by defining the constant CALENDAR_MONTH_STATE you can
88
     * control what class of Calendar_Month is built e.g.;
89
     * <code>
90
     * require_once 'Calendar/Calendar_Year.php';
91
     * define ('CALENDAR_MONTH_STATE',CALENDAR_USE_MONTH_WEEKDAYS); // Use Calendar_Month_Weekdays
92
     * // define ('CALENDAR_MONTH_STATE',CALENDAR_USE_MONTH_WEEKS); // Use Calendar_Month_Weeks
93
     * // define ('CALENDAR_MONTH_STATE',CALENDAR_USE_MONTH); // Use Calendar_Month
94
     * </code>
95
     * It defaults to building Calendar_Month objects.
96
     *
97
     * @param array $sDates   (optional) array of Calendar_Month objects
98
     *                        representing selected dates
99
     * @param int   $firstDay (optional) first day of week
100
     *                        (e.g. 0 for Sunday, 2 for Tuesday etc.)
101
     *
102
     * @return boolean
103
     * @access public
104
     */
105
    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...
106
    {
107
        include_once CALENDAR_ROOT.'Factory.php';
108
        $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...
109
        $monthsInYear   = $this->cE->getMonthsInYear($this->thisYear());
110
        for ($i=1; $i <= $monthsInYear; $i++) {
111
            $this->children[$i] = Calendar_Factory::create('Month', $this->year, $i);
0 ignored issues
show
Bug Best Practice introduced by
The method 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

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