Request::setReferrer() - Code Metrics - Inspection of "better code coverage" - PiedWeb/Curl - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( ef74f3...d652f7 )

by Dev
created 2019-01-07 20:01 UTC
Request::setReferrer() A

↳ Parent: Request
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	3
CRAP Score	1
Importance

Changes
Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	5
ccs	3
cts	3
cp	1
crap	1
rs	10
c	0
b	0
f	0
<?php

namespace PiedWeb\Curl;

class Request
{
    use UserAgentTrait;

    /**
     * Curl resource handle.
     *
     * @var resource
     */
    private $handle;

    /** @var string contains targeted URL */
    private $url;

    /** @var int */
    private $returnHeader = 0;

    /** @var mixed */
    private $filter;

    /**
     * Constructor.
     *
     * @param string $ur to request
     */
    public function __construct(?string $url = null)
    {
        $this->handle = curl_init();
        $this->setOpt(CURLOPT_RETURNTRANSFER, 1);

        $this->setUrl($url);
        $this->setUrl(/** @scrutinizer ignore-type */ $url);
    }

    /**
     * Change the URL to cURL.
     *
     * @param string $url to request
     *
     * @return self
     */
    public function setUrl(string $url)
    {
        $this->url = $url;
        $this->setOpt(CURLOPT_URL, $url);

        return $this;
    }

    /**
     * Add a cURL's option.
     *
     * @param int   $option cURL Predefined Constant
     * @param mixed $value
     *
     * @return self
     */
    public function setOpt($option, $value)
    {
        curl_setopt($this->handle, $option, $value);

        return $this;
    }

    /**
     * A short way to set some classic options to cURL a web page.
     *
     * @return self
     */
    public function setDefaultGetOptions(
        $connectTimeOut = 5,
        $timeOut = 10,
        $dnsCacheTimeOut = 600,
        $followLocation = true,
        $maxRedirs = 5
    ) {
        $this
            ->setOpt(CURLOPT_AUTOREFERER, 1)
            ->setOpt(CURLOPT_FOLLOWLOCATION, $followLocation)
            ->setOpt(CURLOPT_MAXREDIRS, $maxRedirs)
            ->setOpt(CURLOPT_CONNECTTIMEOUT, $connectTimeOut)
            ->setOpt(CURLOPT_DNS_CACHE_TIMEOUT, $dnsCacheTimeOut)
            ->setOpt(CURLOPT_TIMEOUT, $timeOut)
             //->setOpt(CURLOPT_SSL_VERIFYPEER,    0);
        ;

        return $this;
    }

    /**
     * A short way to set some classic options to cURL a web page quickly
     * (but loosing some data like header, cookie...).
     *
     * @return self
     */
    public function setDefaultSpeedOptions(bool $cookie = false)
    {
        $this->setOpt(CURLOPT_SSL_VERIFYHOST, 0);
        $this->setOpt(CURLOPT_SSL_VERIFYPEER, 0);

        if (!$this->returnHeader) {
            $this->setOpt(CURLOPT_HEADER, 0);
        }
        if (!$cookie) {
            $this->setOpt(CURLOPT_COOKIE, 0);
        }
        $this->setDefaultGetOptions(5, 10, 600, true, 1);
        $this->setEncodingGzip();

        return $this;
    }

    /**
     * Call it if you want header informations.
     * After self::execute(), you would have this informations with getHeader();.
     *
     * @return self
     */
    public function setReturnHeader($only = false)
    {
        $this->setOpt(CURLOPT_HEADER, 1);
        $this->returnHeader = $only ? 2 : 1;

        if ($only) {
            $this->setOpt(CURLOPT_RETURNTRANSFER, 0);
            $this->setOpt(CURLOPT_NOBODY, 1);
        }

        return $this;
    }

    /**
     * An self::setOpt()'s alias to add a cookie to your request.
     *
     * @param string $cookie
     *
     * @return self
     */
    public function setCookie($cookie)
    {
        $this->setOpt(CURLOPT_COOKIE, $cookie);

        return $this;
    }

    /**
     * An self::setOpt()'s alias to add a referer to your request.
     *
     * @param string $referer
     *
     * @return self
     */
    public function setReferer($referer)
    {
        $this->setOpt(CURLOPT_REFERER, $referer);

        return $this;
    }

    /**
     * An self::setOpt()'s alias to add an user-agent to your request.
     *
     * @param string $ua
     *
     * @return self
     */
    public function setUserAgent($ua)
    {
        $this->setOpt(CURLOPT_USERAGENT, $ua);

        return $this;
    }

    /**
     * A short way to set post's options to cURL a web page.
     *
     * @param mixed if it's an array, will be converted via http build query
filter:
    dependency_paths: ["lib/*"]
     *
     * @return self
     */
    public function setPost($post)
    {
        $this->setOpt(CURLOPT_CUSTOMREQUEST, 'POST');
        $this->setOpt(CURLOPT_POST, 1);
        $this->setOpt(CURLOPT_POSTFIELDS, is_array($post) ? http_build_query($post) : $post);

        return $this;
    }

    /**
     * If you want to request the URL and hope get the result gzipped.
     * The output will be automatically uncompress with execute();.
     *
     * @return self
     */
    public function setEncodingGzip()
    {
        $this->setOpt(CURLOPT_ENCODING, 'gzip, deflate');

        return $this;
    }

    /**
     * If you want to request the URL with a (http|socks...) proxy (public or private).
     *
     * @param string $proxy [scheme]IP:PORT[:LOGIN:PASSWORD]
     *                      Eg. : socks5://98.023.023.02:1098:cUrlRequestProxId:SecretPassword
     *
     * @return self
     */
    public function setProxy($proxy)
    {
        if (!empty($proxy)) {
            $scheme = Helper::getSchemeFrom($proxy);
            $proxy = explode(':', $proxy);
            $this->setOpt(CURLOPT_HTTPPROXYTUNNEL, 1);
            $this->setOpt(CURLOPT_PROXY, $scheme.$proxy[0].':'.$proxy[1]);
            if (isset($proxy[2])) {
                $this->setOpt(CURLOPT_PROXYUSERPWD, $proxy[2].':'.$proxy[3]);
            }
        }

        return $this;
    }

    /**
     * @param mixed $ContentType string or array
     *
     * @return self
     */
    public function setDownloadOnlyIf($ContentType = 'text/html')
    {
        $this->setReturnHeader();

        $this->filter = is_array($ContentType) ? $ContentType : [$ContentType];
        $this->setOpt(CURLOPT_HEADERFUNCTION, [$this, 'checkHeaderContentType']);
        $this->setOpt(CURLOPT_NOBODY, 1);

        return $this;
    }

    public function checkHeaderContentType($handle, $line)
    {
        if (is_string($line)) {
            foreach ($this->filter as $filter) {
                if (Helper::checkContentType($line, $filter)) {
                    $this->setOpt(CURLOPT_NOBODY, 0); //curl_setopt($handle, CURLOPT_NOBODY, 0);
                }
            }
        }

        return strlen($line);
    }

    /**
     * Execute the request.
     *
     * @return Requested
filter:
    dependency_paths: ["lib/*"]
     */
    public function exec()
    {
        $return = Response::get($this->handle, $this->url, $this->returnHeader);

        if ($return instanceof Response) {
            $this->setReferer($return->getEffectiveUrl());
        }

        return $return;
    }

    /**
     * Return the last error number (curl_errno).
     *
     * @return int the error number or 0 (zero) if no error occurred
     */
    public function hasError()
    {
        return curl_errno($this->handle);
    }

    /**
     * Return a string containing the last error for the current session (curl_error).
     *
     * @return string the error message or '' (the empty string) if no error occurred
     */
    public function getError()
    {
        return curl_error($this->handle);
    }

    /**
     * Get information regarding the request.
     *
     * @param int This may be one of the following constants:
filter:
    dependency_paths: ["lib/*"]
     *            http://php.net/manual/en/function.curl-getinfo.php
     *
     * @return array|string|false
     */
    public function getInfo(?int $opt)
    {
        return $opt ? curl_getinfo($this->handle, $opt) : curl_getinfo($this->handle);
    }

    /**
     * Close the connexion
     * Call curl_reset function.
     */
    public function close()
    {
        curl_reset($this->handle);
    }
}

PiedWeb / Curl

Push — master ( ef74f3...d652f7 )

Request::setReferrer() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
