Add php support for Timestamp. (#3575)
* Add php support for Timestamp. * Fix commentspull/3583/head
Paul Yang
8 years ago
committed by
GitHub
parent
c7457ef65a
commit
b70e0fdf09
8 changed files with 443 additions and 102 deletions
@ -0,0 +1,31 @@ |
||||
<?php |
||||
# Generated by the protocol buffer compiler. DO NOT EDIT! |
||||
# source: google/protobuf/timestamp.proto |
||||
|
||||
namespace GPBMetadata\Google\Protobuf; |
||||
|
||||
class Timestamp |
||||
{ |
||||
public static $is_initialized = false; |
||||
|
||||
public static function initOnce() { |
||||
$pool = \Google\Protobuf\Internal\DescriptorPool::getGeneratedPool(); |
||||
|
||||
if (static::$is_initialized == true) { |
||||
return; |
||||
} |
||||
$pool->internalAddGeneratedFile(hex2bin( |
||||
"0ae7010a1f676f6f676c652f70726f746f6275662f74696d657374616d70" . |
||||
"2e70726f746f120f676f6f676c652e70726f746f627566222b0a0954696d" . |
||||
"657374616d70120f0a077365636f6e6473180120012803120d0a056e616e" . |
||||
"6f73180220012805427e0a13636f6d2e676f6f676c652e70726f746f6275" . |
||||
"66420e54696d657374616d7050726f746f50015a2b6769746875622e636f" . |
||||
"6d2f676f6c616e672f70726f746f6275662f7074797065732f74696d6573" . |
||||
"74616d70f80101a20203475042aa021e476f6f676c652e50726f746f6275" . |
||||
"662e57656c6c4b6e6f776e5479706573620670726f746f33" |
||||
)); |
||||
|
||||
static::$is_initialized = true; |
||||
} |
||||
} |
||||
|
||||
@ -0,0 +1,184 @@ |
||||
<?php |
||||
# Generated by the protocol buffer compiler. DO NOT EDIT! |
||||
# source: google/protobuf/timestamp.proto |
||||
|
||||
namespace Google\Protobuf; |
||||
|
||||
use Google\Protobuf\Internal\GPBType; |
||||
use Google\Protobuf\Internal\RepeatedField; |
||||
use Google\Protobuf\Internal\GPBUtil; |
||||
|
||||
/** |
||||
* A Timestamp represents a point in time independent of any time zone |
||||
* or calendar, represented as seconds and fractions of seconds at |
||||
* nanosecond resolution in UTC Epoch time. It is encoded using the |
||||
* Proleptic Gregorian Calendar which extends the Gregorian calendar |
||||
* backwards to year one. It is encoded assuming all minutes are 60 |
||||
* seconds long, i.e. leap seconds are "smeared" so that no leap second |
||||
* table is needed for interpretation. Range is from |
||||
* 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. |
||||
* By restricting to that range, we ensure that we can convert to |
||||
* and from RFC 3339 date strings. |
||||
* See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). |
||||
* # Examples |
||||
* Example 1: Compute Timestamp from POSIX `time()`. |
||||
* Timestamp timestamp; |
||||
* timestamp.set_seconds(time(NULL)); |
||||
* timestamp.set_nanos(0); |
||||
* Example 2: Compute Timestamp from POSIX `gettimeofday()`. |
||||
* struct timeval tv; |
||||
* gettimeofday(&tv, NULL); |
||||
* Timestamp timestamp; |
||||
* timestamp.set_seconds(tv.tv_sec); |
||||
* timestamp.set_nanos(tv.tv_usec * 1000); |
||||
* Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. |
||||
* FILETIME ft; |
||||
* GetSystemTimeAsFileTime(&ft); |
||||
* UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; |
||||
* // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z |
||||
* // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. |
||||
* Timestamp timestamp; |
||||
* timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); |
||||
* timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); |
||||
* Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. |
||||
* long millis = System.currentTimeMillis(); |
||||
* Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) |
||||
* .setNanos((int) ((millis % 1000) * 1000000)).build(); |
||||
* Example 5: Compute Timestamp from current time in Python. |
||||
* timestamp = Timestamp() |
||||
* timestamp.GetCurrentTime() |
||||
* # JSON Mapping |
||||
* In JSON format, the Timestamp type is encoded as a string in the |
||||
* [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the |
||||
* format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" |
||||
* where {year} is always expressed using four digits while {month}, {day}, |
||||
* {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional |
||||
* seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), |
||||
* are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone |
||||
* is required, though only UTC (as indicated by "Z") is presently supported. |
||||
* For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past |
||||
* 01:30 UTC on January 15, 2017. |
||||
* In JavaScript, one can convert a Date object to this format using the |
||||
* standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString] |
||||
* method. In Python, a standard `datetime.datetime` object can be converted |
||||
* to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) |
||||
* with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one |
||||
* can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( |
||||
* http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()) |
||||
* to obtain a formatter capable of generating timestamps in this format. |
||||
* |
||||
* Generated from protobuf message <code>google.protobuf.Timestamp</code> |
||||
*/ |
||||
class Timestamp extends \Google\Protobuf\Internal\Message |
||||
{ |
||||
/** |
||||
* Represents seconds of UTC time since Unix epoch |
||||
* 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
||||
* 9999-12-31T23:59:59Z inclusive. |
||||
* |
||||
* Generated from protobuf field <code>int64 seconds = 1;</code> |
||||
*/ |
||||
private $seconds = 0; |
||||
/** |
||||
* Non-negative fractions of a second at nanosecond resolution. Negative |
||||
* second values with fractions must still have non-negative nanos values |
||||
* that count forward in time. Must be from 0 to 999,999,999 |
||||
* inclusive. |
||||
* |
||||
* Generated from protobuf field <code>int32 nanos = 2;</code> |
||||
*/ |
||||
private $nanos = 0; |
||||
|
||||
public function __construct() { |
||||
\GPBMetadata\Google\Protobuf\Timestamp::initOnce(); |
||||
parent::__construct(); |
||||
} |
||||
|
||||
/** |
||||
* Represents seconds of UTC time since Unix epoch |
||||
* 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
||||
* 9999-12-31T23:59:59Z inclusive. |
||||
* |
||||
* Generated from protobuf field <code>int64 seconds = 1;</code> |
||||
* @return int|string |
||||
*/ |
||||
public function getSeconds() |
||||
{ |
||||
return $this->seconds; |
||||
} |
||||
|
||||
/** |
||||
* Represents seconds of UTC time since Unix epoch |
||||
* 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
||||
* 9999-12-31T23:59:59Z inclusive. |
||||
* |
||||
* Generated from protobuf field <code>int64 seconds = 1;</code> |
||||
* @param int|string $var |
||||
* @return $this |
||||
*/ |
||||
public function setSeconds($var) |
||||
{ |
||||
GPBUtil::checkInt64($var); |
||||
$this->seconds = $var; |
||||
|
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Non-negative fractions of a second at nanosecond resolution. Negative |
||||
* second values with fractions must still have non-negative nanos values |
||||
* that count forward in time. Must be from 0 to 999,999,999 |
||||
* inclusive. |
||||
* |
||||
* Generated from protobuf field <code>int32 nanos = 2;</code> |
||||
* @return int |
||||
*/ |
||||
public function getNanos() |
||||
{ |
||||
return $this->nanos; |
||||
} |
||||
|
||||
/** |
||||
* Non-negative fractions of a second at nanosecond resolution. Negative |
||||
* second values with fractions must still have non-negative nanos values |
||||
* that count forward in time. Must be from 0 to 999,999,999 |
||||
* inclusive. |
||||
* |
||||
* Generated from protobuf field <code>int32 nanos = 2;</code> |
||||
* @param int $var |
||||
* @return $this |
||||
*/ |
||||
public function setNanos($var) |
||||
{ |
||||
GPBUtil::checkInt32($var); |
||||
$this->nanos = $var; |
||||
|
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Converts PHP DateTime to Timestamp. |
||||
* |
||||
* @param DateTime $datetime |
||||
*/ |
||||
public function fromDateTime($datetime) |
||||
{ |
||||
if (get_class($datetime) !== \DateTime::class) { |
||||
trigger_error("Given parameter is not a DateTime.", |
||||
E_USER_ERROR); |
||||
} |
||||
$this->seconds = $datetime->format('U'); |
||||
$this->nanos = 0; |
||||
} |
||||
|
||||
/** |
||||
* Converts Timestamp to PHP DateTime. Nano second is ignored. |
||||
* |
||||
* @return DateTime $datetime |
||||
*/ |
||||
public function toDateTime() |
||||
{ |
||||
return \DateTime::createFromFormat('U', $this->seconds); |
||||
} |
||||
} |
||||
|
||||
Loading…
Reference in new issue