CDateTimeParser

Package	system.utils
Inheritance	class CDateTimeParser
Since	1.0
Version	$Id$
Source Code	framework/utils/CDateTimeParser.php

CDateTimeParser converts a date/time string to a UNIX timestamp according to the specified pattern.

The following pattern characters are recognized:

Pattern |      Description
----------------------------------------------------
d       | Day of month 1 to 31, no padding
dd      | Day of month 01 to 31, zero leading
M       | Month digit 1 to 12, no padding
MM      | Month digit 01 to 12, zero leading
yy      | 2 year digit, e.g., 96, 05
yyyy    | 4 year digit, e.g., 2005
h       | Hour in 0 to 23, no padding (since version 1.0.5)
hh      | Hour in 00 to 23, zero leading (since version 1.0.5)
H       | Hour in 0 to 23, no padding (since version 1.0.9)
HH      | Hour in 00 to 23, zero leading (since version 1.0.9)
m       | Minutes in 0 to 59, no padding (since version 1.0.5)
mm      | Minutes in 00 to 59, zero leading (since version 1.0.5)
s	   | Seconds in 0 to 59, no padding (since version 1.0.5)
ss      | Seconds in 00 to 59, zero leading (since version 1.0.5)
----------------------------------------------------

All other characters must appear in the date string at the corresponding positions.

For example, to parse a date string '21/10/2008', use the following:

$timestamp=CDateTimeParser::parse('21/10/2008','dd/MM/yyyy');

To format a timestamp to a date string, please use CDateFormatter.

Public Methods

Hide inherited methods

Method	Description	Defined By
parse()	Converts a date string to a timestamp.	CDateTimeParser

Protected Methods

Hide inherited methods

Method	Description	Defined By
parseInteger()		CDateTimeParser

Method Details

parse() method

public static integer parse(string $value, string $pattern='MM/dd/yyyy')
$value	string	the date string to be parsed
$pattern	string	the pattern that the date string is following
{return}	integer	timestamp for the date string. False if parsing fails.

Source Code: framework/utils/CDateTimeParser.php#59 (show)


public static function parse($value,$pattern='MM/dd/yyyy')
{
    $tokens=self::tokenize($pattern);
    $i=0;
    $n=strlen($value);
    foreach($tokens as $token)
    {
        switch($token)
        {
            case 'yyyy':
            {
                if(($year=self::parseInteger($value,$i,4,4))===false)
                    return false;
                $i+=4;
                break;
            }
            case 'yy':
            {
                if(($year=self::parseInteger($value,$i,1,2))===false)
                    return false;
                $i+=strlen($year);
                break;
            }
            case 'MM':
            {
                if(($month=self::parseInteger($value,$i,2,2))===false)
                    return false;
                $i+=2;
                break;
            }
            case 'M':
            {
                if(($month=self::parseInteger($value,$i,1,2))===false)
                    return false;
                $i+=strlen($month);
                break;
            }
            case 'dd':
            {
                if(($day=self::parseInteger($value,$i,2,2))===false)
                    return false;
                $i+=2;
                break;
            }
            case 'd':
            {
                if(($day=self::parseInteger($value,$i,1,2))===false)
                    return false;
                $i+=strlen($day);
                break;
            }
            case 'h':
            case 'H':
            {
                if(($hour=self::parseInteger($value,$i,1,2))===false)
                    return false;
                $i+=strlen($hour);
                break;
            }
            case 'hh':
            case 'HH':
            {
                if(($hour=self::parseInteger($value,$i,2,2))===false)
                    return false;
                $i+=2;
                break;
            }
            case 'm':
            {
                if(($minute=self::parseInteger($value,$i,1,2))===false)
                    return false;
                $i+=strlen($minute);
                break;
            }
            case 'mm':
            {
                if(($minute=self::parseInteger($value,$i,2,2))===false)
                    return false;
                $i+=2;
                break;
            }
            case 's':
            {
                if(($second=self::parseInteger($value,$i,1,2))===false)
                    return false;
                $i+=strlen($second);
                break;
            }
            case 'ss':
            {
                if(($second=self::parseInteger($value,$i,2,2))===false)
                    return false;
                $i+=2;
                break;
            }
            default:
            {
                $tn=strlen($token);
                if($i>=$n || substr($value,$i,$tn)!==$token)
                    return false;
                $i+=$tn;
                break;
            }
        }
    }
    if($i<$n)
        return false;

    if(!isset($year))
        $year=date('Y');
    if(!isset($month))
        $month=date('n');
    if(!isset($day))
        $day=date('j');

    if(strlen($year)===2)
    {
        if($year>70)
            $year+=1900;
        else
            $year+=2000;
    }
    $year=(int)$year;
    $month=(int)$month;
    $day=(int)$day;

    if(!isset($hour) && !isset($minute) && !isset($second))
        $hour=$minute=$second=0;
    else
    {
        if(!isset($hour))
            $hour=date('H');
        if(!isset($minute))
            $minute=date('i');
        if(!isset($second))
            $second=date('s');
        $hour=(int)$hour;
        $minute=(int)$minute;
        $second=(int)$second;
    }

    if(CTimestamp::isValidDate($year,$month,$day) && CTimestamp::isValidTime($hour,$minute,$second))
        return CTimestamp::getTimestamp($hour,$minute,$second,$month,$day,$year);
    else
        return false;
}

Converts a date string to a timestamp.

parseInteger() method

protected static void parseInteger($value, $offset, $minLength, $maxLength)
$value
$offset
$minLength
$maxLength

Source Code: framework/utils/CDateTimeParser.php#224 (show)


protected static function parseInteger($value,$offset,$minLength,$maxLength)
{
    for($len=$maxLength;$len>=$minLength;--$len)
    {
        $v=substr($value,$offset,$len);
        if(ctype_digit($v))
            return $v;
    }
    return false;
}

User Contributed Notes