ApiAccess.php

<?php
/**
 * This file is part of FacturaScripts
 * Copyright (C) 2018-2022 Carlos García Gómez <carlos@facturascripts.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace FacturaScripts\Core\Model;

use FacturaScripts\Core\Base\DataBase\DataBaseWhere;
use FacturaScripts\Dinamic\Model\ApiKey as DinApiKey;

/**
 * Defines the individual permissions for each resrouce within an api key.
 *
 * @author Carlos Garcia Gomez      <carlos@facturascripts.com>
 * @author Francesc Pineda Segarra  <francesc.pineda@x-netdigital.com>
 */
class ApiAccess extends Base\ModelClass
{

    use Base\ModelTrait;

    /**
     * Permission to delete.
     *
     * @var bool
     */
    public $allowdelete;

    /**
     * Permission to get.
     *
     * @var bool
     */
    public $allowget;

    /**
     * Permission to post.
     *
     * @var bool
     */
    public $allowpost;

    /**
     * Permission to put.
     *
     * @var bool
     */
    public $allowput;

    /**
     * Identifier of API key.
     *
     * @var int
     */
    public $idapikey;

    /**
     * Identifier.
     *
     * @var int
     */
    public $id;

    /**
     * Name of the resource.
     *
     * @var string
     */
    public $resource;

    /**
     * Add the indicated resource list to the Role group
     *
     * @param int $idApiKey
     * @param array $resources
     * @param bool $state
     *
     * @return bool
     */
    public static function addResourcesToApiKey(int $idApiKey, array $resources, bool $state = false): bool
    {
        $apiAccess = new static();

        foreach ($resources as $resource) {
            $where = [
                new DataBaseWhere('idapikey', $idApiKey),
                new DataBaseWhere('resource', $resource)
            ];
            if ($apiAccess->loadFromCode('', $where)) {
                continue;
            }

            $apiAccess->idapikey = $idApiKey;
            $apiAccess->resource = $resource;
            $apiAccess->allowdelete = $state;
            $apiAccess->allowget = $state;
            $apiAccess->allowpost = $state;
            $apiAccess->allowput = $state;
            if (false === $apiAccess->save()) {
                return false;
            }
        }

        return true;
    }

    public function install(): string
    {
        // needed dependencies
        new DinApiKey();

        return parent::install();
    }

    public static function primaryColumn(): string
    {
        return 'id';
    }

    /**
     * Update HTTP method permissions for this API resource and save the changes.
     *
     * @param bool $get    Whether GET is allowed.
     * @param bool $post   Whether POST is allowed.
     * @param bool $put    Whether PUT is allowed.
     * @param bool $delete Whether DELETE is allowed.
     *
     * @return bool True if saved successfully, false otherwise.
     */
    public function setAllowed(bool $get, bool $post, bool $put, bool $delete): bool
    {
        $this->allowget = $get;
        $this->allowpost = $post;
        $this->allowput = $put;
        $this->allowdelete = $delete;

        return $this->save();
    }

    public static function tableName(): string
    {
        return 'api_access';
    }
}