TimeInterval

Date & time interval and numeric range handling class for Reporting API.


Description Description


Source Source

File: packages/woocommerce-admin/src/API/Reports/TimeInterval.php


			

Top ↑

Methods Methods

  • convert_local_datetime_to_gmt — Converts local datetime to GMT/UTC time.
  • db_datetime_format — Returns date format to be used as grouping clause in SQL.
  • default_after — Returns default 'after' parameter for the reports.
  • default_before — Returns default 'before' parameter for the reports.
  • expected_intervals_on_page — Returns expected number of items on the page in case of date ordering.
  • intervals_between — Calculates number of time intervals between two dates, closed interval on both sides.
  • intervals_missing — Returns true if there are any intervals that need to be filled in the response.
  • iterate — Returns beginning of next time interval for provided DateTime.
  • next_day_start — Returns a new DateTime object representing the next day start, or previous day end if reversed.
  • next_hour_start — Returns a new DateTime object representing the next hour start/previous hour end if reversed.
  • next_month_start — Returns a new DateTime object representing the next month start, or previous month end if reversed.
  • next_quarter_start — Returns a new DateTime object representing the next quarter start, or previous quarter end if reversed.
  • next_week_start — Returns DateTime object representing the next week start, or previous week end if reversed.
  • next_year_start — Return a new DateTime object representing the next year start, or previous year end if reversed.
  • normalize_between_params — Normalize "*_between" parameters to "*_min" and "*_max" for numeric values and "*_after" and "*_before" for date values.
  • quarter — Returns quarter for the DateTime.
  • rest_validate_between_date_arg — Validate a "*_between" range argument (an array with 2 date items).
  • rest_validate_between_numeric_arg — Validate a "*_between" range argument (an array with 2 numeric items).
  • simple_week_number — Returns simple week number for the DateTime, for week starting on $first_day_of_week.
  • time_interval_id — Returns time interval id for the DateTime.
  • week_number — Returns ISO 8601 week number for the DateTime, if week starts on Monday, otherwise returns simple week number.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.