}
}
// Without a context these values will not make sense; we'll set them if the `$filter` argument is a date.
$starts_this_week = null;
$ends_this_week = null;
$happens_this_week = null;
$this_week_duration = null;
$displays_on = [];
if ( 'raw' !== $filter && Dates::is_valid_date( $filter ) ) {
[ $week_start, $week_end ] = Dates::get_week_start_end( $filter );
$week_cache_key = $post_id . '_' . $week_start->format( Dates::DBDATEFORMAT ) . '_week';
$cached = tribe( 'cache' )[ $week_cache_key ];
if ( ! empty( $cached ) ) {
[ $happens_this_week, $starts_this_week, $ends_this_week, $this_week_duration, $displays_on] = $cached;
$displays_on = (array) $displays_on;
} else {
$the_start = $start_date_object;
$the_end = $end_date_object;// Take into account the timezone settings.
if ( Timezones::is_mode( Timezones::SITE_TIMEZONE ) ) {
// Move the event to the site timezone.
$the_start = $the_start->setTimezone( $site_timezone );
$the_end = $the_end->setTimezone( $site_timezone );
}
$displays_on = [ $the_start->format( Dates::DBDATEFORMAT ) ];
$week_start_ymd = (int) $week_start->format( 'Ymd' );
$week_end_ymd = (int) $week_end->format( 'Ymd' );
$the_start_ymd = (int) $the_start->format( 'Ymd' );
$the_end_ymd = (int) $the_end->format( 'Ymd' );
$starts_this_week = $week_start_ymd <= $the_start_ymd && $the_start_ymd <= $week_end_ymd;
$ends_this_week = $week_start_ymd <= $the_end_ymd && $the_end_ymd <= $week_end_ymd;
$happens_this_week = $week_start_ymd <= $the_end_ymd && $the_start_ymd <= $week_end_ymd;/*
* A day "crosses the EOD cutoff time" if the end is after the EOD cutoff of the start.
* Here we look just for a boolean.
*/
$cross_day = tribe_end_of_day( $the_start->format( 'Y-m-d' ) ) < $the_end->format( 'Y-m-d H:i:s' );
if ( $happens_this_week ) {
$this_week_duration = 1;
if ( $is_multiday ) {
if ( $starts_this_week && $ends_this_week ) {
$this_week_duration = min( 7,
max( 1, Dates::date_diff( $the_end_ymd, $the_start_ymd ) ) + $cross_day );
} elseif ( $ends_this_week ) {
$this_week_duration = Dates::date_diff( $the_end_ymd, $week_start_ymd ) + $cross_day;
} elseif ( $starts_this_week ) {
$this_week_duration = Dates::date_diff( $week_end_ymd, $the_start_ymd ) + $cross_day;
} else {
// If it happens this week and it doesn't start or end this week, then it spans the week.
$this_week_duration = 7;
}
}
$this_week_duration = min( 7, $this_week_duration );
}
}
}
$featured = tribe_is_truthy( isset( $post_meta[ Featured::FEATURED_EVENT_KEY ][0] ) ? $post_meta[ Featured::FEATURED_EVENT_KEY ][0] : null );
$sticky = get_post_field( 'menu_order', $post_id ) === - 1;
$organizer_names_fetch = Organizer::get_fetch_names_callback( $post_id );
$organizer_fetch = Organizer::get_fetch_callback( $post_id );
$venue_fetch = Venue::get_fetch_callback( $post_id );
$start_site = $start_date_object->setTimezone( $site_timezone );
$end_site = $end_date_object->setTimezone( $site_timezone );
$use_event_timezone = Timezones::is_mode( Timezones::EVENT_TIMEZONE );
$properties = [
'start_date' => $start_date,
'start_date_utc' => $start_date_utc,
'end_date' => $end_date,
'end_date_utc' => $end_date_utc,
'dates' => (object) [
'start' => $start_date_object,
'start_utc' => $start_date_utc_object,
'start_site' => $start_site,
'start_display' => $use_event_timezone ? $start_date_object : $start_site,
'end' => $end_date_object,
'end_utc' => $end_date_utc_object,
'end_site' => $end_site,
'end_display' => $use_event_timezone ? $end_date_object : $end_site,
],
'timezone' => $timezone_string,
'duration' => $duration,
'multiday' => $multiday,
'is_past' => $start_date_object < $now,
'is_now' => Dates::is_now( $start_date, $end_date ),
'all_day' => $all_day,
'starts_this_week' => $starts_this_week,
'ends_this_week' => $ends_this_week,
'this_week_duration' => $this_week_duration,
'happens_this_week' => $happens_this_week,
'displays_on' => $displays_on,
'featured' => $featured,
'sticky' => $sticky,
'cost' => tribe_get_cost( $post_id, true ),
'excerpt' => (
new Lazy_String(
static function () use ( $post_id ) {
return tribe_events_get_the_excerpt( $post_id, wp_kses_allowed_html( 'post' ), true );
},
false
)
)->on_resolve( $cache_this ),
'organizer_names' => ( new Lazy_Collection( $organizer_names_fetch ) )->on_resolve( $cache_this ),
'organizers' => (
new Lazy_Post_Collection(
$organizer_fetch,
'tribe_get_organizer_object'
)
)->on_resolve( $cache_this ),
'venues' => (
new Lazy_Post_Collection(
$venue_fetch,
'tribe_get_venue_object' )
)->on_resolve( $cache_this ),
'thumbnail' => ( new Post_Thumbnail( $post_id ) )->on_resolve( $cache_this ),
'permalink' => ( new Lazy_String(
static function () use ( $post_id ) {
$permalink = get_permalink( $post_id );
return (string) ( empty( $permalink ) ? '' : $permalink );
},
false
) )->on_resolve( $cache_this ),
'schedule_details' => ( new Lazy_String(
static function () use ( $post_id ) {
return tribe_events_event_schedule_details( $post_id );
},
false
) )->on_resolve( $cache_this ),
'short_schedule_details' => ( new Lazy_String(
static function () use ( $post_id ) {
return tribe_events_event_short_schedule_details( $post_id );
},
false
) )->on_resolve( $cache_this ),
'plain_schedule_details' => ( new Lazy_String(
static function () use ( $post_id ) {
return tribe_events_event_schedule_details( $post_id, '', '', false );
},
false
) )->on_resolve( $cache_this ),
'title' => ( new Lazy_String(
static function () use ( $post_id ) {
$title = get_the_title( $post_id );
return (string) ( empty( $title ) ? '' : $title );
},
false
) )->on_resolve( $cache_this ),
];
} catch ( \Exception $e ) {
return [];
}
return $properties;
}
/**
* {@inheritDoc}
*/
protected function get_cache_slug() {
return 'events';
}
/**
* When dealing with a lot of events and the way we handle templates we need a way to prime the cache for the events
* that we know will for sure be on the base, allowing us to prevent queries to Posts to be requested individually
* which can lead to hundreds of more SQL calls.
*
* @since 6.0.0
*
* @param array $events
*/
public static function prime_cache( array $events = [] ) {
$first = reset( $events );
$is_numeric = ( ! $first instanceof WP_Post );
if ( $is_numeric ) {
$event_ids = $events;
} else {
$event_ids = wp_list_pluck( $events, 'ID' );
}
/**
* Allows changing which Post IDs will get primed for cache.
*
* @since 6.0.0
*
* @param array $event_ids Which IDs we will prime.
* @param array $events Which event objects will generate the ids.
*/
$event_ids = apply_filters( 'tec_events_prime_cache_post_ids', $event_ids, $events );
_prime_post_caches( $event_ids );
$venue_ids = array_map( static function( $event ) use ( $is_numeric ) {
return array_filter(
array_map(
'absint',
(array) get_post_meta( $is_numeric ? $event : $event->ID, '_EventVenueID' )
)
);
}, $events );
$venue_ids = empty( $venue_ids ) ? [] : array_merge( ...$venue_ids );
$organizer_ids = array_map( static function( $event ) use ( $is_numeric ) {
return array_filter(
array_map(
'absint',
(array) get_post_meta( $is_numeric ? $event : $event->ID, '_EventOrganizerID' )
)
);
}, $events );
$organizer_ids = empty( $organizer_ids ) ? [] : array_merge( ...$organizer_ids );
$attachment_ids[] = array_map( static function( $post ) use ( $is_numeric ) {
$post_id = $is_numeric ? $post : $post->ID;
return (int) get_post_meta( $post_id, '_thumbnail_id', true );
}, $events );
$attachment_ids = array_filter( array_merge( ...$attachment_ids ) );
$posts = array_unique( array_merge( $venue_ids, $organizer_ids, $attachment_ids ) );
_prime_post_caches( $posts );
}
/**
* Overrides the base method to convert the I18n Dates to PHP built-in Date types.
*
* @since 6.0.3.1
*
* @param array $properties The properties to filter.
*
* @return array The filtered properties.
*
* @throws \Exception If a date cannot be converted to a DateTime object.
*/
protected function scalar_serialize_properties( array $properties ): array {
// Convert the dates to built-in PHP date objects.
$properties['dates'] = array_map( static function ( $date ) {
if ( $date instanceof Date_I18n_Immutable ) {
return new \DateTimeImmutable( $date->format( 'Y-m-d H:i:s' ), $date->getTimezone() );
}
if ( $date instanceof Date_I18n ) {
return new \DateTime( $date->format( 'Y-m-d H:i:s' ), $date->getTimezone() );
}
return $date;
}, get_object_vars( $properties['dates'] ) );
return $properties;
}
/**
* Overrides the base method to convert date properties to I18n Dates.
*
* @since 6.0.3.1
*
* @param array $properties The properties to filter.
*
* @return array The filtered properties.
*
* @throws \Exception If a date cannot be converted to a I18n Date object.
*/
protected function scalar_unserialize_properties( array $properties ): array {
$properties['dates'] = (object) array_map( static function ( $date ) {
if ( $date instanceof \DateTimeImmutable ) {
return new Date_I18n_Immutable( $date->format( 'Y-m-d H:i:s' ), $date->getTimezone() );
}
if ( $date instanceof \DateTime ) {
return new Date_I18n( $date->format( 'Y-m-d H:i:s' ), $date->getTimezone() );
}
return $date;
}, $properties['dates'] ?? [] );
return $properties;
}
}