Calendar_Day::Calendar_Day() - Code Metrics - Inspection of "Add tests against PHP 5.6 or later (#5)" - FriendsOfPear/Calendar - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 08536e...5223e1 )

by tsms

created 2019-03-11 12:19 UTC

Calendar_Day::Calendar_Day() A

↳ Parent: Calendar_Day

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	3

<?php
/* vim: set expandtab tabstop=4 shiftwidth=4: */

/**
 * Contains the Calendar_Day class
 *
 * PHP versions 4 and 5
 *
 * LICENSE: Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE FREEBSD PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Date and Time
 * @package   Calendar
 * @author    Harry Fuecks <[email protected]>
 * @copyright 2003-2007 Harry Fuecks
 * @license   http://www.debian.org/misc/bsd.license  BSD License (3 Clause)
 * @version   CVS: $Id$
 * @link      http://pear.php.net/package/Calendar
 */

/**
 * Allows Calendar include path to be redefined
 * @ignore
 */
if (!defined('CALENDAR_ROOT')) {
    define('CALENDAR_ROOT', 'Calendar'.DIRECTORY_SEPARATOR);
}

/**
 * Load Calendar base class
 */
require_once CALENDAR_ROOT.'Calendar.php';

/**
 * Represents a Day and builds Hours.
 * <code>
 * require_once 'Calendar/Day.php';
 * $Day = new Calendar_Day(2003, 10, 21); // Oct 21st 2003
 * while ($Hour = & $Day->fetch()) {
 *    echo $Hour->thisHour().'<br />';
 * }
 * </code>
 *
 * @category  Date and Time
 * @package   Calendar
 * @author    Harry Fuecks <[email protected]>
 * @copyright 2003-2007 Harry Fuecks
 * @license   http://www.debian.org/misc/bsd.license  BSD License (3 Clause)
 * @link      http://pear.php.net/package/Calendar
 * @access    public
 */
class Calendar_Day extends Calendar
{
    /**
     * Marks the Day at the beginning of a week
     * @access private
     * @var boolean
     */
    var $first = false;

    /**
     * Marks the Day at the end of a week
     * @access private
     * @var boolean
     */
    var $last = false;


    /**
     * Used for tabular calendars
     * @access private
     * @var boolean
     */
    var $empty = false;

    /**
     * Constructs Calendar_Day
     *
     * @param int $y year e.g. 2003
     * @param int $m month e.g. 8
     * @param int $d day e.g. 15
     *
     * @access public
     */
    function Calendar_Day($y, $m, $d)

    {
        parent::Calendar($y, $m, $d);
    }

    /**
     * Builds the Hours of the Day
     *
     * @param array $sDates (optional) Caledar_Hour objects representing selected dates
     *
     * @return boolean
     * @access public
     */
    function build($sDates = array())

    {
        include_once CALENDAR_ROOT.'Hour.php';

        $hID = $this->cE->getHoursInDay($this->year, $this->month, $this->day);
        for ($i=0; $i < $hID; $i++) {
            $this->children[$i] =
                new Calendar_Hour($this->year, $this->month, $this->day, $i);
        }
        if (count($sDates) > 0) {
            $this->setSelection($sDates);
        }
        return true;
    }

    /**
     * Called from build()
     *
     * @param array $sDates dates to be selected
     *
     * @return void
     * @access private
     */
    function setSelection($sDates)

    {
        foreach ($sDates as $sDate) {
            if ($this->year == $sDate->thisYear()
                && $this->month == $sDate->thisMonth()
                && $this->day == $sDate->thisDay())
            {
                $key = (int)$sDate->thisHour();
                if (isset($this->children[$key])) {
                    $sDate->setSelected();
                    $this->children[$key] = $sDate;
                }
            }
        }
    }

    /**
     * Defines Day object as first in a week
     * Only used by Calendar_Month_Weekdays::build()
     *
     * @param boolean $state set this day as first in week
     *
     * @return void
     * @access private
     */
    function setFirst($state = true)

    {
        $this->first = $state;
    }

    /**
     * Defines Day object as last in a week
     * Used only following Calendar_Month_Weekdays::build()
     *
     * @param boolean $state set this day as last in week
     *
     * @return void
     * @access private
     */
    function setLast($state = true)

    {
        $this->last = $state;
    }

    /**
     * Returns true if Day object is first in a Week
     * Only relevant when Day is created by Calendar_Month_Weekdays::build()
     *
     * @return boolean
     * @access public
     */
    function isFirst() 

    {
        return $this->first;
    }

    /**
     * Returns true if Day object is last in a Week
     * Only relevant when Day is created by Calendar_Month_Weekdays::build()
     *
     * @return boolean
     * @access public
     */
    function isLast()

    {
        return $this->last;
    }

    /**
     * Defines Day object as empty
     * Only used by Calendar_Month_Weekdays::build()
     *
     * @param boolean $state set this day as empty
     *
     * @return void
     * @access private
     */
    function setEmpty ($state = true)

    {
        $this->empty = $state;
    }

    /**
     * Check if this day is empty
     *
     * @return boolean
     * @access public
     */
    function isEmpty()

    {
        return $this->empty;
    }
}
?>


1			<?php
2			/* vim: set expandtab tabstop=4 shiftwidth=4: */
3
4			/**
5			* Contains the Calendar_Day 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 Day and builds Hours.
54			* <code>
55			* require_once 'Calendar/Day.php';
56			* $Day = new Calendar_Day(2003, 10, 21); // Oct 21st 2003
57			* while ($Hour = & $Day->fetch()) {
58			* echo $Hour->thisHour().'<br />';
59			* }
60			* </code>
61			*
62			* @category Date and Time
63			* @package Calendar
64			* @author Harry Fuecks <[email protected]>
65			* @copyright 2003-2007 Harry Fuecks
66			* @license http://www.debian.org/misc/bsd.license BSD License (3 Clause)
67			* @link http://pear.php.net/package/Calendar
68			* @access public
69			*/
70			class Calendar_Day extends Calendar
71			{
72			/**
73			* Marks the Day at the beginning of a week
74			* @access private
75			* @var boolean
76			*/
77			var $first = false;
78
79			/**
80			* Marks the Day at the end of a week
81			* @access private
82			* @var boolean
83			*/
84			var $last = false;
85
86
87			/**
88			* Used for tabular calendars
89			* @access private
90			* @var boolean
91			*/
92			var $empty = false;
93
94			/**
95			* Constructs Calendar_Day
96			*
97			* @param int $y year e.g. 2003
98			* @param int $m month e.g. 8
99			* @param int $d day e.g. 15
100			*
101			* @access public
102			*/
103			function Calendar_Day($y, $m, $d)
			0 ignored issues – show Best Practice introduced 2019-03-11 11:08 UTC by Report Bug Copy Issue Report 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($y, $m, $d);
106			}
107
108			/**
109			* Builds the Hours of the Day
110			*
111			* @param array $sDates (optional) Caledar_Hour objects representing selected dates
112			*
113			* @return boolean
114			* @access public
115			*/
116			function build($sDates = array())
			0 ignored issues – show Best Practice introduced 2019-03-11 11:08 UTC by Report Bug Copy Issue Report 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...
117			{
118			include_once CALENDAR_ROOT.'Hour.php';
119
120			$hID = $this->cE->getHoursInDay($this->year, $this->month, $this->day);
121			for ($i=0; $i < $hID; $i++) {
122			$this->children[$i] =
123			new Calendar_Hour($this->year, $this->month, $this->day, $i);
124			}
125			if (count($sDates) > 0) {
126			$this->setSelection($sDates);
127			}
128			return true;
129			}
130
131			/**
132			* Called from build()
133			*
134			* @param array $sDates dates to be selected
135			*
136			* @return void
137			* @access private
138			*/
139			function setSelection($sDates)
			0 ignored issues – show Best Practice introduced 2019-03-11 11:08 UTC by Report Bug Copy Issue Report 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...
140			{
141			foreach ($sDates as $sDate) {
142			if ($this->year == $sDate->thisYear()
143			&& $this->month == $sDate->thisMonth()
144			&& $this->day == $sDate->thisDay())
145			{
146			$key = (int)$sDate->thisHour();
147			if (isset($this->children[$key])) {
148			$sDate->setSelected();
149			$this->children[$key] = $sDate;
150			}
151			}
152			}
153			}
154
155			/**
156			* Defines Day object as first in a week
157			* Only used by Calendar_Month_Weekdays::build()
158			*
159			* @param boolean $state set this day as first in week
160			*
161			* @return void
162			* @access private
163			*/
164			function setFirst($state = true)
			0 ignored issues – show Best Practice introduced 2019-03-11 11:08 UTC by Report Bug Copy Issue Report 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...
165			{
166			$this->first = $state;
167			}
168
169			/**
170			* Defines Day object as last in a week
171			* Used only following Calendar_Month_Weekdays::build()
172			*
173			* @param boolean $state set this day as last in week
174			*
175			* @return void
176			* @access private
177			*/
178			function setLast($state = true)
			0 ignored issues – show Best Practice introduced 2019-03-11 11:08 UTC by Report Bug Copy Issue Report 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...
179			{
180			$this->last = $state;
181			}
182
183			/**
184			* Returns true if Day object is first in a Week
185			* Only relevant when Day is created by Calendar_Month_Weekdays::build()
186			*
187			* @return boolean
188			* @access public
189			*/
190			function isFirst()
			0 ignored issues – show Best Practice introduced 2019-03-11 11:08 UTC by Report Bug Copy Issue Report 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...
191			{
192			return $this->first;
193			}
194
195			/**
196			* Returns true if Day object is last in a Week
197			* Only relevant when Day is created by Calendar_Month_Weekdays::build()
198			*
199			* @return boolean
200			* @access public
201			*/
202			function isLast()
			0 ignored issues – show Best Practice introduced 2019-03-11 11:08 UTC by Report Bug Copy Issue Report 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...
203			{
204			return $this->last;
205			}
206
207			/**
208			* Defines Day object as empty
209			* Only used by Calendar_Month_Weekdays::build()
210			*
211			* @param boolean $state set this day as empty
212			*
213			* @return void
214			* @access private
215			*/
216			function setEmpty ($state = true)
			0 ignored issues – show Best Practice introduced 2019-03-11 11:08 UTC by Report Bug Copy Issue Report 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...
217			{
218			$this->empty = $state;
219			}
220
221			/**
222			* Check if this day is empty
223			*
224			* @return boolean
225			* @access public
226			*/
227			function isEmpty()
			0 ignored issues – show Best Practice introduced 2019-03-11 11:08 UTC by Report Bug Copy Issue Report 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...
228			{
229			return $this->empty;
230			}
231			}
232			?>
			0 ignored issues – show Best Practice introduced 2019-03-11 11:08 UTC by Report Bug Copy Issue Report 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...

FriendsOfPear / Calendar

Push — master ( 08536e...5223e1 )

Calendar_Day::Calendar_Day() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like