Platine\Framework\Audit\Auditor

Complexity

Total Complexity

5

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	getRepository()	0	3	1
A	log()	0	11	3

<?php

/**
 * Platine Framework
 *
 * Platine Framework is a lightweight, high-performance, simple and elegant
 * PHP Web framework
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine Framework
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 *  @file Auditor.php
 *
 *  The Auditor class
 *
 *  @package    Platine\Framework\Audit
 *  @author Platine Developers team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   http://www.iacademy.cf
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\Framework\Audit;

use InvalidArgumentException;
use Platine\Framework\Audit\Model\AuditRepository;
use Platine\Framework\Auth\Entity\User;

/**
 * @class Auditor
 * @package Platine\Framework\Audit
 */
class Auditor
{
    /**
     * The audit repository
     * @var AuditRepository
     */
    protected AuditRepository $repository;

    /**
     * Create new instance
     * @param AuditRepository $repository
     */
    public function __construct(AuditRepository $repository)
    {
        $this->repository = $repository;
    }

    /**
     * Return the audit repository instance
     * @return AuditRepository
     */
    public function getRepository(): AuditRepository
    {
        return $this->repository;
    }

    /**
     * Save the audit log
     * @param array<string, mixed> $data
     * @return bool
     */
    public function log(array $data): bool
    {
        if (!isset($data['user']) || !$data['user'] instanceof User) {
            throw new InvalidArgumentException(
                'User entity does not exist or invalid'
            );
        }

        $entity = $this->repository->create($data);

        return $this->repository->save($entity);
    }
}