PHP strtotime函数用法、实现原理和源码分析

源码位置：\ext\date\php_date.c

/* {{{ proto int strtotime(string time [, int now ])
   convert string representation of date and time to a timestamp */
php_function(strtotime)
{
    char *times, *initial_ts;
    int   time_len, error1, error2;
    struct timelib_error_container *error;
    long  preset_ts = 0, ts;

    timelib_time *t, *now;
    timelib_tzinfo *tzi;

    tzi = get_timezone_info(tsrmls_c);

    if (zend_parse_parameters_ex(zend_parse_params_quiet, zend_num_args() tsrmls_cc, “sl”, &times, &time_len, &preset_ts) != failure) {
        /* we have an initial timestamp */
        now = timelib_time_ctor();

        initial_ts = emalloc(25);
        snprintf(initial_ts, 24, utc”, preset_ts);
        t = timelib_strtotime(initial_ts, strlen(initial_ts), null, date_timezonedb, php_date_parse_tzfile_wrapper); /* we ignore the error here, as this should never fail */
        timelib_update_ts(t, tzi);
        now->tz_info = tzi;
        now->zone_type = timelib_zonetype_id;
        timelib_unixtime2local(now, t->sse);
        timelib_time_dtor(t);
        efree(initial_ts);
    } else if (zend_parse_parameters(zend_num_args() tsrmls_cc, “s|l”, &times, &time_len, &preset_ts) != failure) {
        /* we have no initial timestamp */
        now = timelib_time_ctor();
        now->tz_info = tzi;
        now->zone_type = timelib_zonetype_id;
        timelib_unixtime2local(now, (timelib_sll) time(null));
    } else {
        return_false;
    }

    if (!time_len) {
        timelib_time_dtor(now);   
        return_false;
    }

    t = timelib_strtotime(times, time_len, &error, date_timezonedb, php_date_parse_tzfile_wrapper);
    error1 = error->error_count;
    timelib_error_container_dtor(error);
    timelib_fill_holes(t, now, timelib_no_clone);
    timelib_update_ts(t, tzi);
    ts = timelib_date_to_int(t, &error2);

    timelib_time_dtor(now);
    timelib_time_dtor(t);

    if (error1 || error2) {
        return_false;
    } else {
        return_long(ts);
    }
}
/* }}} */

strtotime函数在使用strtotime(“-1 month”)求上一个月的今天时会出一些状况，

因此也引出写这篇文章，本文包括如下内容：

1).strtotime函数的一些用法
2).strtotime函数的实现基本原理
3).strtotime(“-1 month”)求值失败的原因

strtotime函数的一些用法

1、 strtotime(“jan”)和strtotime(“january”)

这两个用法的效果是一样的，都是返回指定月份的今天，如果指定月份没有今天，则顺延到下一个月。 如在2011-03-31计算二月，代码:

echo date("y-m-d h:i:s", strtotime("feb", strtotime("2011-03-31")));

程序会输出: 2011-03-03 00:00:00。 从表象来看，这个结果也许不一定是我们想要的，但是这也算是一种解决方案，这种方案是由什么决定的呢？ strtotime函数在执行月份的计算时只计算了月份，相当于直接将月份设置为指定的月份的值，而如jan，january都会有一个对应内部数值。

2、 first关键字

first是一个辅助型的关键字，它可以与星期，天等可以指定确认值的关键字组合使用，如求2011年的第一个星期天：

echo date("y-m-d h:i:s", strtotime("second sunday", strtotime("2011-01-01"))), "<br />";

在php的源码中，对于first与星期和天的组合使用是分开的，即first day对应一个处理操作， 在最终的c实现中，天的值指定为1，即time结构中的d字段指定为1，如下代码：

switch (time->relative.first_last_day_of) {
    case 1: /* first */
        time->d = 1;
        break;
    case 2: /* last */
        time->d = 0;
        time->m++;
        break;
}

3、previous和next关键字

与first类似，previous关键字可以与星期，天组合使用，表示指定时间的前一个星期几或前一天。如下所示代码：

echo date("y-m-d h:i:s", strtotime("previous sunday", strtotime("2011-02-01"))), "<br />";

程序会输出：2011-01-30 00:00:00
程序求2011-02-01的前一个星期天。

next关键字与previous相反，它表示下一个星期几或后一天。

4、 last关键字

last关键字既可以作为上一个，也可以作为最后一个。如求上一个星期天的日期：

echo date("y-m-d h:i:s", strtotime("last sunday", strtotime("2011-02-05"))), "<br />";

程序会输出： 2011-01-30 00:00:00

当程序作为最后时，其应用场景是指定日期所在月的最后一天，相当于date(“t”)的结果。如求2000年2月的最后一天：

echo date("y-m-d h:i:s", strtotime("last day", strtotime("2000-02-01"))), "<br />";

first、previous、last和this关键字在re文件中属于同一组。

5、 back和front关键字

这两个关键字是对一天中的小时的向前和向后操作，其调用格式如下：

echo date("y-m-d h:i:s", strtotime("back of 24", strtotime("2011-02-01"))), "<br />";
echo date("y-m-d h:i:s", strtotime("front of 24", strtotime("2011-02-01"))), "<br />";

back表示将时间设置指定小时值的后一个小时的15分的位置。如果是24点，则算到第二天的0点15分。
front表示将时间设置指定小时值的前一个小时的45分的位置。如果是0点，则算前一天的23点45分。
上面的代码输出：2011-02-02 00:15:00 2011-02-01 23:45:00。 其中back of和front of后接的数组必须大于等于0并且小于等于24。

strtotime函数的实现基本原理
官方文档对于strtotime函数的说明是这样的：本函数预期接受一个包含美国英语日期格式的字符串并尝试将其解析为 unix 时间戳 （自 january 1 1970 00:00:00 gmt 起的秒数），其值相对于 now 参数给出的时间，如果没有提供此参数则用系统当前时间。

这是一个标准php内置函数，从php4起就已经存在。strtotime函数是以一个扩展的方式加载进来的，在ext/date目录下有其全部实现。 作为一个标准的内置函数，其定义格式也是标准的，如下：

php_function(strtotime)
    //  处理输入，对于是否有第二个参数有没的处理

    //  调用相关函数，实现字符串的解析和结果计算

    //  返回结果
}

在输入处理中，先识别两个参数都存在的情况并进行处理，如果不是此种状态，则处理第二个参数不存在的情况， 如果都没有，则报错，返回false。

strtotime函数的第一个参数是一个字符串，对于这个字符串，由于其复杂性，php使用了其词法解析一样的工具：re2c。在/ext/date/lib目录下，从parse_date.re文件我们可以看到其原始的re文件。 当用户以参数的形式传入一个字符串，此字符串将交给此程序处理，针对其字符串的不同，匹配不同的处理函数。 如strtotime(“yesterday”)调用，分析字符串时，将匹配yesterday字符串，此字符串对应函数如下：

'yesterday'
{
    debug_output("yesterday");
    timelib_init;
    timelib_have_relative();
    timelib_unhave_time();

    s->time->relative.d = -1;
    timelib_deinit;
    return timelib_relative;
}

这里有几个关键的结构体：

typedef struct scanner {
    int           fd;
    uchar        *lim, *str, *ptr, *cur, *tok, *pos;
    unsigned int  line, len;
    struct timelib_error_container *errors;

    struct timelib_time *time;
    const timelib_tzdb  *tzdb;
} scanner;

typedef struct timelib_time {
    timelib_sll      y, m, d;     /* year, month, day */
    timelib_sll      h, i, s;     /* hour, minute, second */
    double           f;           /* fraction */
    int              z;           /* gmt offset in minutes */
    char            *tz_abbr;     /* timezone abbreviation (display only) */
    timelib_tzinfo  *tz_info;     /* timezone structure */
    signed int       dst;         /* flag if we were parsing a dst zone */
    timelib_rel_time relative;

    timelib_sll      sse;         /* seconds since epoch */

    unsigned int   have_time, have_date, have_zone, have_relative, have_weeknr_day;

    unsigned int   sse_uptodate; /* !0 if the sse member is up to date with the date/time members */
    unsigned int   tim_uptodate; /* !0 if the date/time members are up to date with the sse member */
    unsigned int   is_localtime; /*  1 if the current struct represents localtime, 0 if it is in gmt */
    unsigned int   zone_type;    /*  1 time offset,
                                  *  3 timezone identifier,
                                  *  2 timezone abbreviation */
} timelib_time;

typedef struct timelib_rel_time {
    timelib_sll y, m, d; /* years, months and days */
    timelib_sll h, i, s; /* hours, minutes and seconds */

    int weekday; /* stores the day in 'next monday' */
    int weekday_behavior; /* 0: the current day should *not* be counted when advancing forwards; 1: the current day *should* be counted */

    int first_last_day_of;
    int invert; /* whether the difference should be inverted */
    timelib_sll days; /* contains the number of *days*, instead of y-m-d differences */

    timelib_special  special;
    unsigned int   have_weekday_relative, have_special_relative;
} timelib_rel_time;

s->time->relative.d = -1;所表示的意思是当前时间的相对天数是-1。 这只是中间词法解析的中间结果，但是最后结果是通过这些中间结果计算出来的。

strtotime(“-1 month”)求值失败的原因

虽然strtotime(“-1 month”)这种方法对于后一个月比前一个月的天数的情况会求值失败，但是从其本质上来说，这并没有错。 php这样实现也无可厚非。只是我们的需求决定了我们不能使用这种方法，因此我们称其为求值失败。

我们来看它的实现过程，由于没有第二个参数，所以程序使用默认的当前时间。 第一个参数传入的是-1 month字符串，这个字符串所对应的re文件中的正则为：

reltextunit = (('sec'|'second'|'min'|'minute'|'hour'|'day'|'fortnight'|'forthnight'|'month'|'year') 's'?) | 'weeks' | daytext;

relnumber = ([+-]*[ \t]*[0-9]+);
relative = relnumber space? (reltextunit | 'week' );

最终relative会对应一系列操作，程序会识别出前面的-1 和后面的month字符串，month对应一种操作类型：timelib_month。 在此之后，根据识别出来的数字和操作类型执行操作，如下代码：

case timelib_month:  s->time->relative.m += amount * relunit->multiplier; break;

如上代码，则是直接记录月份的相对值减一。 但是对于类似于3月31号这样的情况，2月没有31号，程序会自动将日期计算到下一个月。