platine-php / framework

src/Config/DatabaseConfigLoader.php

<?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 DatabaseConfigLoader.php
 *
 *  The Database Configuration loader class
 *
 *  @package    Platine\Framework\Config
 *  @author Platine Developers team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   https://www.platine-php.com
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\Framework\Config;

use Platine\Database\Query\WhereStatement;
use Platine\Framework\Config\Model\Configuration;
use Platine\Orm\Entity;

/**
 * @class DatabaseConfigLoader
 * @package Platine\Framework\Config
 * @implements DatabaseConfigLoaderInterface<Configuration>
 */
class DatabaseConfigLoader implements DatabaseConfigLoaderInterface
{
    /**
     * Create new instance
     * @param ConfigurationRepositoryInterface<Configuration> $repository
     */
    public function __construct(protected ConfigurationRepositoryInterface $repository)
    {
    }

    /**
     * {@inheritdoc}
     */
    public function load(
        string $environment,
        string $group,
        array $filters = []
    ): array {
        return $this->loadDbConfigurations($group, $environment, $filters);
    }

    /**
     * {@inheritdoc}
     */
    public function loadConfig(array $where = []): ?Entity
    {
        return $this->repository->findBy($where);
    }

    /**
     * {@inheritdoc}
     */
    public function insertConfig(array $data): mixed
    {
        $entity = $this->repository->create($data);
        return $this->repository->insert($entity);
    }

    /**
     * {@inheritdoc}
     */
    public function updateConfig(Entity $entity): bool
    {
        return (bool) $this->repository->save($entity);
    }

    /**
     * {@inheritdoc}
     */
    public function all(): array
    {
        return $this->repository->all();
    }

    /**
     * Return the configuration
     * @param string $group
     * @param string|null $env
     * @param array<string, mixed>  $filters the filters to use if any
     * @return array<string, mixed>
     */
    protected function loadDbConfigurations(
        string $group,
        ?string $env = null,
        array $filters = []
    ): array {
        // @codeCoverageIgnoreStart
        $query = $this->repository->filters($filters)
                                  ->query()
                                  ->where('module')->is($group)
                                  ->where('status')->is('Y')

The method is() does not exist on Platine\Database\Query\WhereStatement.

                                  ->where(function (WhereStatement $where) use ($env) {
                                    $where->where('env')->is($env)
                                    ->orWhere('env')->isNull();

The method isNull() does not exist on Platine\Database\Query\WhereStatement.

                                  });
        // @codeCoverageIgnoreEnd

        /** @var Configuration[] $results */
        $results = $query->all();

The method all() does not exist on Platine\Database\Query\WhereStatement. It seems like you code against a sub-type of Platine\Database\Query\WhereStatement such as Platine\Orm\Query\EntityQuery.

The method all() does not exist on Platine\Database\Query\Where.

        $items = [];
        foreach ($results as $result) {
            /** @var string $name */
            $name = $result->name;

The property name does not exist on Platine\Framework\Config\Model\Configuration. Since you implemented __get, consider adding a @property annotation.

            if (!empty($name)) {
                $items[$name] = ConfigUtil::convertToDataType(
                    $result->value,

The property value does not exist on Platine\Framework\Config\Model\Configuration. Since you implemented __get, consider adding a @property annotation.

                    (string) $result->type

The property type does not exist on Platine\Framework\Config\Model\Configuration. Since you implemented __get, consider adding a @property annotation.

                );
            }
        }

        return $items;
    }
}