Calendar_Table_Helper::getWeekStart() - 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_Table_Helper::getWeekStart() A

↳ Parent: Calendar_Table_Helper

Complexity

Conditions	3
Paths	4

Size

Total Lines	15
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	11
dl	0
loc	15
rs	9.9
c	0
b	0
f	0
cc	3
nc	4
nop	4

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

/**
 * Contains the Calendar_Decorator_Wrapper 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
 */

/**
 * Used by Calendar_Month_Weekdays, Calendar_Month_Weeks and Calendar_Week to
 * help with building the calendar in tabular form
 *
 * @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_Table_Helper
{
    /**
     * Instance of the Calendar object being helped.
     * @var object
     * @access private
     */
    var $calendar;

    /**
     * Instance of the Calendar_Engine
     * @var object
     * @access private
     */
    var $cE;

    /**
     * First day of the week
     * @access private
     * @var string
     */
    var $firstDay;

    /**
     * The seven days of the week named
     * @access private
     * @var array
     */
    var $weekDays;

    /**
     * Days of the week ordered with $firstDay at the beginning
     * @access private
     * @var array
     */
    var $daysOfWeek = array();

    /**
     * Days of the month built from days of the week
     * @access private
     * @var array
     */
    var $daysOfMonth = array();

    /**
     * Number of weeks in month
     * @var int
     * @access private
     */
    var $numWeeks = null;

    /**
     * Number of emtpy days before real days begin in month
     * @var int
     * @access private
     */
    var $emptyBefore = 0;

    /**
     * Constructs Calendar_Table_Helper
     *
     * @param object &$calendar Calendar_Month_Weekdays, Calendar_Month_Weeks, Calendar_Week
     * @param int    $firstDay  (optional) first day of the week e.g. 1 for Monday
     *
     * @access protected
     */
    function Calendar_Table_Helper(& $calendar, $firstDay=null)

    {
        $this->calendar = & $calendar;
        $this->cE = & $calendar->getEngine();
        if (is_null($firstDay)) {
            $firstDay = $this->cE->getFirstDayOfWeek(
                $this->calendar->thisYear(),
                $this->calendar->thisMonth(),
                $this->calendar->thisDay()
            );
        }
        $this->firstDay = $firstDay;
        $this->setFirstDay();
        $this->setDaysOfMonth();
    }

    /**
     * Constructs $this->daysOfWeek based on $this->firstDay
     *
     * @return void
     * @access private
     */
    function setFirstDay()

    {
        $weekDays = $this->cE->getWeekDays(
            $this->calendar->thisYear(),
            $this->calendar->thisMonth(),
            $this->calendar->thisDay()
        );
        $endDays  = array();
        $tmpDays  = array();
        $begin = false;
        foreach ($weekDays as $day) {
            if ($begin) {
                $endDays[] = $day;
            } else if ($day === $this->firstDay) {
                $begin = true;
                $endDays[] = $day;
            } else {
                $tmpDays[] = $day;
            }
        }
        $this->daysOfWeek = array_merge($endDays, $tmpDays);
    }

    /**
     * Constructs $this->daysOfMonth
     *
     * @return void
     * @access private
     */
    function setDaysOfMonth()

    {
        $this->daysOfMonth = $this->daysOfWeek;
        $daysInMonth = $this->cE->getDaysInMonth(
            $this->calendar->thisYear(), $this->calendar->thisMonth());
        $firstDayInMonth = $this->cE->getFirstDayInMonth(
            $this->calendar->thisYear(), $this->calendar->thisMonth());
        $this->emptyBefore=0;
        foreach ($this->daysOfMonth as $dayOfWeek) {
            if ($firstDayInMonth == $dayOfWeek) {
                break;
            }
            $this->emptyBefore++;
        }
        $this->numWeeks = ceil(
            ($daysInMonth + $this->emptyBefore)
                /
            $this->cE->getDaysInWeek(
                $this->calendar->thisYear(),
                $this->calendar->thisMonth(),
                $this->calendar->thisDay()
            )
        );
        for ($i=1; $i < $this->numWeeks; $i++) {
            $this->daysOfMonth =
                array_merge($this->daysOfMonth, $this->daysOfWeek);
        }
    }

    /**
     * Returns the first day of the month
     *
     * @return int
     * @access protected
     * @see Calendar_Engine_Interface::getFirstDayOfWeek()
     */
    function getFirstDay()

    {
        return $this->firstDay;

    }

    /**
     * Returns the order array of days in a week
     *
     * @return int
     * @access protected
     */
    function getDaysOfWeek()

    {
        return $this->daysOfWeek;

    }

    /**
     * Returns the number of tabular weeks in a month
     *
     * @return int
     * @access protected
     */
    function getNumWeeks()

    {
        return $this->numWeeks;
    }

    /**
     * Returns the number of real days + empty days
     *
     * @return int
     * @access protected
     */
    function getNumTableDaysInMonth()

    {
        return count($this->daysOfMonth);
    }

    /**
     * Returns the number of empty days before the real days begin
     *
     * @return int
     * @access protected
     */
    function getEmptyDaysBefore()

    {
        return $this->emptyBefore;
    }

    /**
     * Returns the index of the last real day in the month
     *
     * @todo Potential performance optimization with static
     * @return int
     * @access protected
     */
    function getEmptyDaysAfter()

    {
        // Causes bug when displaying more than one month
        //static $index;
        //if (!isset($index)) {
            $index = $this->getEmptyDaysBefore() + $this->cE->getDaysInMonth(
                $this->calendar->thisYear(), $this->calendar->thisMonth());
        //}
        return $index;
    }

    /**
     * Returns the index of the last real day in the month, relative to the
     * beginning of the tabular week it is part of
     *
     * @return int
     * @access protected
     */
    function getEmptyDaysAfterOffset()

    {
        $eAfter = $this->getEmptyDaysAfter();
        return $eAfter - (
            $this->cE->getDaysInWeek(
                $this->calendar->thisYear(),
                $this->calendar->thisMonth(),
                $this->calendar->thisDay()
            ) * ($this->numWeeks-1));
    }

    /**
     * Returns the timestamp of the first day of the current week
     *
     * @param int $y        year
     * @param int $m        month
     * @param int $d        day
     * @param int $firstDay first day of the week (default 1 = Monday)
     *
     * @return int timestamp
     */
    function getWeekStart($y, $m, $d, $firstDay=1)

    {
        $dow = $this->cE->getDayOfWeek($y, $m, $d);
        if ($dow > $firstDay) {
            $d -= ($dow - $firstDay);
        }
        if ($dow < $firstDay) {
            $d -= (
                $this->cE->getDaysInWeek(
                    $this->calendar->thisYear(),
                    $this->calendar->thisMonth(),
                    $this->calendar->thisDay()
                ) - $firstDay + $dow);
        }
        return $this->cE->dateToStamp($y, $m, $d);
    }
}
?>


1			<?php
2			/* vim: set expandtab tabstop=4 shiftwidth=4: */
3
4			/**
5			* Contains the Calendar_Decorator_Wrapper 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			* Used by Calendar_Month_Weekdays, Calendar_Month_Weeks and Calendar_Week to
41			* help with building the calendar in tabular form
42			*
43			* @category Date and Time
44			* @package Calendar
45			* @author Harry Fuecks <[email protected]>
46			* @copyright 2003-2007 Harry Fuecks
47			* @license http://www.debian.org/misc/bsd.license BSD License (3 Clause)
48			* @link http://pear.php.net/package/Calendar
49			* @access public
50			*/
51			class Calendar_Table_Helper
52			{
53			/**
54			* Instance of the Calendar object being helped.
55			* @var object
56			* @access private
57			*/
58			var $calendar;
59
60			/**
61			* Instance of the Calendar_Engine
62			* @var object
63			* @access private
64			*/
65			var $cE;
66
67			/**
68			* First day of the week
69			* @access private
70			* @var string
71			*/
72			var $firstDay;
73
74			/**
75			* The seven days of the week named
76			* @access private
77			* @var array
78			*/
79			var $weekDays;
80
81			/**
82			* Days of the week ordered with $firstDay at the beginning
83			* @access private
84			* @var array
85			*/
86			var $daysOfWeek = array();
87
88			/**
89			* Days of the month built from days of the week
90			* @access private
91			* @var array
92			*/
93			var $daysOfMonth = array();
94
95			/**
96			* Number of weeks in month
97			* @var int
98			* @access private
99			*/
100			var $numWeeks = null;
101
102			/**
103			* Number of emtpy days before real days begin in month
104			* @var int
105			* @access private
106			*/
107			var $emptyBefore = 0;
108
109			/**
110			* Constructs Calendar_Table_Helper
111			*
112			* @param object &$calendar Calendar_Month_Weekdays, Calendar_Month_Weeks, Calendar_Week
113			* @param int $firstDay (optional) first day of the week e.g. 1 for Monday
114			*
115			* @access protected
116			*/
117			function Calendar_Table_Helper(& $calendar, $firstDay=null)
			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...
118			{
119			$this->calendar = & $calendar;
120			$this->cE = & $calendar->getEngine();
121			if (is_null($firstDay)) {
122			$firstDay = $this->cE->getFirstDayOfWeek(
123			$this->calendar->thisYear(),
124			$this->calendar->thisMonth(),
125			$this->calendar->thisDay()
126			);
127			}
128			$this->firstDay = $firstDay;
129			$this->setFirstDay();
130			$this->setDaysOfMonth();
131			}
132
133			/**
134			* Constructs $this->daysOfWeek based on $this->firstDay
135			*
136			* @return void
137			* @access private
138			*/
139			function setFirstDay()
			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			$weekDays = $this->cE->getWeekDays(
142			$this->calendar->thisYear(),
143			$this->calendar->thisMonth(),
144			$this->calendar->thisDay()
145			);
146			$endDays = array();
147			$tmpDays = array();
148			$begin = false;
149			foreach ($weekDays as $day) {
150			if ($begin) {
151			$endDays[] = $day;
152			} else if ($day === $this->firstDay) {
153			$begin = true;
154			$endDays[] = $day;
155			} else {
156			$tmpDays[] = $day;
157			}
158			}
159			$this->daysOfWeek = array_merge($endDays, $tmpDays);
160			}
161
162			/**
163			* Constructs $this->daysOfMonth
164			*
165			* @return void
166			* @access private
167			*/
168			function setDaysOfMonth()
			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...
169			{
170			$this->daysOfMonth = $this->daysOfWeek;
171			$daysInMonth = $this->cE->getDaysInMonth(
172			$this->calendar->thisYear(), $this->calendar->thisMonth());
173			$firstDayInMonth = $this->cE->getFirstDayInMonth(
174			$this->calendar->thisYear(), $this->calendar->thisMonth());
175			$this->emptyBefore=0;
176			foreach ($this->daysOfMonth as $dayOfWeek) {
177			if ($firstDayInMonth == $dayOfWeek) {
178			break;
179			}
180			$this->emptyBefore++;
181			}
182			$this->numWeeks = ceil(
183			($daysInMonth + $this->emptyBefore)
184			/
185			$this->cE->getDaysInWeek(
186			$this->calendar->thisYear(),
187			$this->calendar->thisMonth(),
188			$this->calendar->thisDay()
189			)
190			);
191			for ($i=1; $i < $this->numWeeks; $i++) {
192			$this->daysOfMonth =
193			array_merge($this->daysOfMonth, $this->daysOfWeek);
194			}
195			}
196
197			/**
198			* Returns the first day of the month
199			*
200			* @return int
201			* @access protected
202			* @see Calendar_Engine_Interface::getFirstDayOfWeek()
203			*/
204			function getFirstDay()
			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...
205			{
206			return $this->firstDay;
			0 ignored issues – show Bug Best Practice introduced 2019-03-11 11:08 UTC by Report Bug Copy Issue Report The expression `return $this->firstDay` returns the type `string` which is incompatible with the documented return type `integer`. Loading history...
207			}
208
209			/**
210			* Returns the order array of days in a week
211			*
212			* @return int
213			* @access protected
214			*/
215			function getDaysOfWeek()
			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...
216			{
217			return $this->daysOfWeek;
			0 ignored issues – show Bug Best Practice introduced 2019-03-11 11:08 UTC by Report Bug Copy Issue Report The expression `return $this->daysOfWeek` returns the type `array` which is incompatible with the documented return type `integer`. Loading history...
218			}
219
220			/**
221			* Returns the number of tabular weeks in a month
222			*
223			* @return int
224			* @access protected
225			*/
226			function getNumWeeks()
			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...
227			{
228			return $this->numWeeks;
229			}
230
231			/**
232			* Returns the number of real days + empty days
233			*
234			* @return int
235			* @access protected
236			*/
237			function getNumTableDaysInMonth()
			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...
238			{
239			return count($this->daysOfMonth);
240			}
241
242			/**
243			* Returns the number of empty days before the real days begin
244			*
245			* @return int
246			* @access protected
247			*/
248			function getEmptyDaysBefore()
			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...
249			{
250			return $this->emptyBefore;
251			}
252
253			/**
254			* Returns the index of the last real day in the month
255			*
256			* @todo Potential performance optimization with static
257			* @return int
258			* @access protected
259			*/
260			function getEmptyDaysAfter()
			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...
261			{
262			// Causes bug when displaying more than one month
263			//static $index;
264			//if (!isset($index)) {
265			$index = $this->getEmptyDaysBefore() + $this->cE->getDaysInMonth(
266			$this->calendar->thisYear(), $this->calendar->thisMonth());
267			//}
268			return $index;
269			}
270
271			/**
272			* Returns the index of the last real day in the month, relative to the
273			* beginning of the tabular week it is part of
274			*
275			* @return int
276			* @access protected
277			*/
278			function getEmptyDaysAfterOffset()
			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...
279			{
280			$eAfter = $this->getEmptyDaysAfter();
281			return $eAfter - (
282			$this->cE->getDaysInWeek(
283			$this->calendar->thisYear(),
284			$this->calendar->thisMonth(),
285			$this->calendar->thisDay()
286			) * ($this->numWeeks-1));
287			}
288
289			/**
290			* Returns the timestamp of the first day of the current week
291			*
292			* @param int $y year
293			* @param int $m month
294			* @param int $d day
295			* @param int $firstDay first day of the week (default 1 = Monday)
296			*
297			* @return int timestamp
298			*/
299			function getWeekStart($y, $m, $d, $firstDay=1)
			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...
300			{
301			$dow = $this->cE->getDayOfWeek($y, $m, $d);
302			if ($dow > $firstDay) {
303			$d -= ($dow - $firstDay);
304			}
305			if ($dow < $firstDay) {
306			$d -= (
307			$this->cE->getDaysInWeek(
308			$this->calendar->thisYear(),
309			$this->calendar->thisMonth(),
310			$this->calendar->thisDay()
311			) - $firstDay + $dow);
312			}
313			return $this->cE->dateToStamp($y, $m, $d);
314			}
315			}
316			?>
			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_Table_Helper::getWeekStart() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like