1. class
  2. Google
  3. \
  4. Type
  5. \
  6. DateTime

DateTime

class DateTime extends Message

Represents 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 is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. 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

Properties

protected $time_offset

Methods

__construct(array $data = NULL)

Constructor.

int
getYear()

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

$this
setYear(int $var)

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

int
getMonth()

Required. Month of year. Must be from 1 to 12.

$this
setMonth(int $var)

Required. Month of year. Must be from 1 to 12.

int
getDay()

Required. Day of month. Must be from 1 to 31 and valid for the year and month.

$this
setDay(int $var)

Required. Day of month. Must be from 1 to 31 and valid for the year and month.

int
getHours()

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

$this
setHours(int $var)

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

int
getMinutes()

Required. Minutes of hour of day. Must be from 0 to 59.

$this
setMinutes(int $var)

Required. Minutes of hour of day. Must be from 0 to 59.

int
getSeconds()

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

$this
setSeconds(int $var)

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

int
getNanos()

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

$this
setNanos(int $var)

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

Duration
getUtcOffset()

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

$this
setUtcOffset(Duration $var)

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

TimeZone
getTimeZone()

Time zone.

$this
setTimeZone(TimeZone $var)

Time zone.

string
getTimeOffset()

No description

Details

at line 113
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type int $year
      Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a
      datetime without a year.
@type int $month
      Required. Month of year. Must be from 1 to 12.
@type int $day
      Required. Day of month. Must be from 1 to 31 and valid for the year and
      month.
@type int $hours
      Required. Hours of day in 24 hour format. Should be from 0 to 23. An API
      may choose to allow the value "24:00:00" for scenarios like business
      closing time.
@type int $minutes
      Required. Minutes of hour of day. Must be from 0 to 59.
@type int $seconds
      Required. Seconds of minutes of the time. Must normally be from 0 to 59. An
      API may allow the value 60 if it allows leap-seconds.
@type int $nanos
      Required. Fractions of seconds in nanoseconds. Must be from 0 to
      999,999,999.
@type \Google\Protobuf\Duration $utc_offset
      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 }.
@type \Google\Type\TimeZone $time_zone
      Time zone.

}

at line 125
int getYear()

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

Generated from protobuf field int32 year = 1;

Return Value

int

at line 138
$this setYear(int $var)

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

Generated from protobuf field int32 year = 1;

Parameters

int $var

Return Value

$this

at line 152
int getMonth()

Required. Month of year. Must be from 1 to 12.

Generated from protobuf field int32 month = 2;

Return Value

int

at line 164
$this setMonth(int $var)

Required. Month of year. Must be from 1 to 12.

Generated from protobuf field int32 month = 2;

Parameters

int $var

Return Value

$this

at line 179
int getDay()

Required. Day of month. Must be from 1 to 31 and valid for the year and month.

Generated from protobuf field int32 day = 3;

Return Value

int

at line 192
$this setDay(int $var)

Required. Day of month. Must be from 1 to 31 and valid for the year and month.

Generated from protobuf field int32 day = 3;

Parameters

int $var

Return Value

$this

at line 208
int getHours()

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

Generated from protobuf field int32 hours = 4;

Return Value

int

at line 222
$this setHours(int $var)

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

Generated from protobuf field int32 hours = 4;

Parameters

int $var

Return Value

$this

at line 236
int getMinutes()

Required. Minutes of hour of day. Must be from 0 to 59.

Generated from protobuf field int32 minutes = 5;

Return Value

int

at line 248
$this setMinutes(int $var)

Required. Minutes of hour of day. Must be from 0 to 59.

Generated from protobuf field int32 minutes = 5;

Parameters

int $var

Return Value

$this

at line 263
int getSeconds()

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

Generated from protobuf field int32 seconds = 6;

Return Value

int

at line 276
$this setSeconds(int $var)

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

Generated from protobuf field int32 seconds = 6;

Parameters

int $var

Return Value

$this

at line 291
int getNanos()

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

Generated from protobuf field int32 nanos = 7;

Return Value

int

at line 304
$this setNanos(int $var)

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

Generated from protobuf field int32 nanos = 7;

Parameters

int $var

Return Value

$this

at line 320
Duration 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 }.

Generated from protobuf field .google.protobuf.Duration utc_offset = 8;

Return Value

Duration

at line 334
$this setUtcOffset(Duration $var)

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 }.

Generated from protobuf field .google.protobuf.Duration utc_offset = 8;

Parameters

Duration $var

Return Value

$this

at line 348
TimeZone getTimeZone()

Time zone.

Generated from protobuf field .google.type.TimeZone time_zone = 9;

Return Value

TimeZone

at line 360
$this setTimeZone(TimeZone $var)

Time zone.

Generated from protobuf field .google.type.TimeZone time_zone = 9;

Parameters

TimeZone $var

Return Value

$this

at line 371
string getTimeOffset()

Return Value

string