ApiReader::read() - Code Metrics - TheCocoTeam/source-watcher-core - Measure and Improve Code Quality continuously with Scrutinizer

ApiReader::read() A
last analyzed 2021-12-28 03:33 UTC

↳ Parent: ApiReader

Complexity

Conditions	6
Paths	5

Size

Total Lines	35
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	6
eloc	15
c	1
b	0
f	0
nc	5
nop	0
dl	0
loc	35
rs	9.2222

<?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;

    }

    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 == "" ) {

            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;
    }
}


1			<?php
2
3			namespace Coco\SourceWatcher\Core\Api;
4
5			use Coco\SourceWatcher\Core\SourceWatcherException;
6			use Coco\SourceWatcher\Utils\Internationalization;
7
8			/**
9			* Class ApiReader
10			*
11			* When you describe the endpoint, you list the end path only (hence the term "end point").
12			* The full path that contains both the base path and the endpoint is often called a resource URL.
13			*
14			* @package Coco\SourceWatcher\Core\Api
15			*/
16			class ApiReader implements Reader
17			{
18			protected ?string $resourceURL = null;
19
20			protected int $timeout = 5;
21
22			protected array $headers = [];
23
24			protected int $currentAttempt;
25
26			protected int $attempts = 3;
27
28			public function __construct ()
29			{
30			$this->currentAttempt = 1;
31			}
32
33			public function getResourceURL () : string
34			{
35			return $this->resourceURL;
			0 ignored issues – show Bug Best Practice introduced 2020-10-09 19:21 UTC by Report Bug Copy Issue Report 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. Loading history...
36			}
37
38			public function setResourceURL ( string $resourceURL ) : void
39			{
40			$this->resourceURL = $resourceURL;
41			}
42
43			public function getTimeout () : int
44			{
45			return $this->timeout;
46			}
47
48			public function setTimeout ( int $timeout ) : void
49			{
50			$this->timeout = $timeout;
51			}
52
53			public function getHeaders () : array
54			{
55			return $this->headers;
56			}
57
58			public function setHeaders ( array $headers ) : void
59			{
60			$this->headers = $headers;
61			}
62
63			/**
64			* @return bool\|mixed\|string
65			* @throws SourceWatcherException
66			*/
67			public function read ()
68			{
69			if ( $this->resourceURL == null \|\| $this->resourceURL == "" ) {
			0 ignored issues – show Bug introduced 2020-05-23 01:06 UTC by Report Bug Copy Issue Report 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. Loading history...
70			throw new SourceWatcherException( Internationalization::getInstance()->getText( ApiReader::class,
71			"No_Resource_URL_Found" ) );
72			}
73
74			$curl = curl_init();
75
76			curl_setopt( $curl, CURLOPT_URL, $this->resourceURL );
77			curl_setopt( $curl, CURLOPT_RETURNTRANSFER, 1 );
78			curl_setopt( $curl, CURLOPT_CONNECTTIMEOUT, $this->timeout );
79
80			if ( !empty( $this->headers ) ) {
81			curl_setopt( $curl, CURLOPT_HTTPHEADER, $this->headers );
82			}
83
84			/**
85			* https://www.php.net/manual/en/function.curl-exec.php
86			*
87			* Returns TRUE on success or FALSE on failure.
88			* However, if the CURLOPT_RETURNTRANSFER option is set, it will return the result on success, FALSE on failure.
89			*/
90
91			$response = curl_exec( $curl );
92
93			curl_close( $curl );
94
95			if ( !$response && $this->currentAttempt < $this->attempts ) {
96			$this->currentAttempt++;
97
98			return $this->read();
99			}
100
101			return $response;
102			}
103			}
104

TheCocoTeam / source-watcher-core

ApiReader::read() A last analyzed 2021-12-28 03:33 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ApiReader::read() A
last analyzed 2021-12-28 03:33 UTC