DPRMC / IceRemotePlusClient

src/RemotePlusClient.php

Indentation +1 added lines, -1 removed lines

@@ -273,7 +273,7 @@
             'debug'   => $this->remotePlusDebug,
             'version' => $this->remotePlusHttpVersion,
             'headers' => [ 'Content-Type'  => $this->remotePlusContentType,
-                           'Authorization' => $this->getAuthenticationHeaderValue( $this->user, $this->pass ), ],
+                            'Authorization' => $this->getAuthenticationHeaderValue( $this->user, $this->pass ), ],
             'body'    => $this->requestBody,
         ] );
     }

Spacing +73 added lines, -73 removed lines

@@ -98,15 +98,15 @@ 
      * @param $user string The username given to you by Interactive Data
      * @param $pass string The password for the above username.
      */
-    public function __construct( $user, $pass ) {
+    public function __construct($user, $pass) {
         $this->user                     = $user;
         $this->pass                     = $pass;
-        $this->client                   = new Client( [ 'base_uri' => self::BASE_URI ] );
-        $this->authorizationHeaderValue = $this->getAuthenticationHeaderValue( $this->user, $this->pass );
+        $this->client                   = new Client(['base_uri' => self::BASE_URI]);
+        $this->authorizationHeaderValue = $this->getAuthenticationHeaderValue($this->user, $this->pass);
     }
 
-    public static function instantiate( string $user, string $pass ) {
-        return new static( $user, $pass );
+    public static function instantiate(string $user, string $pass) {
+        return new static($user, $pass);
     }
 
     /**
@@ -114,9 +114,9 @@ 
      * @param array $identifiers An array of security identifiers that you want to retrieve data on.
      * @return $this
      */
-    public function addIdentifiers( array $identifiers ) {
-        foreach ( $identifiers as $identifier ):
-            $this->addIdentifier( $identifier );
+    public function addIdentifiers(array $identifiers) {
+        foreach ($identifiers as $identifier):
+            $this->addIdentifier($identifier);
         endforeach;
         return $this;
     }
@@ -126,9 +126,9 @@ 
      * @param string $identifier
      * @return $this
      */
-    public function addIdentifier( string $identifier ) {
-        if ( FALSE == $this->identifierExists( $identifier ) ):
-            $this->identifiers[] = trim( $identifier );
+    public function addIdentifier(string $identifier) {
+        if (FALSE == $this->identifierExists($identifier)):
+            $this->identifiers[] = trim($identifier);
         endif;
         return $this;
     }
@@ -138,8 +138,8 @@ 
      * @param string $identifier
      * @return bool
      */
-    protected function identifierExists( string $identifier ): bool {
-        if ( FALSE === array_search( $identifier, $this->identifiers ) ):
+    protected function identifierExists(string $identifier): bool {
+        if (FALSE === array_search($identifier, $this->identifiers)):
             return FALSE;
         endif;
         return TRUE;
@@ -150,9 +150,9 @@ 
      * @param array $cusips An array of CUSIP security identifiers.
      * @return $this
      */
-    public function addCusips( array $cusips ) {
-        foreach ( $cusips as $cusip ):
-            $this->addCusip( $cusip );
+    public function addCusips(array $cusips) {
+        foreach ($cusips as $cusip):
+            $this->addCusip($cusip);
         endforeach;
         return $this;
     }
@@ -163,9 +163,9 @@ 
      * @param string $cusip A CUSIP security identifier.
      * @return $this
      */
-    public function addCusip( string $cusip ) {
-        if ( CUSIP::isCUSIP( $cusip ) ):
-            $this->addIdentifier( $cusip );
+    public function addCusip(string $cusip) {
+        if (CUSIP::isCUSIP($cusip)):
+            $this->addIdentifier($cusip);
         endif;
         return $this;
     }
@@ -176,8 +176,8 @@ 
      * @param string $item
      * @return $this
      */
-    public function addItem( string $item ) {
-        if ( FALSE === $this->itemExists( $item ) ):
+    public function addItem(string $item) {
+        if (FALSE === $this->itemExists($item)):
             $this->items[] = $item;
         endif;
         return $this;
@@ -188,9 +188,9 @@ 
      * @param array $items
      * @return $this
      */
-    public function addItems( array $items ) {
-        foreach ( $items as $item ):
-            $this->addItem( $item );
+    public function addItems(array $items) {
+        foreach ($items as $item):
+            $this->addItem($item);
         endforeach;
         return $this;
     }
@@ -200,8 +200,8 @@ 
      * @param string $item
      * @return bool
      */
-    protected function itemExists( string $item ): bool {
-        if ( FALSE === array_search( $item, $this->items ) ):
+    protected function itemExists(string $item): bool {
+        if (FALSE === array_search($item, $this->items)):
             return FALSE;
         endif;
         return TRUE;
@@ -212,8 +212,8 @@ 
      * @return $this
      * @throws DateSentToConstructorIsNotParsable
      */
-    public function addDate( string $date ) {
-        $this->date = $this->formatDateForRemotePlus( $date );
+    public function addDate(string $date) {
+        $this->date = $this->formatDateForRemotePlus($date);
         return $this;
     }
 
@@ -221,7 +221,7 @@ 
      * @param bool $debug
      * @return $this
      */
-    public function setDebug( bool $debug ) {
+    public function setDebug(bool $debug) {
         $this->remotePlusDebug = $debug;
         return $this;
     }
@@ -235,8 +235,8 @@ 
      *
      * @return string The value needed for the Authorization header.
      */
-    protected function getAuthenticationHeaderValue( $username, $pass ) {
-        return "Basic " . $this->encodeUserAndPassForBasicAuthentication( $username, $pass );
+    protected function getAuthenticationHeaderValue($username, $pass) {
+        return "Basic ".$this->encodeUserAndPassForBasicAuthentication($username, $pass);
     }
 
     /**
@@ -248,8 +248,8 @@ 
      *
      * @return string The base64 encoded user:pass string.
      */
-    protected function encodeUserAndPassForBasicAuthentication( $username, $pass ) {
-        return base64_encode( $username . ':' . $pass );
+    protected function encodeUserAndPassForBasicAuthentication($username, $pass) {
+        return base64_encode($username.':'.$pass);
     }
 
     /**
@@ -269,13 +269,13 @@ 
      * @throws \GuzzleHttp\Exception\GuzzleException
      */
     protected function sendRequest() {
-        $this->response = $this->client->request( 'POST', self::PAGE, [
+        $this->response = $this->client->request('POST', self::PAGE, [
             'debug'   => $this->remotePlusDebug,
             'version' => $this->remotePlusHttpVersion,
-            'headers' => [ 'Content-Type'  => $this->remotePlusContentType,
-                           'Authorization' => $this->getAuthenticationHeaderValue( $this->user, $this->pass ), ],
+            'headers' => ['Content-Type'  => $this->remotePlusContentType,
+                           'Authorization' => $this->getAuthenticationHeaderValue($this->user, $this->pass), ],
             'body'    => $this->requestBody,
-        ] );
+        ]);
     }
 
 
@@ -285,14 +285,14 @@ 
      * @return string The $date parameter formatted as yyyymmdd (or in PHP's syntax: Ymd)
      * @throws \DPRMC\IceRemotePlusClient\Exceptions\DateSentToConstructorIsNotParsable
      */
-    protected function formatDateForRemotePlus( string $date ) {
-        $strTime = strtotime( $date );
-        if ( $strTime === FALSE ):
-            throw new DateSentToConstructorIsNotParsable( "We could not parse the date you sent to the constructor: [" . $date . "]" );
+    protected function formatDateForRemotePlus(string $date) {
+        $strTime = strtotime($date);
+        if ($strTime === FALSE):
+            throw new DateSentToConstructorIsNotParsable("We could not parse the date you sent to the constructor: [".$date."]");
         endif;
-        $date = date( 'Ymd', $strTime );
+        $date = date('Ymd', $strTime);
 
-        return (string)$date;
+        return (string) $date;
     }
 
 
@@ -302,7 +302,7 @@ 
      * @return string
      */
     protected function getBodyFromResponse(): string {
-        return (string)$this->response->getBody();
+        return (string) $this->response->getBody();
     }
 
 
@@ -313,33 +313,33 @@ 
     protected function processResponse(): RemotePlusResponse {
         $body = $this->getBodyFromResponse();
 
-        $this->checkForError( $body );
+        $this->checkForError($body);
 
-        $itemValues = explode( "\n", $body );
-        $itemValues = array_map( 'trim', $itemValues );
-        $itemValues = array_filter( $itemValues );
-        array_pop( $itemValues ); // Remove the CRC check.
+        $itemValues = explode("\n", $body);
+        $itemValues = array_map('trim', $itemValues);
+        $itemValues = array_filter($itemValues);
+        array_pop($itemValues); // Remove the CRC check.
 
         $remotePlusResponse = new RemotePlusResponse();
 
-        foreach ( $this->identifiers as $i => $identifier ):
-            $securityResponse     = SecurityResponse::instantiate()
-                                                    ->addIdentifier( $identifier );
+        foreach ($this->identifiers as $i => $identifier):
+            $securityResponse = SecurityResponse::instantiate()
+                                                    ->addIdentifier($identifier);
 
-            if ( isset( $this->date ) ):
-                $securityResponse->addDate( $this->date );
+            if (isset($this->date)):
+                $securityResponse->addDate($this->date);
             endif;
 
-            $individualItemValues = explode( ',', $itemValues[ $i ] );
+            $individualItemValues = explode(',', $itemValues[$i]);
 
-            foreach ( $individualItemValues as $j => $item ):
+            foreach ($individualItemValues as $j => $item):
                 $securityResponse->addItem(
-                    $this->items[ $j ],
+                    $this->items[$j],
                     $item
                 );
             endforeach;
 
-            $remotePlusResponse->addResponse( $securityResponse );
+            $remotePlusResponse->addResponse($securityResponse);
         endforeach;
 
         return $remotePlusResponse;
@@ -352,26 +352,26 @@ 
      * @param string $body
      * @throws RemotePlusError
      */
-    protected function checkForError( string $body ) {
+    protected function checkForError(string $body) {
 
         // All RemotePlus errors start with "!E
         // So if the body does not start with those 3 characters, then no error occurred, and we can continue.
-        if ( '"!E' != substr( $body, 0, 3 ) ):
+        if ('"!E' != substr($body, 0, 3)):
             return;
         endif;
 
-        $itemValues = explode( "\n", $body );
-        $itemValues = array_map( 'trim', $itemValues );
-        $itemValues = array_filter( $itemValues );
-        array_pop( $itemValues ); // Remove the CRC check.
+        $itemValues = explode("\n", $body);
+        $itemValues = array_map('trim', $itemValues);
+        $itemValues = array_filter($itemValues);
+        array_pop($itemValues); // Remove the CRC check.
 
-        $errorLine  = $itemValues[ 0 ];
-        $errorParts = explode( '","', $errorLine );
-        $errorParts = array_map( function ( $item ) {
-            return trim( $item, '"' );
-        }, $errorParts );
+        $errorLine  = $itemValues[0];
+        $errorParts = explode('","', $errorLine);
+        $errorParts = array_map(function($item) {
+            return trim($item, '"');
+        }, $errorParts);
 
-        throw new RemotePlusError( $errorParts[ 1 ], 0, NULL, $errorParts[ 0 ] );
+        throw new RemotePlusError($errorParts[1], 0, NULL, $errorParts[0]);
     }
 
     /**
@@ -385,9 +385,9 @@ 
      */
     protected function generateBodyForRequest() {
 
-        $identifiers = implode( ',', $this->identifiers );
-        $items       = implode( ',', $this->items );
+        $identifiers = implode(',', $this->identifiers);
+        $items       = implode(',', $this->items);
 
-        $this->requestBody = 'Request=' . urlencode( "GET,(" . $identifiers ) . "),(" . $items . ")," . $this->date . "&Done=flag\n";
+        $this->requestBody = 'Request='.urlencode("GET,(".$identifiers)."),(".$items."),".$this->date."&Done=flag\n";
     }
 }
\ No newline at end of file

src/SecurityResponse.php

Spacing +11 added lines, -11 removed lines

@@ -51,7 +51,7 @@ 
      * @param string $identifier
      * @return $this
      */
-    public function addIdentifier( string $identifier ) {
+    public function addIdentifier(string $identifier) {
         $this->identifier = $identifier;
         return $this;
     }
@@ -60,8 +60,8 @@ 
      * @param string $date
      * @return $this
      */
-    public function addDate( string $date ) {
-        $this->date = Carbon::parse( $date );
+    public function addDate(string $date) {
+        $this->date = Carbon::parse($date);
         return $this;
     }
 
@@ -80,8 +80,8 @@ 
      * “!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, ' "' );
+    public function addItem(string $code, $value = NULL) {
+        $this->items[$code] = trim($value, ' "');
         return $this;
     }
 
@@ -90,8 +90,8 @@ 
      * @param string $item
      * @return bool
      */
-    protected function itemExists( string $item ): bool {
-        if ( isset( $this->items[ $item ] ) ):
+    protected function itemExists(string $item): bool {
+        if (isset($this->items[$item])):
             return TRUE;
         endif;
         return FALSE;
@@ -112,14 +112,14 @@ 
      * @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 ) ):
+    public function getItem(string $item) {
+        if (FALSE === $this->itemExists($item)):
             throw new ItemDoesNotExistInSecurityResponse();
         endif;
 
-        $value = $this->items[ $item ];
+        $value = $this->items[$item];
 
-        switch ( $value ):
+        switch ($value):
             case '!NA':
                 throw new ItemValueNotAvailable();
             case '!NH':

src/RemotePlusResponse.php

Spacing +3 added lines, -3 removed lines

@@ -25,7 +25,7 @@ 
      * "Setter" method to add a SecurityResponse object to our array of objects.
      * @param SecurityResponse $response
      */
-    public function addResponse( SecurityResponse $response ){
+    public function addResponse(SecurityResponse $response) {
         $this->responses[$response->identifier] = $response;
     }
 
@@ -33,7 +33,7 @@ 
      * Simple getter method to get an array of all the SecurityResponse objects.
      * @return array
      */
-    public function getResponses(){
+    public function getResponses() {
         return $this->responses;
     }
 
@@ -49,7 +49,7 @@ 
         /**
          * @var SecurityResponse $response
          */
-        foreach($this->responses as $response):
+        foreach ($this->responses as $response):
             $valuesToReturn[$response->identifier] = $response->items[$item];
         endforeach;
 

src/Exceptions/RemotePlusError.php

Spacing +2 added lines, -2 removed lines

@@ -25,8 +25,8 @@
      * @param Throwable|NULL $previous
      * @param string|NULL $remotePlusErrorCode
      */
-    public function __construct( string $message = "", int $code = 0, Throwable $previous = NULL, string $remotePlusErrorCode=null ) {
-        parent::__construct( $message, $code, $previous );
+    public function __construct(string $message = "", int $code = 0, Throwable $previous = NULL, string $remotePlusErrorCode = null) {
+        parent::__construct($message, $code, $previous);
         $this->remotePlusErrorCode = $remotePlusErrorCode;
     }
 }
\ No newline at end of file