resource_helper.php — LatePoint – Calendar Booking Plugin for Appointments and Events 5.2.2

latepoint / lib / helpers / resource_helper.php

latepoint / lib / helpers Last commit date

resource_helper.php

277 lines

1	<?php
2	/*
3	* Copyright (c) 2022 LatePoint LLC. All rights reserved.
4	*/
5
6	class OsResourceHelper {
7
8	/**
9	* @param \LatePoint\Misc\BookingRequest $booking_request
10	* @param DateTime $date_from
11	* @param DateTime\|null $date_to
12	* @param array $settings
13	*
14	* @return array
15	*
16	*
17	* Returns an array of work periods, grouped by days that were requested in the filter.
18	* example: ['2022-02-24' => [], '2022-02-25' => [], ...]
19	*
20	* \| Agent \| Service \| Location \| Date \| Hours \| Weight
21	* \| -----------------------------------------------------------------------------
22	* \| 1 \| 1 \| 1 \| 2022-01-15 \| 7:00 - 18:00 \| 7
23	* \| 1 \| 0 \| 1 \| 2022-01-15 \| 8:00 - 14:00 \| 6
24	* \| 1 \| 0 \| 0 \| 2022-01-15 \| 8:00 - 14:00 \| 5
25	* \| 0 \| 0 \| 1 \| 2022-01-15 \| 11:00 - 12:00 \| 5
26	* \| 0 \| 0 \| 0 \| 2022-01-15 \| 11:00 - 12:00 \| 4
27	* \| 1 \| 0 \| 1 \| NULL \| 0:00 - 0:00 \| 2
28	* \| 1 \| 0 \| 0 \| NULL \| 9:00 - 12:00 \| 1
29	* \| 0 \| 0 \| 0 \| NULL \| 11:00 - 17:00 \| 0
30	*
31	*/
32	public static function get_resources_grouped_by_day( \LatePoint\Misc\BookingRequest $booking_request, DateTime $date_from, ?DateTime $date_to = null, array $settings = [] ): array {
33	$defaults = [
34	'now' => OsTimeHelper::now_datetime_object(),
35	'exclude_booking_ids' => [],
36	'accessed_from_backend' => false,
37	'consider_cart_items' => false,
38	'timezone_name' => OsTimeHelper::get_wp_timezone_name()
39	];
40	$settings = array_merge( $defaults, $settings );
41
42	$connections = OsConnectorHelper::get_connections_that_satisfy_booking_request( $booking_request, $settings['accessed_from_backend'] );
43	$resources = [];
44	foreach ( $connections as $connection ) {
45	$resources[] = \LatePoint\Misc\BookingResource::create_from_connection( $connection );
46	}
47	if ( empty( $date_to ) ) {
48	$date_to = clone $date_from;
49	}
50
51
52	// all resource management is done in WP timezone, if requested timezone is different - make sure to include couple days on each end to accommodate for timezone differences, which could be up to 26 hours
53	if($settings['timezone_name'] != OsTimeHelper::get_wp_timezone_name()) {
54	$date_from->modify( '-2 days' );
55	$date_to->modify( '+2 days' );
56	}
57
58	$filter = new \LatePoint\Misc\Filter( [
59	'service_id' => $booking_request->service_id,
60	'connections' => $connections,
61	'date_from' => $date_from->format( 'Y-m-d' ),
62	'date_to' => $date_to->format( 'Y-m-d' )
63	] );
64	$weekday_periods = OsWorkPeriodsHelper::get_work_periods_grouped_by_weekday( $filter );
65	$daily_resources = [];
66	// loop through the requested days and fill in array with work periods that are applicable to that day
67
68	// Booked periods
69	$booked_periods_filter = new \LatePoint\Misc\Filter();
70	$booked_periods_filter->date_from = $date_from->format( 'Y-m-d' );
71	$booked_periods_filter->date_to = $date_to->format( 'Y-m-d' );
72	$booked_periods_filter->statuses = OsBookingHelper::get_timeslot_blocking_statuses();
73	if ( $settings['exclude_booking_ids'] ) {
74	$booked_periods_filter->exclude_booking_ids = $settings['exclude_booking_ids'];
75	}
76	if ( $settings['consider_cart_items'] ) {
77	$booked_periods_filter->consider_cart_items = true;
78	}
79
80	$booked_periods = OsBookingHelper::get_booked_periods_grouped_by_day( $booked_periods_filter );
81	$blocked_periods = OsBookingHelper::get_blocked_periods_grouped_by_day( $filter, $settings['accessed_from_backend'] );
82
83
84	for ( $day_date = clone $date_from; $day_date->format( 'Y-m-d' ) <= $date_to->format( 'Y-m-d' ); $day_date->modify( '+1 day' ) ) {
85	$daily_resources[ $day_date->format( 'Y-m-d' ) ] = [];
86	// fill every day with available resources
87	foreach ( $resources as $resource ) {
88	$last_added_period = false;
89	$available_work_periods_groups = [];
90	$group_index = 0;
91	// loop through available work periods for this week day
92	foreach ( $weekday_periods[ $day_date->format( 'N' ) ] as $period ) {
93	if ( $period->custom_date && ( $period->custom_date != $day_date->format( 'Y-m-d' ) ) ) {
94	continue;
95	} // if this period has a custom date set and if it doesn't match the one we search for - skip it
96	// only add this work period if agent/location/service match or not set
97	if ( ( ! $period->agent_id \|\| $period->agent_id == $resource->agent_id ) && ( ! $period->service_id \|\| $period->service_id == $resource->service_id ) && ( ! $period->location_id \|\| $period->location_id == $resource->location_id ) ) {
98	if ( $last_added_period ) {
99	// if weight of previously added period is different - break, no need to add any other periods
100	if ( $last_added_period->weight != $period->weight ) {
101	break;
102	}
103	if ( ( $last_added_period->service_id != $period->service_id ) \|\| ( $last_added_period->agent_id != $period->agent_id ) \|\| ( $last_added_period->location_id != $period->location_id ) ) {
104	// same weight NOT same exact properties, create a new group of work periods, which will later be used to find intersections
105	$group_index ++;
106	}
107	if ( ( $period->start_time == 0 ) && ( $period->end_time == 0 ) ) {
108	$available_work_periods_groups = [];
109	break;
110	}
111	$available_work_periods_groups[ $group_index ][] = \LatePoint\Misc\TimePeriod::create_from_work_period( $period );
112	$last_added_period = $period;
113	} else {
114	if ( ( $period->start_time == 0 ) && ( $period->end_time == 0 ) ) {
115	$available_work_periods_groups = [];
116	break;
117	}
118	$available_work_periods_groups[ $group_index ][] = \LatePoint\Misc\TimePeriod::create_from_work_period( $period );
119	$last_added_period = $period;
120	}
121	}
122	}
123
124	$day_resource = clone $resource;
125	$day_resource->date = $day_date->format( 'Y-m-d' );
126	$day_resource->add_available_periods( $available_work_periods_groups );
127
128	/// -----------------------------
129	/// LOGIC FOR CALCULATING "BOOKED" PERIODS
130	/// -----------------------------
131	foreach ( $booked_periods[ $day_date->format( 'Y-m-d' ) ] as $booked_period ) {
132
133	if ( ( $day_resource->service_id == $booked_period->service_id ) && ( $day_resource->location_id == $booked_period->location_id ) && ( $day_resource->agent_id == $booked_period->agent_id ) ) {
134	// same service, agent and location is already booked, block no matter what
135	$day_resource->add_booked_period( $booked_period );
136	continue;
137	}
138
139	if ( $day_resource->agent_id == $booked_period->agent_id ) {
140	// Same agent
141	if ( ( $day_resource->location_id != $booked_period->location_id ) && OsSettingsHelper::is_on( 'one_location_at_time' ) ) {
142	// different location is booked, but the same agent, block if "Agents can only be present in one location at a time" is ON
143	$day_resource->add_booked_period( $booked_period, true );
144	continue;
145	}
146	if ( ( $day_resource->service_id != $booked_period->service_id ) && ( $day_resource->location_id == $booked_period->location_id ) && ! OsSettingsHelper::is_on( 'multiple_services_at_time' ) ) {
147	// Different service, but same location, block, if "One agent can perform different services simultaneously" is OFF
148	$day_resource->add_booked_period( $booked_period, true );
149	}
150	} else {
151	// Different agent
152	if ( ( $day_resource->location_id == $booked_period->location_id ) && OsSettingsHelper::is_on( 'one_agent_at_location' ) ) {
153	// same location, so it doesn't matter who's the agent, block, because location can only be used by a single agent at a time
154	// set to max capacity, to block slot even if it still has room
155	$day_resource->add_booked_period( $booked_period, true );
156	}
157	}
158	}
159
160	/// -----------------------------
161	/// LOGIC FOR CALCULATING "BLOCKED" PERIODS
162	/// -----------------------------
163	foreach ( $blocked_periods[ $day_date->format( 'Y-m-d' ) ] as $blocked_period ) {
164	if ( ! $blocked_period->agent_id \|\| $day_resource->agent_id == $blocked_period->agent_id ) {
165	$day_resource->add_blocked_period( $blocked_period );
166	}
167	}
168
169	$day_resource->build_bookable_slots( $booking_request, $day_resource->get_timeblock_interval() );
170	$daily_resources[ $day_date->format( 'Y-m-d' ) ][] = $day_resource;
171	}
172	}
173	$daily_resources = apply_filters( 'latepoint_get_resources_grouped_by_day', $daily_resources, $booking_request, $date_from, $date_to, $settings );
174
175	return $daily_resources;
176	}
177
178
179	/**
180	* @param \LatePoint\Misc\BookingResource[] $resources
181	*
182	* @return array
183	*/
184	public static function get_ordered_booking_slots_from_resources( array $resources ): array {
185	$booking_slots = [];
186	foreach ( $resources as $resource ) {
187	$booking_slots = array_merge( $booking_slots, $resource->slots );
188	}
189
190	usort( $booking_slots, function ( $first, $second ) {
191	return $first->start_time <=> $second->start_time;
192	} );
193
194	if ( count( $resources ) > 1 ) {
195	$squashed_booking_slots = [];
196	$last_added_slot = false;
197	foreach ( $booking_slots as $booking_slot ) {
198	if ( $last_added_slot && ( $last_added_slot->start_time == $booking_slot->start_time ) ) {
199	if ( $last_added_slot->available_capacity() < $booking_slot->available_capacity() ) {
200	$squashed_booking_slots[ count( $squashed_booking_slots ) - 1 ] = $booking_slot;
201	$last_added_slot = $booking_slot;
202	}
203	} else {
204	$squashed_booking_slots[] = $booking_slot;
205	$last_added_slot = $booking_slot;
206	}
207	}
208	$booking_slots = $squashed_booking_slots;
209	}
210
211	return $booking_slots;
212	}
213
214	/**
215	* @param \LatePoint\Misc\BookingResource[]
216	*
217	* @return \LatePoint\Misc\TimePeriod
218	*/
219	public static function get_work_boundaries_for_resources( $resources ): \LatePoint\Misc\TimePeriod {
220	$times = [];
221	foreach ( $resources as $resource ) {
222	foreach ( $resource->work_time_periods as $work_time_period ) {
223	$times[] = $work_time_period->start_time;
224	$times[] = $work_time_period->end_time;
225	}
226	foreach ( $resource->booked_time_periods as $booked_time_period ) {
227	if ( $booked_time_period->start_date == $booked_time_period->end_date ) {
228	// same day event
229	$times[] = $booked_time_period->start_time;
230	$times[] = $booked_time_period->end_time;
231	} else {
232	// event spans mutiple days, expand boundaries to a full day
233	$times[] = 0;
234	$times[] = 24 * 60 - 1;
235	}
236	}
237	}
238	if ( $times ) {
239	$boundary_time_period = new \LatePoint\Misc\TimePeriod( [
240	'start_time' => min( $times ),
241	'end_time' => max( $times )
242	] );
243	} else {
244	$boundary_time_period = new \LatePoint\Misc\TimePeriod( [ 'start_time' => 0, 'end_time' => 0 ] );
245	}
246
247	return $boundary_time_period;
248	}
249
250	/**
251	* @param array $groups_of_resources
252	*
253	* @return \LatePoint\Misc\TimePeriod
254	*/
255	public static function get_work_boundaries_for_groups_of_resources( array $groups_of_resources ): \LatePoint\Misc\TimePeriod {
256	$times = [];
257	foreach ( $groups_of_resources as $resources ) {
258	$time_period = self::get_work_boundaries_for_resources( $resources );
259	if ( $time_period->start_time \|\| $time_period->end_time ) {
260	$times[] = $time_period->start_time;
261	$times[] = $time_period->end_time;
262	}
263	}
264	if ( $times ) {
265	$boundary_time_period = new \LatePoint\Misc\TimePeriod( [
266	'start_time' => min( $times ),
267	'end_time' => max( $times )
268	] );
269	} else {
270	$boundary_time_period = new \LatePoint\Misc\TimePeriod( [ 'start_time' => 0, 'end_time' => 0 ] );
271	}
272
273	return $boundary_time_period;
274	}
275
276
277	}