- Timestamp:
- 2013/08/26 15:52:37 (11 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
branches/version-2_13_0/data/module/Calendar/Engine/Interface.php
r20119 r23126 1 1 <?php 2 2 /* vim: set expandtab tabstop=4 shiftwidth=4: */ 3 // 4 // +----------------------------------------------------------------------+ 5 // | PHP Version 4 | 6 // +----------------------------------------------------------------------+ 7 // | Copyright (c) 1997-2002 The PHP Group | 8 // +----------------------------------------------------------------------+ 9 // | This source file is subject to version 2.02 of the PHP license, | 10 // | that is bundled with this package in the file LICENSE, and is | 11 // | available at through the world-wide-web at | 12 // | http://www.php.net/license/3_0.txt. | 13 // | If you did not receive a copy of the PHP license and are unable to | 14 // | obtain it through the world-wide-web, please send a note to | 15 // | license@php.net so we can mail you a copy immediately. | 16 // +----------------------------------------------------------------------+ 17 // | Authors: Harry Fuecks <hfuecks@phppatterns.com> | 18 // +----------------------------------------------------------------------+ 19 // 20 // $Id: Interface.php,v 1.5 2004/08/16 12:29:18 hfuecks Exp $ 21 // 3 22 4 /** 23 * @package Calendar 24 * @version $Id: Interface.php,v 1.5 2004/08/16 12:29:18 hfuecks Exp $ 5 * Contains the Calendar_Engine_Interface class (interface) 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 <hfuecks@phppatterns.com> 33 * @author Lorenzo Alberton <l.alberton@quipo.it> 34 * @copyright 2003-2007 Harry Fuecks, Lorenzo Alberton 35 * @license http://www.debian.org/misc/bsd.license BSD License (3 Clause) 36 * @version CVS: $Id: Interface.php 269074 2008-11-15 21:21:42Z quipo $ 37 * @link http://pear.php.net/package/Calendar 25 38 */ 39 26 40 /** 27 41 * The methods the classes implementing the Calendar_Engine must implement. 28 42 * Note this class is not used but simply to help development 29 * @package Calendar 43 * 44 * @category Date and Time 45 * @package Calendar 46 * @author Harry Fuecks <hfuecks@phppatterns.com> 47 * @author Lorenzo Alberton <l.alberton@quipo.it> 48 * @copyright 2003-2007 Harry Fuecks, Lorenzo Alberton 49 * @license http://www.debian.org/misc/bsd.license BSD License (3 Clause) 50 * @link http://pear.php.net/package/Calendar 30 51 * @access protected 31 52 */ … … 37 58 * Typically called "internally" by methods like stampToYear. 38 59 * Return value can vary, depending on the specific implementation 39 * @param int timestamp (depending on implementation) 60 * 61 * @param int $stamp timestamp (depending on implementation) 62 * 40 63 * @return mixed 41 64 * @access protected … … 47 70 /** 48 71 * Returns a numeric year given a timestamp 49 * @param int timestamp (depending on implementation) 72 * 73 * @param int $stamp timestamp (depending on implementation) 74 * 50 75 * @return int year (e.g. 2003) 51 76 * @access protected … … 57 82 /** 58 83 * Returns a numeric month given a timestamp 59 * @param int timestamp (depending on implementation) 84 * 85 * @param int $stamp timestamp (depending on implementation) 86 * 60 87 * @return int month (e.g. 9) 61 88 * @access protected … … 67 94 /** 68 95 * Returns a numeric day given a timestamp 69 * @param int timestamp (depending on implementation) 96 * 97 * @param int $stamp timestamp (depending on implementation) 98 * 70 99 * @return int day (e.g. 15) 71 100 * @access protected … … 77 106 /** 78 107 * Returns a numeric hour given a timestamp 79 * @param int timestamp (depending on implementation) 108 * 109 * @param int $stamp timestamp (depending on implementation) 110 * 80 111 * @return int hour (e.g. 13) 81 112 * @access protected … … 87 118 /** 88 119 * Returns a numeric minute given a timestamp 89 * @param int timestamp (depending on implementation) 120 * 121 * @param int $stamp timestamp (depending on implementation) 122 * 90 123 * @return int minute (e.g. 34) 91 124 * @access protected … … 97 130 /** 98 131 * Returns a numeric second given a timestamp 99 * @param int timestamp (depending on implementation) 132 * 133 * @param int $stamp timestamp (depending on implementation) 134 * 100 135 * @return int second (e.g. 51) 101 136 * @access protected … … 106 141 107 142 /** 108 * Returns a timestamp. Can be worth "caching" generated 109 * timestamps in a static variable, identified by the 110 * params this method accepts, to timestamp will only 111 * be calculated once. 112 * @param int year (e.g. 2003) 113 * @param int month (e.g. 9) 114 * @param int day (e.g. 13) 115 * @param int hour (e.g. 13) 116 * @param int minute (e.g. 34) 117 * @param int second (e.g. 53) 143 * Returns a timestamp. Can be worth "caching" generated timestamps in a 144 * static variable, identified by the params this method accepts, 145 * to timestamp will only be calculated once. 146 * 147 * @param int $y year (e.g. 2003) 148 * @param int $m month (e.g. 9) 149 * @param int $d day (e.g. 13) 150 * @param int $h hour (e.g. 13) 151 * @param int $i minute (e.g. 34) 152 * @param int $s second (e.g. 53) 153 * 118 154 * @return int (depends on implementation) 119 155 * @access protected 120 156 */ 121 function dateToStamp($y, $m,$d,$h,$i,$s)157 function dateToStamp($y, $m, $d, $h, $i, $s) 122 158 { 123 159 } … … 125 161 /** 126 162 * The upper limit on years that the Calendar Engine can work with 163 * 127 164 * @return int (e.g. 2037) 128 165 * @access protected … … 134 171 /** 135 172 * The lower limit on years that the Calendar Engine can work with 173 * 136 174 * @return int (e.g 1902) 137 175 * @access protected … … 143 181 /** 144 182 * Returns the number of months in a year 145 * @param int (optional) year to get months for 183 * 184 * @param int $y (optional) year to get months for 185 * 146 186 * @return int (e.g. 12) 147 187 * @access protected … … 153 193 /** 154 194 * Returns the number of days in a month, given year and month 155 * @param int year (e.g. 2003) 156 * @param int month (e.g. 9) 195 * 196 * @param int $y year (e.g. 2003) 197 * @param int $m month (e.g. 9) 198 * 157 199 * @return int days in month 158 200 * @access protected … … 165 207 * Returns numeric representation of the day of the week in a month, 166 208 * given year and month 167 * @param int year (e.g. 2003) 168 * @param int month (e.g. 9) 209 * 210 * @param int $y year (e.g. 2003) 211 * @param int $m month (e.g. 9) 212 * 169 213 * @return int 170 214 * @access protected … … 176 220 /** 177 221 * Returns the number of days in a week 178 * @param int year (2003) 179 * @param int month (9) 180 * @param int day (4) 222 * 223 * @param int $y year (2003) 224 * @param int $m month (9) 225 * @param int $d day (4) 226 * 181 227 * @return int (e.g. 7) 182 228 * @access protected 183 229 */ 184 function getDaysInWeek($y= NULL, $m=NULL, $d=NULL)230 function getDaysInWeek($y=null, $m=null, $d=null) 185 231 { 186 232 } … … 188 234 /** 189 235 * Returns the number of the week in the year (ISO-8601), given a date 190 * @param int year (2003) 191 * @param int month (9) 192 * @param int day (4) 236 * 237 * @param int $y year (2003) 238 * @param int $m month (9) 239 * @param int $d day (4) 240 * 193 241 * @return int week number 194 242 * @access protected … … 200 248 /** 201 249 * Returns the number of the week in the month, given a date 202 * @param int year (2003) 203 * @param int month (9) 204 * @param int day (4) 205 * @param int first day of the week (default: 1 - monday) 250 * 251 * @param int $y year (2003) 252 * @param int $m month (9) 253 * @param int $d day (4) 254 * @param int $firstDay first day of the week (default: 1 - monday) 255 * 206 256 * @return int week number 207 257 * @access protected … … 213 263 /** 214 264 * Returns the number of weeks in the month 215 * @param int year (2003) 216 * @param int month (9) 217 * @param int first day of the week (default: 1 - monday) 265 * 266 * @param int $y year (2003) 267 * @param int $m month (9) 268 * 218 269 * @return int weeks number 219 270 * @access protected … … 225 276 /** 226 277 * Returns the number of the day of the week (0=sunday, 1=monday...) 227 * @param int year (2003) 228 * @param int month (9) 229 * @param int day (4) 278 * 279 * @param int $y year (2003) 280 * @param int $m month (9) 281 * @param int $d day (4) 282 * 230 283 * @return int weekday number 231 284 * @access protected … … 237 290 /** 238 291 * Returns the numeric values of the days of the week. 239 * @param int year (2003) 240 * @param int month (9) 241 * @param int day (4) 292 * 293 * @param int $y year (2003) 294 * @param int $m month (9) 295 * @param int $d day (4) 296 * 242 297 * @return array list of numeric values of days in week, beginning 0 243 298 * @access protected 244 299 */ 245 function getWeekDays($y= NULL, $m=NULL, $d=NULL)300 function getWeekDays($y=null, $m=null, $d=null) 246 301 { 247 302 } … … 250 305 * Returns the default first day of the week as an integer. Must be a 251 306 * member of the array returned from getWeekDays 252 * @param int year (2003) 253 * @param int month (9) 254 * @param int day (4) 307 * 308 * @param int $y year (2003) 309 * @param int $m month (9) 310 * @param int $d day (4) 311 * 255 312 * @return int (e.g. 1 for Monday) 256 313 * @see getWeekDays 257 314 * @access protected 258 315 */ 259 function getFirstDayOfWeek($y=NULL, $m=NULL, $d=NULL) 260 { 261 } 262 263 /** 264 * Returns the number of hours in a day<br> 265 * @param int (optional) day to get hours for 316 function getFirstDayOfWeek($y=null, $m=null, $d=null) 317 { 318 } 319 320 /** 321 * Returns the number of hours in a day 322 * 323 * @param int $y year (2003) 324 * @param int $m month (9) 325 * @param int $d day (4) 326 * 266 327 * @return int (e.g. 24) 267 328 * @access protected … … 273 334 /** 274 335 * Returns the number of minutes in an hour 275 * @param int (optional) hour to get minutes for 336 * 337 * @param int $y year (2003) 338 * @param int $m month (9) 339 * @param int $d day (4) 340 * @param int $h hour 341 * 276 342 * @return int 277 343 * @access protected … … 283 349 /** 284 350 * Returns the number of seconds in a minutes 285 * @param int (optional) minute to get seconds for 351 * 352 * @param int $y year (2003) 353 * @param int $m month (9) 354 * @param int $d day (4) 355 * @param int $h hour 356 * @param int $i minute 357 * 286 358 * @return int 287 359 * @access protected 288 360 */ 289 361 function getSecondsInMinute($y=null,$m=null,$d=null,$h=null,$i=null) 362 { 363 } 364 365 /** 366 * Checks if the given day is the current day 367 * 368 * @param int timestamp (depending on implementation) 369 * 370 * @return boolean 371 * @access protected 372 */ 373 function isToday($stamp) 290 374 { 291 375 }
Note: See TracChangeset
for help on using the changeset viewer.