Gacela\Framework\AbstractConfigGacela

Complexity

Total Complexity

4

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	configReaders()	0	3	1
A	config()	0	3	1
A	mappingInterfaces()	0	3	1
A	customServicesLocation()	0	3	1

<?php

declare(strict_types=1);

namespace Gacela\Framework;

use Gacela\Framework\Config\ConfigReaderInterface;

abstract class AbstractConfigGacela
{
    /**
     * e.g:
     * <code>
     * return [
     *   'path' => '.env*',
     *   'path_local' => '.env',
     * ];
     * # OR
     * return [
     *   [
     *     'path' => '.env*',
     *     'path_local' => '.env',
     *   ],
     *   [
     *     'path' => 'config/*.php',
     *     'path_local' => 'config/local.php',
     *   ],
     * ];
     * </code>
     *
     * <b>path</b>: Define the path where Gacela will read all the config files. Default: <i>config/*.php</i><br>
     * <b>path_local</b>: Define the path where Gacela will read the local config file. Default: <i>config/local.php</i>
     *
     * @return array<array>|array{

The doc comment array<array>|array{ at position 7 could not be parsed: the token is null at position 7.

     *     path?:string,
     *     path_local?:string
     * }
     */
    public function config(): array
    {
        return [];
    }

    /**
     * e.g:
     * <code>
     * return [
     *     'php' => new \Gacela\Framework\Config\ConfigReader\PhpConfigReader(),
     * ];
     * </code>
     *
     * Define the reader class which will read and parse the config files. Default: <i>PhpConfigReader</i>
     *
     * @return array<string,ConfigReaderInterface>
     */
    public function configReaders(): array
    {
        return [];
    }

    /**
     * e.g:
     * <code>
     * return [
     *     // It instantiates the specific class on runtime
     *     AbstractClass::class => SpecificClass::class,
     *
     *     // It resolves the callable on runtime
     *     InterfaceClass::class => fn() => new SpecificClass($dependencies),
     * ];
     * </code>
     *
     * Define the mapping between interfaces and concretions, so Gacela services will auto-resolve them automatically.
     *
     * @param array<string,mixed> $globalServices
     *
     * @return array<class-string,class-string|callable>
     */
    public function mappingInterfaces(array $globalServices): array
    {
        return [];
    }

    /**
     * e.g:
     * <code>
     * return [
     *     'Application',
     *     'Infrastructure\Persistence',
     * ];
     * </code>
     *
     * Define namespaces (relative to a module) where Gacela should check for custom services that will be auto-resolved.
     * The classes that you want to use as custom services must extend `Gacela\Framework\AbstractCustomService`.
     *
     * @return list<string>
     */
    public function customServicesLocation(): array
    {
        return [];
    }
}