GraphQLAPI\GraphQLAPI\ComponentConfiguration

Complexity

Total Complexity

6

Size/Duplication

Total Lines	158
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getPersistedQuerySlugBase()	0	14	1
A	getSettingsValueLabel()	0	15	1
A	getCustomEndpointSlugBase()	0	14	1
A	getEmptyLabel()	0	14	1
A	groupFieldsUnderTypeForPrint()	0	16	1
A	getEditingAccessScheme()	0	14	1

<?php

declare(strict_types=1);

namespace GraphQLAPI\GraphQLAPI;

use GraphQLAPI\GraphQLAPI\Security\UserAuthorization;
use PoP\ComponentModel\ComponentConfiguration\EnvironmentValueHelpers;
use PoP\ComponentModel\ComponentConfiguration\ComponentConfigurationTrait;

class ComponentConfiguration
{
    use ComponentConfigurationTrait;

    // private static string $getModuleURLBase;
    private static bool $groupFieldsUnderTypeForPrint = false;
    private static string $getEmptyLabel = '';
    private static string $getSettingsValueLabel = '';
    private static ?string $getCustomEndpointSlugBase = null;
    private static ?string $getPersistedQuerySlugBase = null;
    private static ?string $getEditingAccessScheme = null;

    // /**
    //  * URL base for the module, pointing to graphql-api.com
    //  *
    //  * @return string
    //  */
    // public static function getModuleURLBase(): string
    // {
    //     // Define properties
    //     $envVariable = Environment::MODULE_URL_BASE;
    //     $selfProperty = &self::$getModuleURLBase;
    //     $defaultValue = 'https://graphql-api.com/modules/';

    //     // Initialize property from the environment/hook
    //     self::maybeInitializeConfigurationValue(
    //         $envVariable,
    //         $selfProperty,
    //         $defaultValue
    //     );
    //     return $selfProperty;
    // }

    /**
     * Group the fields under the type when printing it for the user
     *
     * @return boolean
     */
    public static function groupFieldsUnderTypeForPrint(): bool
    {
        // Define properties
        $envVariable = Environment::GROUP_FIELDS_UNDER_TYPE_FOR_PRINT;
        $selfProperty = &self::$groupFieldsUnderTypeForPrint;
        $defaultValue = true;
        $callback = [EnvironmentValueHelpers::class, 'toBool'];

        // Initialize property from the environment/hook
        self::maybeInitializeConfigurationValue(
            $envVariable,
            $selfProperty,
            $defaultValue,
            $callback
        );
        return $selfProperty;
    }

    /**
     * The label to show when the value is empty
     */
    public static function getEmptyLabel(): string
    {
        // Define properties
        $envVariable = Environment::EMPTY_LABEL;
        $selfProperty = &self::$getEmptyLabel;
        $defaultValue = \__('---', 'graphql-api');

        // Initialize property from the environment/hook
        self::maybeInitializeConfigurationValue(
            $envVariable,
            $selfProperty,
            $defaultValue
        );
        return $selfProperty;
    }

    /**
     * The label to show when the value comes from the settings
     */
    public static function getSettingsValueLabel(): string
    {
        // Define properties
        $envVariable = Environment::SETTINGS_VALUE_LABEL;
        $selfProperty = &self::$getSettingsValueLabel;
        // $defaultValue = \__('As defined in the General Settings', 'graphql-api');
        $defaultValue = \__('Default', 'graphql-api');

        // Initialize property from the environment/hook
        self::maybeInitializeConfigurationValue(
            $envVariable,
            $selfProperty,
            $defaultValue
        );
        return $selfProperty;
    }

    /**
     * The slug to use as base when accessing the custom endpoint
     *
     * @return string
     */
    public static function getCustomEndpointSlugBase(): string
    {
        // Define properties
        $envVariable = Environment::ENDPOINT_SLUG_BASE;
        $selfProperty = &self::$getCustomEndpointSlugBase;
        $defaultValue = 'graphql';

        // Initialize property from the environment/hook
        self::maybeInitializeConfigurationValue(
            $envVariable,
            $selfProperty,
            $defaultValue
        );
        return $selfProperty;
    }

    /**
     * The slug to use as base when accessing the persisted query
     *
     * @return string
     */
    public static function getPersistedQuerySlugBase(): string
    {
        // Define properties
        $envVariable = Environment::PERSISTED_QUERY_SLUG_BASE;
        $selfProperty = &self::$getPersistedQuerySlugBase;
        $defaultValue = 'graphql-query';

        // Initialize property from the environment/hook
        self::maybeInitializeConfigurationValue(
            $envVariable,
            $selfProperty,
            $defaultValue
        );
        return $selfProperty;
    }

    /**
     * If `"admin"`, only the admin can compose a GraphQL query and endpoint
     * If `"post"`, the workflow from creating posts is employed (i.e. Author role can create
     * but not publish the query, Editor role can publish it, etc)
     *
     * @return string
     */
    public static function getEditingAccessScheme(): string
    {
        // Define properties
        $envVariable = Environment::EDITING_ACCESS_SCHEME;
        $selfProperty = &self::$getEditingAccessScheme;
        $defaultValue = UserAuthorization::ACCESS_SCHEME_ADMIN_ONLY;

        // Initialize property from the environment/hook
        self::maybeInitializeConfigurationValue(
            $envVariable,
            $selfProperty,
            $defaultValue
        );
        return $selfProperty;
    }
}