Platine\Framework\Audit\Auditor

Complexity

Total Complexity

6

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setEvent()	0	4	1
A	save()	0	25	1
A	setDetail()	0	4	1
A	setTags()	0	4	1
A	__construct()	0	12	1
A	getRepository()	0	3	1

<?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 DateTime;
use Platine\Framework\Audit\Model\AuditRepository;
use Platine\Framework\Auth\AuthenticationInterface;
use Platine\Framework\Auth\Repository\UserRepository;
use Platine\Http\ServerRequestInterface;
use Platine\Stdlib\Helper\Str;
use Platine\UserAgent\UserAgent;

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

    /**
     * The request instance
     * @var ServerRequestInterface
     */
    protected ServerRequestInterface $request;

    /**
     * User agent instance
     * @var UserAgent
     */
    protected UserAgent $userAgent;

    /**
     * The authentication instance
     * @var AuthenticationInterface
     */
    protected AuthenticationInterface $authentication;

    /**
     * The audit details
     * @var string
     */
    protected string $detail = '';

    /**
     * The audit event
     * @var string
     */
    protected string $event = '';

    /**
     * The audits tags
     * @var array<string>
     */
    protected array $tags = [];

    /**
     * User repository instance
     * @var UserRepository
     */
    protected UserRepository $userRepository;

    /**
     * Create new instance
     * @param AuditRepository $repository
     * @param ServerRequestInterface $request
     * @param UserAgent $userAgent
     * @param AuthenticationInterface $authentication
     * @param UserRepository $userRepository
     */
    public function __construct(
        AuditRepository $repository,
        ServerRequestInterface $request,
        UserAgent $userAgent,
        AuthenticationInterface $authentication,
        UserRepository $userRepository
    ) {
        $this->repository = $repository;
        $this->request = $request;
        $this->userAgent = $userAgent;
        $this->authentication = $authentication;
        $this->userRepository = $userRepository;
    }

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

    /**
     * Save the audits information's
     * @return bool
     */
    public function save(): bool
    {
        $userAgentStr = $this->request->getHeaderLine('User-Agent');
        $ua = $this->userAgent->parse($userAgentStr);
        $userAgent = sprintf(
            '%s %s - %s %s',
            $ua->device()->getModel(),
            $ua->device()->getType(),
            $ua->browser()->getName(),
            $ua->browser()->getVersion()
        );

        $entity = $this->repository->create([
            'event' => $this->event,
            'detail' => $this->detail,
            'user_agent' => $userAgent,
            'tags' => implode(', ', $this->tags),
            'date' => new DateTime('now'),
            'ip' => Str::ip(),
            'url' => (string) $this->request->getUri(),
        ]);
        $userId = $this->authentication->getUser()->getId();
        $entity->user = $this->userRepository->find($userId);

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

    /**
     *
     * @param string $detail
     * @return $this
     */
    public function setDetail(string $detail): self
    {
        $this->detail = $detail;
        return $this;
    }

    /**
     *
     * @param string $event
     * @return $this
     */
    public function setEvent(string $event): self
    {
        $this->event = $event;
        return $this;
    }

    /**
     *
     * @param array<string> $tags
     * @return $this
     */
    public function setTags(array $tags): self
    {
        $this->tags = $tags;
        return $this;
    }
}