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