1	<?php
2	declare(strict_types=1);
3	/**
4	* Pop PHP Framework (https://www.popphp.org/)
5	*
6	* @link       https://github.com/popphp/popphp-framework
7	* @author     Nick Sagona, III <nick@popphp.org>
8	* @copyright  Copyright (c) 2009-2026 Nick Sagona, III
9	* @license    https://www.popphp.org/license     New BSD License
10	*/
11
12	/**
13	* @namespace
14	*/
15	namespace Pop\Audit\Model;
16
17	use Pop\Audit\Auditor;
18
19	/**
20	* Auditable model interface
21	*
22	* @category   Pop
23	* @package    Pop\Audit
24	* @author     Nick Sagona, III <nick@popphp.org>
25	* @copyright  Copyright (c) 2009-2026 Nick Sagona, III
26	* @license    https://www.popphp.org/license     New BSD License
27	* @version    3.0.0
28	*/
29	interface AuditableInterface
30	{
31
32	/**
33	* Set the auditor object
34	*
35	* @param  Auditor $auditor
36	* @return AuditableInterface
37	*/
38	public function setAuditor(Auditor $auditor): AuditableInterface;
39
40	/**
41	* Get the auditor object
42	*
43	* @return Auditor|null
44	*/
45	public function getAuditor(): Auditor|null;
46
47	/**
48	* Determine if the model has auditor
49	*
50	* @return bool
51	*/
52	public function hasAuditor(): bool;
53
54	/**
55	* Determine if the model is auditable
56	*
57	* @return bool
58	*/
59	public function isAuditable(): bool;
60
61	}