Coco\SourceWatcher\Core\Api\ApiReader

Complexity

Total Complexity

13

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setHeaders()	0	3	1
A	getHeaders()	0	3	1
A	setTimeout()	0	3	1
A	setResourceURL()	0	3	1
A	read()	0	35	6
A	getResourceURL()	0	3	1
A	__construct()	0	3	1
A	getTimeout()	0	3	1

<?php

namespace Coco\SourceWatcher\Core\Api;

use Coco\SourceWatcher\Core\SourceWatcherException;
use Coco\SourceWatcher\Utils\Internationalization;

/**
 * Class ApiReader
 *
 * When you describe the endpoint, you list the end path only (hence the term "end point").
 * The full path that contains both the base path and the endpoint is often called a resource URL.
 *
 * @package Coco\SourceWatcher\Core\Api
 */
class ApiReader implements Reader
{
    protected ?string $resourceURL = null;

    protected int $timeout = 5;

    protected array $headers = [];

    protected int $currentAttempt;

    protected int $attempts = 3;

    public function __construct ()
    {
        $this->currentAttempt = 1;
    }

    public function getResourceURL () : string
    {
        return $this->resourceURL;

The expression return $this->resourceURL could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    public function setResourceURL ( string $resourceURL ) : void
    {
        $this->resourceURL = $resourceURL;
    }

    public function getTimeout () : int
    {
        return $this->timeout;
    }

    public function setTimeout ( int $timeout ) : void
    {
        $this->timeout = $timeout;
    }

    public function getHeaders () : array
    {
        return $this->headers;
    }

    public function setHeaders ( array $headers ) : void
    {
        $this->headers = $headers;
    }

    /**
     * @return bool|mixed|string
     * @throws SourceWatcherException
     */
    public function read ()
    {
        if ( $this->resourceURL == null || $this->resourceURL == "" ) {

It seems like you are loosely comparing $this->resourceURL of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            throw new SourceWatcherException( Internationalization::getInstance()->getText( ApiReader::class,
                "No_Resource_URL_Found" ) );
        }

        $curl = curl_init();

        curl_setopt( $curl, CURLOPT_URL, $this->resourceURL );
        curl_setopt( $curl, CURLOPT_RETURNTRANSFER, 1 );
        curl_setopt( $curl, CURLOPT_CONNECTTIMEOUT, $this->timeout );

        if ( !empty( $this->headers ) ) {
            curl_setopt( $curl, CURLOPT_HTTPHEADER, $this->headers );
        }

        /**
         * https://www.php.net/manual/en/function.curl-exec.php
         *
         * Returns TRUE on success or FALSE on failure.
         * However, if the CURLOPT_RETURNTRANSFER option is set, it will return the result on success, FALSE on failure.
         */

        $response = curl_exec( $curl );

        curl_close( $curl );

        if ( !$response && $this->currentAttempt < $this->attempts ) {
            $this->currentAttempt++;

            return $this->read();
        }

        return $response;
    }
}