GraphQLAPI\GraphQLAPI\ModuleResolvers\AbstractCacheFunctionalityModuleResolver

Complexity

Total Complexity

6

Size/Duplication

Total Lines	36
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	enabledEnvironmentBasedBehavior()	0	3	1
A	isEnabledByDefault()	0	7	2
A	getModuleType()	0	3	1
A	isHidden()	0	7	2

<?php

declare(strict_types=1);

namespace GraphQLAPI\GraphQLAPI\ModuleResolvers;

use GraphQLAPI\GraphQLAPI\PluginEnvironment;
use GraphQLAPI\GraphQLAPI\ModuleTypeResolvers\ModuleTypeResolver;

/**
 * The cache modules have different behavior depending on the environment:
 * - "development": visible, disabled by default
 * - "production": hidden, enabled by default
 *
 * @author Leonardo Losoviz <leo@getpop.org>
 */
abstract class AbstractCacheFunctionalityModuleResolver extends AbstractFunctionalityModuleResolver
{
    /**
     * Enable to customize a specific UI for the module
     */
    public function getModuleType(string $module): string
    {
        return ModuleTypeResolver::PERFORMANCE;
    }

    /**
     * Allow to change the behavior based on the environment
     *
     * @return boolean
     */
    protected function enabledEnvironmentBasedBehavior(): bool
    {
        return false;
    }

    public function isHidden(string $module): bool
    {
        if ($this->enabledEnvironmentBasedBehavior()) {
            $environment = PluginEnvironment::getPluginEnvironment();
            return $environment == PluginEnvironment::PLUGIN_ENVIRONMENT_PROD;
        }
        return parent::isHidden($module);
    }

    public function isEnabledByDefault(string $module): bool
    {
        if ($this->enabledEnvironmentBasedBehavior()) {
            $environment = PluginEnvironment::getPluginEnvironment();
            return $environment == PluginEnvironment::PLUGIN_ENVIRONMENT_PROD;
        }
        return parent::isEnabledByDefault($module);
    }
}