eBayEnterprise\RetailOrderManagement\Payload\Order\TBrowserData

Complexity

Total Complexity

37

Size/Duplication

Total Lines	285
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	6
Bugs	0	Features	1

38 Methods

Rating	Name	Duplication	Size	Complexity
A	getHostname()	0	4	1
A	getIpAddress()	0	4	1
A	getSessionId()	0	4	1
A	getUserAgent()	0	4	1
A	getConnection()	0	4	1
A	getCookies()	0	4	1
A	getUserCookie()	0	4	1
A	getUserAgentOs()	0	4	1
A	getUserAgentCpu()	0	4	1
A	getHeaderFrom()	0	4	1
A	getWebBrowserName()	0	4	1
A	getJavascriptData()	0	4	1
A	getReferrer()	0	4	1
A	getContentTypes()	0	4	1
A	getEncoding()	0	4	1
A	getLanguage()	0	4	1
A	getCharSet()	0	4	1
A	isValidIpAddress()	0	4	1
	serializeOptionalXmlEncodedValue()	0	1	?
	xmlEncode()	0	1	?
A	setHostname()	0	5	1
A	setIpAddress()	0	5	2
A	setSessionId()	0	5	1
A	setUserAgent()	0	5	1
A	setConnection()	0	5	1
A	setCookies()	0	5	1
A	setUserCookie()	0	5	1
A	setUserAgentOs()	0	5	1
A	setUserAgentCpu()	0	5	1
A	setHeaderFrom()	0	5	1
A	setWebBrowserName()	0	5	1
A	setJavascriptData()	0	5	1
A	setReferrer()	0	5	1
A	setContentTypes()	0	5	1
A	setEncoding()	0	5	1
A	setLanguage()	0	5	1
A	setCharSet()	0	5	1
B	serializeBrowserData()	0	24	1

<?php
/**
 * Copyright (c) 2013-2014 eBay Enterprise, Inc.
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * @copyright   Copyright (c) 2013-2015 eBay Enterprise, Inc. (http://www.ebayenterprise.com/)
 * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 */

namespace eBayEnterprise\RetailOrderManagement\Payload\Order;

trait TBrowserData
{
    /** @var string */
    protected $hostname;
    /** @var string */
    protected $ipAddress;
    /** @var string */
    protected $sessionId;
    /** @var string */
    protected $userAgent;
    /** @var string */
    protected $connection;
    /** @var string */
    protected $cookies;
    /** @var string */
    protected $userCookie;
    /** @var string */
    protected $userAgentOs;
    /** @var string */
    protected $userAgentCpu;
    /** @var string */
    protected $headerFrom;
    /** @var string */
    protected $webBrowserName;
    /** @var string */
    protected $javascriptData;
    /** @var string */
    protected $referrer;
    /** @var string */
    protected $contentTypes;
    /** @var string */
    protected $encoding;
    /** @var string */
    protected $language;
    /** @var string */
    protected $charSet;

    public function getHostname()
    {
        return $this->hostname;
    }

    public function setHostname($hostname)
    {
        $this->hostname = $this->cleanString($hostname, 50);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getIpAddress()
    {
        return $this->ipAddress;
    }

    public function setIpAddress($ipAddress)
    {
        $this->ipAddress = $this->isValidIpAddress($ipAddress) ? $ipAddress : null;
        return $this;
    }

    public function getSessionId()
    {
        return $this->sessionId;
    }

    public function setSessionId($sessionId)
    {
        $this->sessionId = $this->cleanString($sessionId, 255);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getUserAgent()
    {
        return $this->userAgent;
    }

    public function setUserAgent($userAgent)
    {
        $this->userAgent = $this->cleanString($userAgent, 4096);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getConnection()
    {
        return $this->connection;
    }

    public function setConnection($connection)
    {
        $this->connection = $this->cleanString($connection, 25);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getCookies()
    {
        return $this->cookies;
    }

    public function setCookies($cookies)
    {
        $this->cookies = $this->normalizeWhitespace($cookies);

It seems like normalizeWhitespace() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getUserCookie()
    {
        return $this->userCookie;
    }

    public function setUserCookie($userCookie)
    {
        $this->userCookie = $this->cleanString($userCookie, 50);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getUserAgentOs()
    {
        return $this->userAgentOs;
    }

    public function setUserAgentOs($userAgentOs)
    {
        $this->userAgentOs = $this->cleanString($userAgentOs, 100);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getUserAgentCpu()
    {
        return $this->userAgentCpu;
    }

    public function setUserAgentCpu($userAgentCpu)
    {
        $this->userAgentCpu = $this->cleanString($userAgentCpu, 100);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getHeaderFrom()
    {
        return $this->headerFrom;
    }

    public function setHeaderFrom($headerFrom)
    {
        $this->headerFrom = $this->cleanString($headerFrom, 100);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getWebBrowserName()
    {
        return $this->webBrowserName;
    }

    public function setWebBrowserName($webBrowserName)
    {
        $this->webBrowserName = $this->cleanString($webBrowserName, 100);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getJavascriptData()
    {
        return $this->javascriptData;
    }

    public function setJavascriptData($javascriptData)
    {
        $this->javascriptData = $this->normalizeWhitespace($javascriptData);

It seems like normalizeWhitespace() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getReferrer()
    {
        return $this->referrer;
    }

    public function setReferrer($referrer)
    {
        $this->referrer = $this->cleanString($referrer, 1024);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getContentTypes()
    {
        return $this->contentTypes;
    }

    public function setContentTypes($contentTypes)
    {
        $this->contentTypes = $this->cleanString($contentTypes, 1024);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getEncoding()
    {
        return $this->encoding;
    }

    public function setEncoding($encoding)
    {
        $this->encoding = $this->cleanString($encoding, 50);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getLanguage()
    {
        return $this->language;
    }

    public function setLanguage($language)
    {
        $this->language = $this->cleanString($language, 255);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getCharSet()
    {
        return $this->charSet;
    }

    public function setCharSet($charSet)
    {
        $this->charSet = $this->cleanString($charSet, 50);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    /**
     * Serialize browser data associated with the order.
     *
     * @return string
     */
    protected function serializeBrowserData()
    {
        return '<BrowserData>'
            . "<HostName>{$this->xmlEncode($this->getHostname())}</HostName>"
            . "<IPAddress>{$this->xmlEncode($this->getIpAddress())}</IPAddress>"
            . '<SessionId>' . $this->xmlEncode($this->getSessionId()) . '</SessionId>'
            . '<UserAgent>' . $this->xmlEncode($this->getUserAgent()) . '</UserAgent>'
            . $this->serializeOptionalXmlEncodedValue('Connection', $this->getConnection())
            . $this->serializeOptionalXmlEncodedValue('Cookies', $this->getCookies())
            . $this->serializeOptionalXmlEncodedValue('UserCookie', $this->getUserCookie())
            . $this->serializeOptionalXmlEncodedValue('UserAgentOS', $this->getUserAgentOs())
            . $this->serializeOptionalXmlEncodedValue('UserAgentCPU', $this->getUserAgentCpu())
            . $this->serializeOptionalXmlEncodedValue('HeaderFrom', $this->getHeaderFrom())
            . $this->serializeOptionalXmlEncodedValue('EmbeddedWebBrowserFrom', $this->getWebBrowserName())
            . '<JavascriptData>' . $this->xmlEncode($this->getJavascriptData()) . '</JavascriptData>'
            . '<Referrer>' . $this->xmlEncode($this->getReferrer()) . '</Referrer>'
            . "<HTTPAcceptData>"
            . '<ContentTypes>' . $this->xmlEncode($this->getContentTypes()) . '</ContentTypes>'
            . '<Encoding>' . $this->xmlEncode($this->getEncoding()) . '</Encoding>'
            . "<Language>{$this->xmlEncode($this->getLanguage())}</Language>"
            . '<CharSet>' . $this->xmlEncode($this->getCharSet()) . '</CharSet>'
            . "</HTTPAcceptData>"
            . '</BrowserData>';
    }

    /**
     * Test for an IP address to be a valid IP address. Currently, requires
     * address to be valid IPv4 addresses only.
     *
     * @param string
     * @return bool
     */
    protected function isValidIpAddress($ipAddress)
    {
        return (bool) filter_var($ipAddress, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4);
    }

    /**
     * Serialize an optional element containing a string. The value will be
     * xml-encoded if is not null.
     *
     * @param string
     * @param string
     * @return string
     */
    abstract protected function serializeOptionalXmlEncodedValue($name, $value);

    /**
     * encode the passed in string to be safe for xml if it is not null,
     * otherwise simply return the null parameter.
     *
     * @param string|null
     * @return string|null
     */
    abstract protected function xmlEncode($value = null);
}