Ignore:
Timestamp:
2013/08/28 13:55:43 (7 years ago)
Author:
m_uehara
Message:

#2348 r23140 をマージ

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/version-2_13_0/data/module/Calendar/Engine/Interface.php

    r23126 r23143  
    11<?php 
    22/* vim: set expandtab tabstop=4 shiftwidth=4: */ 
    3  
     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// 
    422/** 
    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 
     23 * @package Calendar 
     24 * @version $Id: Interface.php,v 1.5 2004/08/16 12:29:18 hfuecks Exp $ 
    3825 */ 
    39  
    4026/** 
    4127 * The methods the classes implementing the Calendar_Engine must implement. 
    4228 * Note this class is not used but simply to help development 
    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 
     29 * @package Calendar 
    5130 * @access protected 
    5231 */ 
     
    5837     * Typically called "internally" by methods like stampToYear. 
    5938     * Return value can vary, depending on the specific implementation 
    60      * 
    61      * @param int $stamp timestamp (depending on implementation) 
    62      * 
     39     * @param int timestamp (depending on implementation) 
    6340     * @return mixed 
    6441     * @access protected 
     
    7047    /** 
    7148     * Returns a numeric year given a timestamp 
    72      * 
    73      * @param int $stamp timestamp (depending on implementation) 
    74      * 
     49     * @param int timestamp (depending on implementation) 
    7550     * @return int year (e.g. 2003) 
    7651     * @access protected 
     
    8257    /** 
    8358     * Returns a numeric month given a timestamp 
    84      * 
    85      * @param int $stamp timestamp (depending on implementation) 
    86      * 
     59     * @param int timestamp (depending on implementation) 
    8760     * @return int month (e.g. 9) 
    8861     * @access protected 
     
    9467    /** 
    9568     * Returns a numeric day given a timestamp 
    96      * 
    97      * @param int $stamp timestamp (depending on implementation) 
    98      * 
     69     * @param int timestamp (depending on implementation) 
    9970     * @return int day (e.g. 15) 
    10071     * @access protected 
     
    10677    /** 
    10778     * Returns a numeric hour given a timestamp 
    108      * 
    109      * @param int $stamp timestamp (depending on implementation) 
    110      * 
     79     * @param int timestamp (depending on implementation) 
    11180     * @return int hour (e.g. 13) 
    11281     * @access protected 
     
    11887    /** 
    11988     * Returns a numeric minute given a timestamp 
    120      * 
    121      * @param int $stamp timestamp (depending on implementation) 
    122      * 
     89     * @param int timestamp (depending on implementation) 
    12390     * @return int minute (e.g. 34) 
    12491     * @access protected 
     
    13097    /** 
    13198     * Returns a numeric second given a timestamp 
    132      * 
    133      * @param int $stamp timestamp (depending on implementation) 
    134      * 
     99     * @param int timestamp (depending on implementation) 
    135100     * @return int second (e.g. 51) 
    136101     * @access protected 
     
    141106 
    142107    /** 
    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      * 
     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) 
    154118     * @return int (depends on implementation) 
    155119     * @access protected 
    156120     */ 
    157     function dateToStamp($y, $m, $d, $h, $i, $s) 
     121    function dateToStamp($y,$m,$d,$h,$i,$s) 
    158122    { 
    159123    } 
     
    161125    /** 
    162126     * The upper limit on years that the Calendar Engine can work with 
    163      * 
    164127     * @return int (e.g. 2037) 
    165128     * @access protected 
     
    171134    /** 
    172135     * The lower limit on years that the Calendar Engine can work with 
    173      * 
    174136     * @return int (e.g 1902) 
    175137     * @access protected 
     
    181143    /** 
    182144     * Returns the number of months in a year 
    183      * 
    184      * @param int $y (optional) year to get months for 
    185      * 
     145     * @param int (optional) year to get months for 
    186146     * @return int (e.g. 12) 
    187147     * @access protected 
     
    193153    /** 
    194154     * Returns the number of days in a month, given year and month 
    195      * 
    196      * @param int $y year (e.g. 2003) 
    197      * @param int $m month (e.g. 9) 
    198      * 
     155     * @param int year (e.g. 2003) 
     156     * @param int month (e.g. 9) 
    199157     * @return int days in month 
    200158     * @access protected 
     
    207165     * Returns numeric representation of the day of the week in a month, 
    208166     * given year and month 
    209      * 
    210      * @param int $y year (e.g. 2003) 
    211      * @param int $m month (e.g. 9) 
    212      * 
     167     * @param int year (e.g. 2003) 
     168     * @param int month (e.g. 9) 
    213169     * @return int 
    214170     * @access protected 
     
    220176    /** 
    221177     * Returns the number of days in a week 
    222      * 
    223      * @param int $y year (2003) 
    224      * @param int $m month (9) 
    225      * @param int $d day (4) 
    226      * 
     178     * @param int year (2003) 
     179     * @param int month (9) 
     180     * @param int day (4) 
    227181     * @return int (e.g. 7) 
    228182     * @access protected 
    229183     */ 
    230     function getDaysInWeek($y=null, $m=null, $d=null) 
     184    function getDaysInWeek($y=NULL, $m=NULL, $d=NULL) 
    231185    { 
    232186    } 
     
    234188    /** 
    235189     * Returns the number of the week in the year (ISO-8601), given a date 
    236      * 
    237      * @param int $y year (2003) 
    238      * @param int $m month (9) 
    239      * @param int $d day (4) 
    240      * 
     190     * @param int year (2003) 
     191     * @param int month (9) 
     192     * @param int day (4) 
    241193     * @return int week number 
    242194     * @access protected 
     
    248200    /** 
    249201     * Returns the number of the week in the month, given a date 
    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      * 
     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) 
    256206     * @return int week number 
    257207     * @access protected 
     
    263213    /** 
    264214     * Returns the number of weeks in the month 
    265      * 
    266      * @param int $y year (2003) 
    267      * @param int $m month (9) 
    268      * 
     215     * @param int year (2003) 
     216     * @param int month (9) 
     217     * @param int first day of the week (default: 1 - monday) 
    269218     * @return int weeks number 
    270219     * @access protected 
     
    276225    /** 
    277226     * Returns the number of the day of the week (0=sunday, 1=monday...) 
    278      * 
    279      * @param int $y year (2003) 
    280      * @param int $m month (9) 
    281      * @param int $d day (4) 
    282      * 
     227     * @param int year (2003) 
     228     * @param int month (9) 
     229     * @param int day (4) 
    283230     * @return int weekday number 
    284231     * @access protected 
     
    290237    /** 
    291238     * Returns the numeric values of the days of the week. 
    292      * 
    293      * @param int $y year (2003) 
    294      * @param int $m month (9) 
    295      * @param int $d day (4) 
    296      * 
     239     * @param int year (2003) 
     240     * @param int month (9) 
     241     * @param int day (4) 
    297242     * @return array list of numeric values of days in week, beginning 0 
    298243     * @access protected 
    299244     */ 
    300     function getWeekDays($y=null, $m=null, $d=null) 
     245    function getWeekDays($y=NULL, $m=NULL, $d=NULL) 
    301246    { 
    302247    } 
     
    305250     * Returns the default first day of the week as an integer. Must be a 
    306251     * member of the array returned from getWeekDays 
    307      * 
    308      * @param int $y year (2003) 
    309      * @param int $m month (9) 
    310      * @param int $d day (4) 
    311      * 
     252     * @param int year (2003) 
     253     * @param int month (9) 
     254     * @param int day (4) 
    312255     * @return int (e.g. 1 for Monday) 
    313256     * @see getWeekDays 
    314257     * @access protected 
    315258     */ 
    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      * 
     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 
    327266     * @return int (e.g. 24) 
    328267     * @access protected 
     
    334273    /** 
    335274     * Returns the number of minutes in an hour 
    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      * 
     275     * @param int (optional) hour to get minutes for 
    342276     * @return int 
    343277     * @access protected 
     
    349283    /** 
    350284     * Returns the number of seconds in a minutes 
    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      * 
     285     * @param int (optional) minute to get seconds for 
    358286     * @return int 
    359287     * @access protected 
    360288     */ 
    361289    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) 
    374290    { 
    375291    } 
Note: See TracChangeset for help on using the changeset viewer.