vikbooking / admin / helpers / src / chat / storage.php

storage.php in VikBooking Hotel Booking Engine & PMS trunk, at admin/helpers/src/chat/storage.php

74 lines 1.7 KB

Raw Download Zip

1	<?php
2	/**
3	* @package VikBooking
4	* @subpackage core
5	* @author E4J s.r.l.
6	* @copyright Copyright (C) 2026 E4J s.r.l. All Rights Reserved.
7	* @license http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL
8	* @link https://vikwp.com
9	*/
10
11	// No direct access
12	defined('ABSPATH') or die('No script kiddies please!');
13
14	/**
15	* Chat messages input/output handler interface.
16	*
17	* @since 1.8
18	*/
19	interface VBOChatStorage
20	{
21	/**
22	* Returns the messages matching the specified search query.
23	*
24	* @param VBOChatSearch $search
25	*
26	* @return object[]
27	*/
28	public function getMessages(VBOChatSearch $search);
29
30	/**
31	* Returns the details of the specified message.
32	*
33	* @param int $messageId
34	* @param VBOChatContext $context
35	*
36	* @return object\|null
37	*/
38	public function getMessage(int $messageId, VBOChatContext $context);
39
40	/**
41	* Saves the provided message.
42	*
43	* @param VBOChatMessage $message
44	*
45	* @return void
46	*
47	* @throws Exception
48	*/
49	public function saveMessage(VBOChatMessage $message);
50
51	/**
52	* Removes the provided message.
53	*
54	* @param VBOChatMessage $message
55	*
56	* @return void
57	*
58	* @throws Exception
59	*
60	* @since 1.8.8
61	*/
62	public function deleteMessage(VBOChatMessage $message);
63
64	/**
65	* Marks the given message as read by the specified user.
66	*
67	* @param int $messageId The ID of the message to read.
68	* @param int $userId The ID of the user that read the message.
69	*
70	* @return void
71	*/
72	public function readMessage(int $messageId, int $userId = 0);
73	}
74