oms-Auditor/Models/Audit.php

<?php
/**
 * Orange Management
 *
 * PHP Version 7.4
 *
 * @package   Modules\Auditor\Models
 * @copyright Dennis Eichhorn
 * @license   OMS License 1.0
 * @version   1.0.0
 * @link      https://orange-management.org
 */
declare(strict_types=1);

namespace Modules\Auditor\Models;

use Modules\Admin\Models\NullAccount;
use phpOMS\Account\Account;

/**
 * Audit class.
 *
 * @package Modules\Auditor\Models
 * @license OMS License 1.0
 * @link    https://orange-management.org
 * @since   1.0.0
 */
class Audit
{
    /**
     * Audit id.
     *
     * @var int
     * @since 1.0.0
     */
    private int $id = 0;

    /**
     * Audit type.
     *
     * @var int
     * @since 1.0.0
     */
    private int $type;

    /**
     * Audit subtype.
     *
     * @var int
     * @since 1.0.0
     */
    private int $subtype;

    /**
     * Audit module.
     *
     * @var null|string
     * @since 1.0.0
     */
    private ?string $module;

    /**
     * Audit reference.
     *
     * This could be used to reference other model ids
     *
     * @var null|string
     * @since 1.0.0
     */
    private ?string $ref;

    /**
     * Audit content.
     *
     * Additional audit information
     *
     * @var null|string
     * @since 1.0.0
     */
    private ?string $content;

    /**
     * Old value.
     *
     * @var null|string
     * @since 1.0.0
     */
    private ?string $old;

    /**
     * New value.
     *
     * @var null|string
     * @since 1.0.0
     */
    private ?string $new;

    /**
     * Account.
     *
     * @var Account
     * @since 1.0.0
     */
    private Account $createdBy;

    /**
     * Created at.
     *
     * @var \DateTime
     * @since 1.0.0
     */
    private \DateTime $createdAt;

    /**
     * Ip of creator.
     *
     * @var int
     * @since 1.0.0
     */
    private int $ip = 0;

    /**
     * Constructor.
     *
     * @param Account     $account Account of the creator
     * @param null|string $old     Old value
     * @param null|string $new     New value
     * @param int         $type    Type of the audit
     * @param int         $subtype Subtype of the audit
     * @param null|string $module  Module id
     * @param null|string $ref     Dynamic reference to model
     * @param null|string $content Additional audit information
     * @param int         $ip      Ip
     *
     * @since 1.0.0
     */
    public function __construct(
        Account $account = null,
        string $old = null,
        string $new = null,
        int $type = 0,
        int $subtype = 0,
        string $module = null,
        string $ref = null,
        string $content = null,
        int $ip = 0
    ) {
        $this->createdAt = new \DateTime('now');
        $this->createdBy = $account ?? new NullAccount();
        $this->old       = $old;
        $this->new       = $new;
        $this->type      = $type;
        $this->subtype   = $subtype;
        $this->module    = $module;
        $this->ref       = $ref;
        $this->content   = $content;
        $this->ip        = $ip;
    }

    /**
     * Get id.
     *
     * @return int
     *
     * @since 1.0.0
     */
    public function getId() : int
    {
        return $this->id;
    }

    /**
     * Get type.
     *
     * @return int
     *
     * @since 1.0.0
     */
    public function getType() : int
    {
        return $this->type;
    }

    /**
     * Get subtype.
     *
     * @return int
     *
     * @since 1.0.0
     */
    public function getSubType() : int
    {
        return $this->subtype;
    }

    /**
     * Get Module.
     *
     * @return null|string
     *
     * @since 1.0.0
     */
    public function getModule() : ?string
    {
        return $this->module;
    }

    /**
     * Get reference.
     *
     * If existing this can be a reference to another model
     *
     * @return null|string
     *
     * @since 1.0.0
     */
    public function getRef() : ?string
    {
        return $this->ref;
    }

    /**
     * Get content.
     *
     * @return null|string
     *
     * @since 1.0.0
     */
    public function getContent() : ?string
    {
        return $this->content;
    }

    /**
     * Get old value.
     *
     * @return null|string
     *
     * @since 1.0.0
     */
    public function getOld() : ?string
    {
        return $this->old;
    }

    /**
     * Get new value.
     *
     * @return null|string
     *
     * @since 1.0.0
     */
    public function getNew() : ?string
    {
        return $this->new;
    }

    /**
     * Get created by.
     *
     * @return Account|int
     *
     * @since 1.0.0
     */
    public function getCreatedBy()
    {
        return $this->createdBy;
    }

    /**
     * Get created at.
     *
     * @return \DateTime
     *
     * @since 1.0.0
     */
    public function getCreatedAt() : \DateTime
    {
        return $this->createdAt;
    }

    /**
     * Get ip.
     *
     * @return int
     *
     * @since 1.0.0
     */
    public function getIp() : int
    {
        return $this->ip;
    }
}