KEINOS\MSTDN_TOOLS\Config\Config

Complexity

Total Complexity

13

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	22	2
A	setOptionalSettings()	0	20	6
A	setDefaultSettings()	0	6	1
A	requestApiInstance()	0	13	2
A	generateUrlApiInstance()	0	9	2

<?php

/**
 * This file is the main class of the keinos/mastodon-streaming-api-config package.
 *
 * - Reference of the public methods of this class to use:
 *   - See: ./ConfigInterface.php
 * - Authors, copyright, license, usage and etc.:
 *   - See: https://github.com/KEINOS/Mastodon_StreamingAPI_Config/
 *
 * Note:
 * - Non static public methods or properties must be defined here.
 * - Only the public method "__construct()" is defined in "ConfigProtectedMethods".
 * - Static methods and properties must be defined in "ConfigStaticMethods".
 * - Protected methods/properties must be defined in "ConfigProtectedMethods".
 * - Class constants must be defined in "ConfigConstants".
 *
 * Debug:
 * - To test and analyze the scripts:
 *   - Run: `$ composer test all verbose` (Composer is required)
 */

declare(strict_types=1);

namespace KEINOS\MSTDN_TOOLS\Config;

use Symfony\Component\HttpClient\HttpClient;

The type Symfony\Component\HttpClient\HttpClient was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * This class holds and provides Mastodon server, a.k.a instance, information to
 * receive server-sent messages from Mastodon Streaming API.
 */
class Config implements ConfigInterface
{
    use PropertiesTrait;
    use StaticMethodsTrait;

    //public const CRLF = "\r\n";
    //public const ENDPOINT_API_STREAM_PUBLIC = '/api/v1/streaming/public';
    //public const ENDPOINT_API_STREAM_LOCAL  = '/api/v1/streaming/public/local';
    public const ACCESS_TOKEN_DEFAULT = '';
    public const CACHE_PREFIX_DEFAULT = 'mstdn_tools_cache_';
    public const CACHE_TTL_DEFAULT    = 60 * 60 * 1; // 1 hour
    public const ENDPOINT_API_INSTANCE_DEFAULT = '/api/v1/instance';
    public const FLAG_USE_CACHE_DEFAULT = true;

    /**
     * {@inheritdoc}
     *
     * @param  array<string,mixed> $settings
     * @return void
     * @throws \Exception
     */
    public function __construct(array $settings)
    {
        /* Set must settings */
        if (isset($settings['url_host'])) {
            $this->setUrlHost($settings['url_host']);
        } else {
            $msg = '"url_host" key missing. URL of the Mastodon server/instance is required.';
            throw new \Exception($msg);
        }

        /* Set default settings */
        $this->setDefaultSettings();

        /* Set optional settings */
        $this->setOptionalSettings($settings);

        $url_api_instance = $this->generateUrlApiInstance();
        $this->setUrlApiInstance($url_api_instance);

        /* Set host info from API method of Instance */
        $info_instance = $this->requestApiInstance();
        $this->setInfoInstance($info_instance);
    }

    /**
     * @return array<mixed,mixed>
     * @throws \Exception
     */
    protected function requestApiInstance(): array
    {
        try {
            $client_http      = HttpClient::create();
            $url_api_instance = $this->getUrlApiInstance();

            // Get contents as array
            $response = $client_http->request('GET', $url_api_instance);
            return $response->toArray();
        } catch (\Exception $e) {
            $msg = 'Error while getting the server info from the API.' . PHP_EOL
                 . '- Error details: ' . $e->getMessage() . PHP_EOL;
            throw new \Exception($msg);
        }
    }

    protected function setDefaultSettings(): void
    {
        $this->setAccessToken(self::ACCESS_TOKEN_DEFAULT);
        $this->setEndpointApiInstance(self::ENDPOINT_API_INSTANCE_DEFAULT);
        $this->setFlagUseCache(self::FLAG_USE_CACHE_DEFAULT);
        $this->setIdHashSelf(strval(hash_file('md5', __FILE__)));
    }

    /**
     * @param  array<string,mixed> $settings
     * @return void
     * @throws \Exception
     */
    protected function setOptionalSettings(array $settings): void
    {
        if (isset($settings['access_token'])) {
            $this->setAccessToken($settings['access_token']);
        }

        if (isset($settings['endpoint_api_instance'])) {
            $this->setEndpointApiInstance($settings['endpoint_api_instance']);
        }

        if (isset($settings['flag_use_cache'])) {
            $this->setFlagUseCache($settings['setFlagUseCache']);
        }

        if (isset($settings['id_hash_self'])) {
            $this->setIdHashSelf($settings['setIdHashSelf']);
        }

        if (isset($settings['ttl_cache'])) {
            $this->setTtlCache($settings['ttl_cache']);
        }
    }

    /**
     * @return string
     * @throws \Exception
     */
    protected function generateUrlApiInstance(): string
    {
        $url_api_instance = rtrim($this->getUrlHost(), '/') . $this->getEndpointApiInstance();
        if (! self::isUrlAlive($url_api_instance)) {
            $msg = 'Invalid settings given. Can NOT access to the endpoint URL. URL: '
                 . $url_api_instance . PHP_EOL;
            throw new \Exception($msg);
        }
        return $url_api_instance;
    }
}