carbon/display.go
2021-07-31 13:28:08 +08:00

602 lines
15 KiB
Go
Executable File
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

package carbon
import (
"bytes"
"strconv"
"strings"
"time"
)
// ToTimestamp output a timestamp with second, it is short for ToTimestampWithSecond
// 输出秒级时间戳, 是 ToTimestampWithSecond 的简写
func (c Carbon) ToTimestamp() int64 {
if c.IsInvalid() {
return 0
}
return c.ToTimestampWithSecond()
}
// ToTimestampWithSecond output a timestamp with second
// 输出秒级时间戳
func (c Carbon) ToTimestampWithSecond() int64 {
if c.IsInvalid() {
return 0
}
return c.Time.In(c.Loc).Unix()
}
// ToTimestampWithMillisecond output a timestamp with millisecond
// 输出毫秒级时间戳
func (c Carbon) ToTimestampWithMillisecond() int64 {
if c.IsInvalid() {
return 0
}
return c.Time.UnixNano() / int64(time.Millisecond)
}
// ToTimestampWithMicrosecond output a timestamp with microsecond
// 输出微秒级时间戳
func (c Carbon) ToTimestampWithMicrosecond() int64 {
if c.IsInvalid() {
return 0
}
return c.Time.UnixNano() / int64(time.Microsecond)
}
// ToTimestampWithNanosecond output a timestamp with nanosecond
// 输出纳秒级时间戳
func (c Carbon) ToTimestampWithNanosecond() int64 {
if c.IsInvalid() {
return 0
}
return c.Time.UnixNano()
}
// String implement Stringer interface
// 实现 Stringer 接口
func (c Carbon) String() string {
if c.IsInvalid() {
return ""
}
return c.ToDateTimeString()
}
// ToString output a string in "2006-01-02 15:04:05.999999999 -0700 MST" format
// 输出"2006-01-02 15:04:05.999999999 -0700 MST"格式字符串
func (c Carbon) ToString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) == 1 {
loc, err := getLocationByTimezone(timezone[0])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).String()
}
// ToMonthString output a string in month format, i18n is supported
// 输出完整月份字符串支持i18n
func (c Carbon) ToMonthString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) == 1 {
loc, err := getLocationByTimezone(timezone[0])
c.Loc = loc
c.Error = err
}
if len(c.Lang.resources) == 0 {
c.Lang.SetLocale(defaultLocale)
}
if months, ok := c.Lang.resources["months"]; ok {
slice := strings.Split(months, "|")
return slice[c.Month()-1]
}
return ""
}
// ToShortMonthString output a string in short month format, i18n is supported
// 输出缩写月份字符串支持i18n
func (c Carbon) ToShortMonthString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) == 1 {
loc, err := getLocationByTimezone(timezone[0])
c.Loc = loc
c.Error = err
}
if len(c.Lang.resources) == 0 {
c.Lang.SetLocale(defaultLocale)
}
if months, ok := c.Lang.resources["months_short"]; ok {
slice := strings.Split(months, "|")
return slice[c.Month()-1]
}
return ""
}
// ToWeekString output a string in week format, i18n is supported
// 输出完整星期字符串支持i18n
func (c Carbon) ToWeekString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) == 1 {
loc, err := getLocationByTimezone(timezone[0])
c.Loc = loc
c.Error = err
}
if len(c.Lang.resources) == 0 {
c.Lang.SetLocale(defaultLocale)
}
if months, ok := c.Lang.resources["weeks"]; ok {
slice := strings.Split(months, "|")
return slice[c.Week()]
}
return ""
}
// ToShortWeekString output a string in short week format, i18n is supported
// 输出缩写星期字符串支持i18n
func (c Carbon) ToShortWeekString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) == 1 {
loc, err := getLocationByTimezone(timezone[0])
c.Loc = loc
c.Error = err
}
if len(c.Lang.resources) == 0 {
c.Lang.SetLocale(defaultLocale)
}
if months, ok := c.Lang.resources["weeks_short"]; ok {
slice := strings.Split(months, "|")
return slice[c.Week()]
}
return ""
}
// ToDayDateTimeString output a string in day, date and time format
// 输出天数日期时间字符串
func (c Carbon) ToDayDateTimeString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) == 1 {
loc, err := getLocationByTimezone(timezone[0])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(DayDateTimeFormat)
}
// ToDateTimeString output a string in date and time format
// 输出日期时间字符串
func (c Carbon) ToDateTimeString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(DateTimeFormat)
}
// ToShortDateTimeString output a string in short date and time format
// 输出简写日期时间字符串
func (c Carbon) ToShortDateTimeString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(ShortDateTimeFormat)
}
// ToDateString output a string in date format
// 输出日期字符串
func (c Carbon) ToDateString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(DateFormat)
}
// ToShortDateString output a string in short date format
// 输出简写日期字符串
func (c Carbon) ToShortDateString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(ShortDateFormat)
}
// ToTimeString output a string in time format
// 输出时间字符串
func (c Carbon) ToTimeString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(TimeFormat)
}
// ToShortTimeString output a string in short time format
// 输出简写时间字符串
func (c Carbon) ToShortTimeString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(ShortTimeFormat)
}
// ToAtomString output a string in ATOM format
// 输出 ATOM 格式字符串
func (c Carbon) ToAtomString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
return c.ToRfc3339String(timezone...)
}
// ToAnsicString output a string in ANSIC format
// 输出 ANSIC 格式字符串
func (c Carbon) ToAnsicString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(AnsicFormat)
}
// ToCookieString output a string in COOKIE format
// 输出 COOKIE 格式字符串
func (c Carbon) ToCookieString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(CookieFormat)
}
// ToRssString output a string in RSS format
// 输出 RSS 格式字符串
func (c Carbon) ToRssString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(RssFormat)
}
// ToW3cString output a string in W3C format
// 输出 W3C 格式字符串
func (c Carbon) ToW3cString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
return c.ToRfc3339String(timezone...)
}
// ToUnixDateString output a string in unix date format
// 输出 UnixDate 格式字符串
func (c Carbon) ToUnixDateString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(UnixDateFormat)
}
// ToRubyDateString output a string in ruby date format
// 输出 RubyDate 格式字符串
func (c Carbon) ToRubyDateString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(RubyDateFormat)
}
// ToKitchenString output a string in KITCHEN format
// 输出 KITCHEN 格式字符串
func (c Carbon) ToKitchenString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(KitchenFormat)
}
// ToIso8601String output a string in ISO8601 format
// 输出 ISO8601 格式字符串
func (c Carbon) ToIso8601String(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(Iso8601Format)
}
// ToRfc822String output a string in RFC822 format
// 输出 RFC822 格式字符串
func (c Carbon) ToRfc822String(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(RFC822Format)
}
// ToRfc822zString output a string in RFC822Z format
// 输出 RFC822Z 格式字符串
func (c Carbon) ToRfc822zString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(RFC822ZFormat)
}
// ToRfc850String output a string in RFC850 format
// 输出 RFC850 格式字符串
func (c Carbon) ToRfc850String(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(RFC850Format)
}
// ToRfc1036String output a string in RFC1036 format
// 输出 RFC1036 格式字符串
func (c Carbon) ToRfc1036String(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(RFC1036Format)
}
// ToRfc1123String output a string in RFC1123 format
// 输出 RFC1123 格式字符串
func (c Carbon) ToRfc1123String(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(RFC1123Format)
}
// ToRfc1123zString output a string in RFC1123z format
// 输出 RFC1123z 格式字符串
func (c Carbon) ToRfc1123zString(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(RFC1123ZFormat)
}
// ToRfc2822String output a string in RFC2822 format
// 输出 RFC2822 格式字符串
func (c Carbon) ToRfc2822String(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(RFC2822Format)
}
// ToRfc3339String output a string in RFC3339 format
// 输出 RFC3339 格式字符串
func (c Carbon) ToRfc3339String(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(RFC3339Format)
}
// ToRfc7231String output a string in RFC7231 format
// 输出 RFC7231 格式字符串
func (c Carbon) ToRfc7231String(timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(RFC7231Format)
}
// ToLayoutString output a string by layout
// 输出指定布局的时间字符串
func (c Carbon) ToLayoutString(layout string, timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
return c.Time.In(c.Loc).Format(layout)
}
// Layout Output a string by layout, it is short for ToLayoutString
// 输出指定布局的时间字符串, 是 ToLayoutString 的简写
func (c Carbon) Layout(layout string, timezone ...string) string {
if c.IsInvalid() {
return ""
}
return c.ToLayoutString(layout, timezone...)
}
// ToFormatString output a string by format
// 输出指定格式的时间字符串
func (c Carbon) ToFormatString(format string, timezone ...string) string {
if c.IsInvalid() {
return ""
}
if len(timezone) > 0 {
loc, err := getLocationByTimezone(timezone[len(timezone)-1])
c.Loc = loc
c.Error = err
}
runes := []rune(format)
buffer := bytes.NewBuffer(nil)
for i := 0; i < len(runes); i++ {
if layout, ok := formats[byte(runes[i])]; ok {
buffer.WriteString(c.Time.In(c.Loc).Format(layout))
} else {
switch runes[i] {
case '\\': // 原样输出,不解析
buffer.WriteRune(runes[i+1])
i++
continue
case 'W': // ISO-8601 格式数字表示的年份中的第几周,取值范围 1-52
buffer.WriteString(strconv.Itoa(c.WeekOfYear()))
case 'N': // ISO-8601 格式数字表示的星期中的第几天,取值范围 1-7
buffer.WriteString(strconv.Itoa(c.DayOfWeek()))
case 'S': // 月份中第几天的英文缩写后缀如st, nd, rd, th
suffix := "th"
switch c.Day() {
case 1, 21, 31:
suffix = "st"
case 2, 22:
suffix = "nd"
case 3, 23:
suffix = "rd"
}
buffer.WriteString(suffix)
case 'L': // 是否为闰年,如果是闰年为 1否则为 0
if c.IsLeapYear() {
buffer.WriteString("1")
} else {
buffer.WriteString("0")
}
case 'G': // 数字表示的小时24 小时格式,没有前导零,取值范围 0-23
buffer.WriteString(strconv.Itoa(c.Hour()))
case 'U': // 秒级时间戳,如 1611818268
buffer.WriteString(strconv.FormatInt(c.ToTimestamp(), 10))
case 'u': // 数字表示的毫秒,如 999
buffer.WriteString(strconv.Itoa(c.Millisecond()))
case 'w': // 数字表示的星期中的第几天,取值范围 0-6
buffer.WriteString(strconv.Itoa(c.DayOfWeek() - 1))
case 't': // 指定的月份有几天,取值范围 28-31
buffer.WriteString(strconv.Itoa(c.DaysInMonth()))
case 'z': // 年份中的第几天,取值范围 0-365
buffer.WriteString(strconv.Itoa(c.DayOfYear() - 1))
case 'e': // 当前位置,如 UTCGMTAtlantic/Azores
buffer.WriteString(c.Location())
case 'Q': // 当前季度,取值范围 1-4
buffer.WriteString(strconv.Itoa(c.Quarter()))
case 'C': // 当前世纪数,取值范围 0-99
buffer.WriteString(strconv.Itoa(c.Century()))
default:
buffer.WriteRune(runes[i])
}
}
}
return buffer.String()
}
// Format Output a string by format, it is short for ToFormatString
// 输出指定格式的时间字符串, 是 ToFormatString 的简写
func (c Carbon) Format(format string, timezone ...string) string {
if c.IsInvalid() {
return ""
}
return c.ToFormatString(format, timezone...)
}