ApiReader::getResourceURL() - Code Metrics - Inspection of "Adding texts for source watcher class to us yml, a..." - TheCocoTeam/source-watcher-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( eaba1f...4ca8dc )

by Jean Paul

created 2020-05-26 21:21 UTC

ApiReader::getResourceURL() A

↳ Parent: ApiReader

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?php

namespace Coco\SourceWatcher\Core\Api;

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

/**
 * 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
{
    /**
     * @var string
     */
    protected ?string $resourceURL = null;

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

    /**
     * @var array
     */
    protected array $headers = [];

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

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

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

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

    }

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

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

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

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

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

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

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

        $curl = curl_init();

        curl_setopt( $curl, CURLOPT_URL, $this->resourceURL );
        curl_setopt( /** @scrutinizer ignore-type */ $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 );
        $response = curl_exec( /** @scrutinizer ignore-type */ $curl );

        curl_close( $curl );
        curl_close( /** @scrutinizer ignore-type */ $curl );

        if ( $response == false ) {

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

        return $response;
    }
}


TheCocoTeam / source-watcher-core

Push — master ( eaba1f...4ca8dc )

ApiReader::getResourceURL() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like