WBW\Library\CURL\Configuration\CURLConfiguration

Complexity

Total Complexity

39

Size/Duplication

Total Lines	503
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

38 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	addHeader()	0	5	1
A	clearHeaders()	0	3	1
A	getAllowEncoding()	0	3	1
A	getConnectTimeout()	0	3	1
A	getDebug()	0	3	1
A	getDebugFile()	0	3	1
A	getHeaders()	0	3	1
A	getHost()	0	3	1
A	getHttpPassword()	0	3	1
A	getHttpUsername()	0	3	1
A	getProxyHost()	0	3	1
A	getProxyPassword()	0	3	1
A	getProxyPort()	0	3	1
A	getProxyType()	0	3	1
A	getProxyUsername()	0	3	1
A	getRequestTimeout()	0	3	1
A	getSslVerification()	0	3	1
A	getUserAgent()	0	3	1
A	getVerbose()	0	3	1
A	removeHeader()	0	5	2
A	setAllowEncoding()	0	4	1
A	setConnectTimeout()	0	4	1
A	setDebug()	0	4	1
A	setDebugFile()	0	4	1
A	setHeaders()	0	4	1
A	setHost()	0	4	1
A	setHttpPassword()	0	4	1
A	setHttpUsername()	0	4	1
A	setProxyHost()	0	4	1
A	setProxyPassword()	0	4	1
A	setProxyPort()	0	4	1
A	setProxyType()	0	4	1
A	setProxyUsername()	0	4	1
A	setRequestTimeout()	0	4	1
A	setSslVerification()	0	4	1
A	setUserAgent()	0	4	1
A	setVerbose()	0	4	1

<?php

/**
 * This file is part of the curl-library package.
 *
 * (c) 2017 WEBEWEB
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WBW\Library\CURL\Configuration;

use WBW\Library\Core\Exception\Argument\StringArgumentException;
use WBW\Library\Core\Argument\ArgumentHelper;

/**
 * cURL configuration.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Library\CURL\Configuration
 */
class CURLConfiguration {

    /**
     * Allow encoding.
     *
     * @var boolean
     */
    private $allowEncoding = false;

    /**
     * HTTP connect timeout.
     *
     * @var integer
     */
    private $connectTimeout = 0;

    /**
     * Debug.
     *
     * @var boolean
     */
    private $debug = false;

    /**
     * Debug file.
     *
     * @var string
     */
    private $debugFile = "php://output";

    /**
     * Headers.
     *
     * @var array
     */
    private $headers = [];

    /**
     * Host.
     *
     * @var string
     */
    private $host;

    /**
     * HTTP basic password.
     *
     * @var string
     */
    private $httpPassword;

    /**
     * HTTP basic username.
     *
     * @var string
     */
    private $httpUsername;

    /**
     * Proxy host.
     *
     * @var string
     */
    private $proxyHost;

    /**
     * Proxy password.
     *
     * @var string
     */
    private $proxyPassword;

    /**
     * Proxy port.
     *
     * @var integer
     */
    private $proxyPort;

    /**
     * Proxy type.
     *
     * @var integer
     */
    private $proxyType;

    /**
     * Proxy username.
     *
     * @var string
     */
    private $proxyUsername;

    /**
     * HTTP request timeout.
     *
     * @var integer
     */
    private $requestTimeout = 0;

    /**
     * SSL verification.
     *
     * @var boolean
     */
    private $sslVerification = true;

    /**
     * User agent.
     *
     * @var string
     */
    private $userAgent = "webeweb/curl-library";

    /**
     * Verbose.
     *
     * @var boolean
     */
    private $verbose = false;

    /**
     * Constructor.
     */
    public function __construct() {
        // NOTHING TO DO.
    }

    /**
     * Add an header.
     *
     * @param string $name The header name.
     * @param string $value The header value.
     * @return CURLConfiguration Returns this CURL configuration.
     * @throws StringArgumentException Throws a string argument exception if the argument is not a string.
     */
    public function addHeader($name, $value) {
        ArgumentHelper::isTypeOf($name, ArgumentHelper::ARGUMENT_STRING);
        $this->headers[$name] = $value;
        return $this;
    }

    /**
     * Clear the headers.
     *
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function clearHeaders() {
        return $this->setHeaders();
    }

    /**
     * Get the allow encoding.
     *
     * @return boolean Returns the allow encoding.
     */
    public function getAllowEncoding() {
        return $this->allowEncoding;
    }

    /**
     * Get the connect timeout.
     *
     * @return integer Returns the connect timeout.
     */
    public function getConnectTimeout() {
        return $this->connectTimeout;
    }

    /**
     * Ge the debug.
     *
     * @return boolen Returns the debug.
     */
    public function getDebug() {
        return $this->debug;
    }

    /**
     * Get the debug file.
     *
     * @return string Returns the debug file.
     */
    public function getDebugFile() {
        return $this->debugFile;
    }

    /**
     * Get the headers.
     *
     * @return array Returns the headers.
     */
    public function getHeaders() {
        return $this->headers;
    }

    /**
     * Get the host.
     *
     * @return string Returns the host.
     */
    public function getHost() {
        return $this->host;
    }

    /**
     * Get the HTTP password.
     *
     * @return string Returns the HTTP password.
     */
    public function getHttpPassword() {
        return $this->httpPassword;
    }

    /**
     * Get the HTTP username.
     *
     * @return string Returns the HTTP username.
     */
    public function getHttpUsername() {
        return $this->httpUsername;
    }

    /**
     * Get the proxy host.
     *
     * @return string Returns the proxy host.
     */
    public function getProxyHost() {
        return $this->proxyHost;
    }

    /**
     * Get the proxy password.
     *
     * @return string Returns the proxy password.
     */
    public function getProxyPassword() {
        return $this->proxyPassword;
    }

    /**
     * Get the proxy port.
     *
     * @return integer Returns the proxy port.
     */
    public function getProxyPort() {
        return $this->proxyPort;
    }

    /**
     * Get the proxy type.
     *
     * @return integer Returns the proxy type.
     */
    public function getProxyType() {
        return $this->proxyType;
    }

    /**
     * Get the proxy username.
     *
     * @return string Returns the proxy username.
     */
    public function getProxyUsername() {
        return $this->proxyUsername;
    }

    /**
     * Get the request timeout.
     *
     * @return integer Returns the request timeout.
     */
    public function getRequestTimeout() {
        return $this->requestTimeout;
    }

    /**
     * Get the SSL verification.
     *
     * @return boolean Returns the SSL verification.
     */
    public function getSslVerification() {
        return $this->sslVerification;
    }

    /**
     * Get the user agent.
     *
     * @return string Returns the user agent.
     */
    public function getUserAgent() {
        return $this->userAgent;
    }

    /**
     * Get the verbose.
     *
     * @return boolean Returns the verbose.
     */
    public function getVerbose() {
        return $this->verbose;
    }

    /**
     * Remove an header.
     *
     * @param string $name The header name.
     */
    public function removeHeader($name) {
        if (true === array_key_exists($name, $this->headers)) {
            unset($this->headers[$name]);
        }
    }

    /**
     * Set the allow encoding.
     *
     * @param boolean $allowEncoding The allow encoding.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setAllowEncoding($allowEncoding = false) {
        $this->allowEncoding = $allowEncoding;
        return $this;
    }

    /**
     * Set the connect timeout.
     *
     * @param integer $connectTimeout The connect timeout.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setConnectTimeout($connectTimeout = 0) {
        $this->connectTimeout = $connectTimeout;
        return $this;
    }

    /**
     * Set the debug.
     *
     * @param boolean $debug The debug.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setDebug($debug = false) {
        $this->debug = $debug;
        return $this;
    }

    /**
     * Set the debug file.
     *
     * @param string $debugFile The debug file.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setDebugFile($debugFile = "php://output") {
        $this->debugFile = $debugFile;
        return $this;
    }

    /**
     * Set the headers.
     *
     * @param array $headers The headers
     * @return CURLConfiguration Returns this CURL configuration.
     */
    protected function setHeaders(array $headers = []) {
        $this->headers = $headers;
        return $this;
    }

    /**
     * Set the host.
     *
     * @param string $host The host.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setHost($host) {
        $this->host = preg_replace("/\/$/", "", trim($host));
        return $this;
    }

    /**
     * Set the HTTP basic password.
     *
     * @param string $httpPassword The HTTP basic password.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setHttpPassword($httpPassword) {
        $this->httpPassword = $httpPassword;
        return $this;
    }

    /**
     * Set the HTTP basic username.
     *
     * @param string $httpUsername The HTTP basic username.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setHttpUsername($httpUsername) {
        $this->httpUsername = $httpUsername;
        return $this;
    }

    /**
     * Set the proxy host.
     *
     * @param string $proxyHost The proxy host.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setProxyHost($proxyHost) {
        $this->proxyHost = $proxyHost;
        return $this;
    }

    /**
     * Set the proxy password.
     *
     * @param string $proxyPassword The proxy password.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setProxyPassword($proxyPassword) {
        $this->proxyPassword = $proxyPassword;
        return $this;
    }

    /**
     * Set the proxy port.
     *
     * @param integer $proxyPort The proxy port.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setProxyPort($proxyPort) {
        $this->proxyPort = $proxyPort;
        return $this;
    }

    /**
     * Set the proxy type.
     *
     * @param integer $proxyType The proxy type.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setProxyType($proxyType) {
        $this->proxyType = $proxyType;
        return $this;
    }

    /**
     * Set the proxy username.
     *
     * @param string $proxyUsername The proxy username.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setProxyUsername($proxyUsername) {
        $this->proxyUsername = $proxyUsername;
        return $this;
    }

    /**
     * Set the request timeout.
     *
     * @param integer $requestTimeout The request timeout.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setRequestTimeout($requestTimeout = 0) {
        $this->requestTimeout = $requestTimeout;
        return $this;
    }

    /**
     * Set the SSL verification.
     *
     * @param boolean $sslVerification The SSL verification.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setSslVerification($sslVerification = true) {
        $this->sslVerification = $sslVerification;
        return $this;
    }

    /**
     * Set the user agent.
     *
     * @param string $userAgent The user agent.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setUserAgent($userAgent = "webeweb/curl-library") {
        $this->userAgent = $userAgent;
        return $this;
    }

    /**
     * Set the verbose.
     *
     * @param boolean $verbose The verbose.
     * @return CURLConfiguration Returns this CURL configuration.
     */
    public function setVerbose($verbose = false) {
        $this->verbose = $verbose;
        return $this;
    }

}