Module: TimeBoss::Calendar::Support::Translatable

Included in:

Unit

Defined in:

lib/timeboss/calendar/support/translatable.rb

Constant Summary

PERIODS =

%w[day week month quarter half year]

Instance Method Summary

• #day(index = nil) ⇒ Array<Calendar::Day>^?

  Get the day this unit represents.

• #days ⇒ Array<Calendar::Day>

  Get a list of days that fall within this unit.

• #half(index = nil) ⇒ Array<Calendar::Half>^?

  Get the half this unit represents.

• #halves ⇒ Array<Calendar::Half>

  Get a list of halves that fall within this unit.

• #month(index = nil) ⇒ Array<Calendar::Month>^?

  Get the month this unit represents.

• #months ⇒ Array<Calendar::Month>

  Get a list of months that fall within this unit.

• #quarter(index = nil) ⇒ Array<Calendar::Quarter>^?

  Get the quarter this unit represents.

• #quarters ⇒ Array<Calendar::Quarter>

  Get a list of quarters that fall within this unit.

• #week(index = nil) ⇒ Array<Calendar::Week>^?

  Get the week this unit represents.

• #weeks ⇒ Array<Calendar::Week>

  Get a list of weeks that fall within this unit.

• #year(index = nil) ⇒ Array<Calendar::Year>^?

  Get the year this unit represents.

• #years ⇒ Array<Calendar::Year>

  Get a list of years that fall within this unit.

Instance Method Details

#day(index = nil) ⇒ Array<Calendar::Day>^?

Get the day this unit represents. Returns nil if no single day can be identified.

Returns:

• (Array<Calendar::Day>, nil)

# File 'lib/timeboss/calendar/support/translatable.rb', line 32

#days ⇒ Array<Calendar::Day>

Get a list of days that fall within this unit.

Returns:

• (Array<Calendar::Day>)

# File 'lib/timeboss/calendar/support/translatable.rb', line 28

#half(index = nil) ⇒ Array<Calendar::Half>^?

Get the half this unit represents. Returns nil if no single half can be identified.

Returns:

• (Array<Calendar::Half>, nil)

# File 'lib/timeboss/calendar/support/translatable.rb', line 76

#halves ⇒ Array<Calendar::Half>

Get a list of halves that fall within this unit.

Returns:

• (Array<Calendar::Half>)

# File 'lib/timeboss/calendar/support/translatable.rb', line 72

#month(index = nil) ⇒ Array<Calendar::Month>^?

Get the month this unit represents. Returns nil if no single month can be identified.

Returns:

• (Array<Calendar::Month>, nil)

# File 'lib/timeboss/calendar/support/translatable.rb', line 54

#months ⇒ Array<Calendar::Month>

Get a list of months that fall within this unit.

Returns:

• (Array<Calendar::Month>)

# File 'lib/timeboss/calendar/support/translatable.rb', line 50

#quarter(index = nil) ⇒ Array<Calendar::Quarter>^?

Get the quarter this unit represents. Returns nil if no single quarter can be identified.

Returns:

• (Array<Calendar::Quarter>, nil)

# File 'lib/timeboss/calendar/support/translatable.rb', line 65

#quarters ⇒ Array<Calendar::Quarter>

Get a list of quarters that fall within this unit.

Returns:

• (Array<Calendar::Quarter>)

# File 'lib/timeboss/calendar/support/translatable.rb', line 61

#week(index = nil) ⇒ Array<Calendar::Week>^?

Get the week this unit represents. Returns nil if no single week can be identified.

Returns:

• (Array<Calendar::Week>, nil)

# File 'lib/timeboss/calendar/support/translatable.rb', line 43

#weeks ⇒ Array<Calendar::Week>

Get a list of weeks that fall within this unit.

Returns:

• (Array<Calendar::Week>)

# File 'lib/timeboss/calendar/support/translatable.rb', line 39

#year(index = nil) ⇒ Array<Calendar::Year>^?

Get the year this unit represents. Returns nil if no single year can be identified.

Returns:

• (Array<Calendar::Year>, nil)

# File 'lib/timeboss/calendar/support/translatable.rb', line 87

#years ⇒ Array<Calendar::Year>

Get a list of years that fall within this unit.

Returns:

• (Array<Calendar::Year>)

# File 'lib/timeboss/calendar/support/translatable.rb', line 83