Coco\SourceWatcher\Core\Api\ApiReader

Complexity

Total Complexity

10

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setEndpoint()	0	3	1
A	setTimeout()	0	3	1
A	read()	0	31	5
A	__construct()	0	3	1
A	getEndpoint()	0	3	1
A	getTimeout()	0	3	1

<?php

namespace Coco\SourceWatcher\Core\Api;

use Coco\SourceWatcher\Core\SourceWatcherException;

/**
 * Class ApiReader
 * @package Coco\SourceWatcher\Core\Api
 */
class ApiReader implements Reader
{
    /**
     * @var string
     */
    protected string $endpoint;

    /**
     * @var int
     */
    protected int $timeout = 5;

    /**
     * @var int
     */
    protected int $currentAttempt;

    /**
     * @var int
     */
    protected int $attempts = 3;

    /**
     * ApiReader constructor.
     */
    public function __construct ()
    {
        $this->currentAttempt = 1;
    }

    /**
     * @return string
     */
    public function getEndpoint () : string
    {
        return $this->endpoint;
    }

    /**
     * @param string $endpoint
     */
    public function setEndpoint ( string $endpoint ) : void
    {
        $this->endpoint = $endpoint;
    }

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

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

    /**
     * @return bool|string
     * @throws SourceWatcherException
     */
    public function read ()
    {
        if ( $this->endpoint == null || $this->endpoint == "" ) {
            throw new SourceWatcherException( "No endpoint found." );
        }

        $curl = curl_init();

        curl_setopt( $curl, CURLOPT_URL, $this->endpoint );

It seems like $curl can also be of type false; however, parameter $ch of curl_setopt() does only seem to accept resource, maybe add an additional type check?

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

        /**
         * 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 );

It seems like $curl can also be of type false; however, parameter $ch of curl_exec() does only seem to accept resource, maybe add an additional type check?

        curl_close( $curl );

It seems like $curl can also be of type false; however, parameter $ch of curl_close() does only seem to accept resource, maybe add an additional type check?

        if ( $response == false ) {

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

            if ( $this->currentAttempt < $this->attempts ) {
                $this->currentAttempt++;
                $this->read();
            }
        }

        return $response;
    }
}