Google API Common Protos Client - Class DateTime (4.13.0)

Reference documentation and code samples for the Google API Common Protos Client class DateTime.

Represents civil time (or occasionally physical time).

This type can represent a civil time in one of a few possible ways:

  • When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC.
  • When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone.
  • When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset oneof is set. Consider using Timestamp message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.

Generated from protobuf message google.type.DateTime

Namespace

Google \ Type

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ year int

Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
↳ month int

Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
↳ day int

Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
↳ hours int

Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
↳ minutes int

Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
↳ seconds int

Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
↳ nanos int

Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
↳ utc_offset Google\Protobuf\Duration

UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
↳ time_zone TimeZone

Time zone.

getYear

Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

Returns
Type Description
int

setYear

Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

Parameter
Name Description
var int
Returns
Type Description
$this

getMonth

Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.

Returns
Type Description
int

setMonth

Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.

Parameter
Name Description
var int
Returns
Type Description
$this

getDay

Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.

Returns
Type Description
int

setDay

Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.

Parameter
Name Description
var int
Returns
Type Description
$this

getHours

Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.

Returns
Type Description
int

setHours

Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.

Parameter
Name Description
var int
Returns
Type Description
$this

getMinutes

Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.

Returns
Type Description
int

setMinutes

Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.

Parameter
Name Description
var int
Returns
Type Description
$this

getSeconds

Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.

Returns
Type Description
int

setSeconds

Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.

Parameter
Name Description
var int
Returns
Type Description
$this

getNanos

Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.

Returns
Type Description
int

setNanos

Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.

Parameter
Name Description
var int
Returns
Type Description
$this

getUtcOffset

UTC offset. Must be whole seconds, between -18 hours and +18 hours.

For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.

Returns
Type Description
Google\Protobuf\Duration|null

hasUtcOffset

setUtcOffset

UTC offset. Must be whole seconds, between -18 hours and +18 hours.

For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getTimeZone

Time zone.

Returns
Type Description
TimeZone|null

hasTimeZone

setTimeZone

Time zone.

Parameter
Name Description
var TimeZone
Returns
Type Description
$this

getTimeOffset

Returns
Type Description
string