SecurityResponse::getItem() - Code Metrics - DPRMC/IceRemotePlusClient - Measure and Improve Code Quality continuously with Scrutinizer

SecurityResponse::getItem() B
last analyzed 2021-01-08 16:30 UTC

↳ Parent: SecurityResponse

Complexity

Conditions	10
Paths	10

Size

Total Lines	27
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	23
dl	0
loc	27
c	0
b	0
f	0
rs	7.6666
cc	10
nc	10
nop	1

How to fix Complexity

<?php

namespace DPRMC\IceRemotePlusClient;

use Carbon\Carbon;
use DPRMC\IceRemotePlusClient\Exceptions\ItemDoesNotExistInSecurityResponse;
use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailable;
use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailableBecauseErrorCode5000;
use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailableBecauseErrorCode6000;
use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailableBecauseErrorCode7000;
use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailableBecauseErrorCode8000;
use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailableBecauseHoliday;
use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailableBecauseNotExpected;
use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailableBecauseNotReported;

/**
 * Represents all of the data items requested for a specific security.
 * Class SecurityResponse
 * @package DPRMC\InteractiveData
 */
class SecurityResponse {
    /**
     * @var string The security identifier
     */
    public $identifier;

    /**
     * @var Carbon The date of the data being pulled.
     */
    public $date;

    /**
     * @var array An array of itemCode => value for each item code you want to pull for this security.
     */
    public $items; // array itemCode => value

    /**
     * SecurityResponse constructor.
     */
    public function __construct() {
    }

    /**
     * @return SecurityResponse
     */
    public static function instantiate() {
        return new static();
    }

    /**
     * @param string $identifier
     * @return $this
     */
    public function addIdentifier( string $identifier ) {
        $this->identifier = $identifier;
        return $this;
    }

    /**
     * @param string $date
     * @return $this
     */
    public function addDate( string $date ) {
        $this->date = Carbon::parse( $date );
        return $this;
    }

    /**
     * @param string $code
     * @param null $value

     * @return $this
     *
     * The following are special values that indicate some kind of non-response occurred.
     * “!NA” not available
     * “!NH” holiday (only applicable to US/Canadian securities)
     * “!NE” not expected (e.g., prices for future dates)
     * “!NR” not reported
     * “!N5” an error code 5000 was returned
     * “!N6” an error code 6000 was returned
     * “!N7” an error code 7000 was returned
     * “!N8” an error code 8000 was returned
     */
    public function addItem( string $code, $value = NULL ) {
        $this->items[ $code ] = trim( $value, ' "' );
        return $this;
    }

    /**
     * Logic method to improve readability.
     * @param string $item
     * @return bool
     */
    protected function itemExists( string $item ): bool {
        if ( isset( $this->items[ $item ] ) ):
            return TRUE;
        endif;
        return FALSE;
    }

    /**
     * @param string $item The item code of the value you want to retrieve.
     * @return mixed
     * @throws ItemDoesNotExistInSecurityResponse
     * @throws ItemValueNotAvailable
     * @throws ItemValueNotAvailableBecauseErrorCode5000
     * @throws ItemValueNotAvailableBecauseErrorCode6000
     * @throws ItemValueNotAvailableBecauseErrorCode7000
     * @throws ItemValueNotAvailableBecauseErrorCode8000
     * @throws ItemValueNotAvailableBecauseHoliday
     * @throws ItemValueNotAvailableBecauseNotExpected
     * @throws ItemValueNotAvailableBecauseNotReported
     * @note From Client Support at ICE Data Services: unfortunately we don't have examples for the others (!NR, !N5, !N6, !N7, and !N8).
     * ...so as a result those Exceptions can't be tested with our unit tests.
     */
    public function getItem( string $item ) {
        if ( FALSE === $this->itemExists( $item ) ):
            throw new ItemDoesNotExistInSecurityResponse();
        endif;

        $value = $this->items[ $item ];

        switch ( $value ):
            case '!NA':
                throw new ItemValueNotAvailable();
            case '!NH':
                throw new ItemValueNotAvailableBecauseHoliday();
            case '!NE':
                throw new ItemValueNotAvailableBecauseNotExpected();
            case '!NR':
                throw new ItemValueNotAvailableBecauseNotReported();
            case '!N5':
                throw new ItemValueNotAvailableBecauseErrorCode5000();
            case '!N6':
                throw new ItemValueNotAvailableBecauseErrorCode6000();
            case '!N7':
                throw new ItemValueNotAvailableBecauseErrorCode7000();
            case '!N8':
                throw new ItemValueNotAvailableBecauseErrorCode8000();
        endswitch;

        return $value;
    }


}

1			<?php
2
3			namespace DPRMC\IceRemotePlusClient;
4
5			use Carbon\Carbon;
6			use DPRMC\IceRemotePlusClient\Exceptions\ItemDoesNotExistInSecurityResponse;
7			use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailable;
8			use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailableBecauseErrorCode5000;
9			use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailableBecauseErrorCode6000;
10			use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailableBecauseErrorCode7000;
11			use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailableBecauseErrorCode8000;
12			use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailableBecauseHoliday;
13			use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailableBecauseNotExpected;
14			use DPRMC\IceRemotePlusClient\Exceptions\ItemValueNotAvailableBecauseNotReported;
15
16			/**
17			* Represents all of the data items requested for a specific security.
18			* Class SecurityResponse
19			* @package DPRMC\InteractiveData
20			*/
21			class SecurityResponse {
22			/**
23			* @var string The security identifier
24			*/
25			public $identifier;
26
27			/**
28			* @var Carbon The date of the data being pulled.
29			*/
30			public $date;
31
32			/**
33			* @var array An array of itemCode => value for each item code you want to pull for this security.
34			*/
35			public $items; // array itemCode => value
36
37			/**
38			* SecurityResponse constructor.
39			*/
40			public function __construct() {
41			}
42
43			/**
44			* @return SecurityResponse
45			*/
46			public static function instantiate() {
47			return new static();
48			}
49
50			/**
51			* @param string $identifier
52			* @return $this
53			*/
54			public function addIdentifier( string $identifier ) {
55			$this->identifier = $identifier;
56			return $this;
57			}
58
59			/**
60			* @param string $date
61			* @return $this
62			*/
63			public function addDate( string $date ) {
64			$this->date = Carbon::parse( $date );
65			return $this;
66			}
67
68			/**
69			* @param string $code
70			* @param null $value
			0 ignored issues – show Documentation Bug introduced 2019-01-25 20:21 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$value` is correct as it would always require `null` to be passed? Loading history...
71			* @return $this
72			*
73			* The following are special values that indicate some kind of non-response occurred.
74			* “!NA” not available
75			* “!NH” holiday (only applicable to US/Canadian securities)
76			* “!NE” not expected (e.g., prices for future dates)
77			* “!NR” not reported
78			* “!N5” an error code 5000 was returned
79			* “!N6” an error code 6000 was returned
80			* “!N7” an error code 7000 was returned
81			* “!N8” an error code 8000 was returned
82			*/
83			public function addItem( string $code, $value = NULL ) {
84			$this->items[ $code ] = trim( $value, ' "' );
85			return $this;
86			}
87
88			/**
89			* Logic method to improve readability.
90			* @param string $item
91			* @return bool
92			*/
93			protected function itemExists( string $item ): bool {
94			if ( isset( $this->items[ $item ] ) ):
95			return TRUE;
96			endif;
97			return FALSE;
98			}
99
100			/**
101			* @param string $item The item code of the value you want to retrieve.
102			* @return mixed
103			* @throws ItemDoesNotExistInSecurityResponse
104			* @throws ItemValueNotAvailable
105			* @throws ItemValueNotAvailableBecauseErrorCode5000
106			* @throws ItemValueNotAvailableBecauseErrorCode6000
107			* @throws ItemValueNotAvailableBecauseErrorCode7000
108			* @throws ItemValueNotAvailableBecauseErrorCode8000
109			* @throws ItemValueNotAvailableBecauseHoliday
110			* @throws ItemValueNotAvailableBecauseNotExpected
111			* @throws ItemValueNotAvailableBecauseNotReported
112			* @note From Client Support at ICE Data Services: unfortunately we don't have examples for the others (!NR, !N5, !N6, !N7, and !N8).
113			* ...so as a result those Exceptions can't be tested with our unit tests.
114			*/
115			public function getItem( string $item ) {
116			if ( FALSE === $this->itemExists( $item ) ):
117			throw new ItemDoesNotExistInSecurityResponse();
118			endif;
119
120			$value = $this->items[ $item ];
121
122			switch ( $value ):
123			case '!NA':
124			throw new ItemValueNotAvailable();
125			case '!NH':
126			throw new ItemValueNotAvailableBecauseHoliday();
127			case '!NE':
128			throw new ItemValueNotAvailableBecauseNotExpected();
129			case '!NR':
130			throw new ItemValueNotAvailableBecauseNotReported();
131			case '!N5':
132			throw new ItemValueNotAvailableBecauseErrorCode5000();
133			case '!N6':
134			throw new ItemValueNotAvailableBecauseErrorCode6000();
135			case '!N7':
136			throw new ItemValueNotAvailableBecauseErrorCode7000();
137			case '!N8':
138			throw new ItemValueNotAvailableBecauseErrorCode8000();
139			endswitch;
140
141			return $value;
142			}
143
144
145			}

DPRMC / IceRemotePlusClient

SecurityResponse::getItem() B last analyzed 2021-01-08 16:30 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

SecurityResponse::getItem() B
last analyzed 2021-01-08 16:30 UTC