gabrielbull / php-ups-api

src/Entity/InsuredValue.php

Doc Comments +2 added lines, -2 removed lines

@@ -54,7 +54,7 @@ 
     }
 
     /**
-     * @return string|null
+     * @return string
      */
     public function getCurrencyCode()
     {
@@ -71,7 +71,7 @@ 
     }
 
     /**
-     * @return float|null
+     * @return double
      */
     public function getMonetaryValue()
     {

src/Entity/Tradeability/Shipment.php

Doc Comments +13 added lines, -13 removed lines

@@ -71,9 +71,9 @@ 
     private $tariffCodeAlert;
 
     /**
-     * @param null|DOMDocument $document
+     * @param null|\DOMDocument $document
      *
-     * @return DOMElement
+     * @return \DOMElement
      */
     public function toNode(DOMDocument $document = null)
     {
@@ -145,7 +145,7 @@ 
 
     /**
      * @param AdditionalInsurance $additionalInsurance
-     * @return QueryRequestShipment
+     * @return Shipment
      */
     public function setAdditionalInsurance($additionalInsurance)
     {
@@ -164,7 +164,7 @@ 
 
     /**
      * @param FreightCharges $freightCharges
-     * @return QueryRequestShipment
+     * @return Shipment
      */
     public function setFreightCharges($freightCharges)
     {
@@ -183,7 +183,7 @@ 
 
     /**
      * @param string $originCountryCode
-     * @return QueryRequestShipment
+     * @return Shipment
      */
     public function setOriginCountryCode($originCountryCode)
     {
@@ -202,7 +202,7 @@ 
 
     /**
      * @param string $destinationCountryCode
-     * @return QueryRequestShipment
+     * @return Shipment
      */
     public function setDestinationCountryCode($destinationCountryCode)
     {
@@ -221,7 +221,7 @@ 
 
     /**
      * @param string $originStateProvinceCode
-     * @return QueryRequestShipment
+     * @return Shipment
      */
     public function setOriginStateProvinceCode($originStateProvinceCode)
     {
@@ -240,7 +240,7 @@ 
 
     /**
      * @param string $destinationStateProvinceCode
-     * @return QueryRequestShipment
+     * @return Shipment
      */
     public function setDestinationStateProvinceCode($destinationStateProvinceCode)
     {
@@ -259,7 +259,7 @@ 
 
     /**
      * @param int $transportationMode
-     * @return QueryRequestShipment
+     * @return Shipment
      */
     public function setTransportationMode($transportationMode)
     {
@@ -278,7 +278,7 @@ 
 
     /**
      * @param string $resultCurrencyCode
-     * @return QueryRequestShipment
+     * @return Shipment
      */
     public function setResultCurrencyCode($resultCurrencyCode)
     {
@@ -307,7 +307,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string|null
      */
     public function getTransactionReferenceId()
     {
@@ -316,7 +316,7 @@ 
 
     /**
      * @param mixed $transactionReferenceId
-     * @return QueryRequestShipment
+     * @return Shipment
      */
     public function setTransactionReferenceId($transactionReferenceId)
     {
@@ -335,7 +335,7 @@ 
 
     /**
      * @param array $products
-     * @return QueryRequestShipment
+     * @return Shipment
      */
     public function setProducts($products)
     {

src/Entity/Translate.php

Doc Comments +4 added lines, -4 removed lines

@@ -97,7 +97,7 @@ 
     }
 
     /**
-     * @return string|null
+     * @return string
      */
     public function getLanguageCode()
     {
@@ -114,7 +114,7 @@ 
     }
 
     /**
-     * @return string|null
+     * @return string
      */
     public function getDialectCode()
     {
@@ -131,7 +131,7 @@ 
     }
 
     /**
-     * @return null|string
+     * @return string
      */
     public function getCode()
     {
@@ -148,7 +148,7 @@ 
     }
 
     /**
-     * @return null|string
+     * @return string
      */
     public function getLocale()
     {

src/Locator.php

Doc Comments +1 added lines, -1 removed lines

@@ -86,7 +86,7 @@
      * Create the TimeInTransit request.
      *
      * @param LocatorRequest $locatorRequest The request details. Refer to the UPS documentation for available structure
-     * @param $requestOption
+     * @param integer $requestOption
      *
      * @return string
      */

src/TimeInTransit.php

Doc Comments +3 added lines, -3 removed lines

@@ -41,7 +41,7 @@ 
      *
      * @throws Exception
      *
-     * @return TimeInTransitRequest
+     * @return TimeInTransitResponse
      */
     public function getTimeInTransit(TimeInTransitRequest $shipment)
     {
@@ -56,7 +56,7 @@ 
      *
      * @throws Exception
      *
-     * @return TimeInTransitRequest
+     * @return TimeInTransitResponse
      */
     private function sendRequest(TimeInTransitRequest $timeInTransitRequest)
     {
@@ -154,7 +154,7 @@ 
      *
      * @param SimpleXMLElement $response
      *
-     * @return TimeInTransitRequest
+     * @return TimeInTransitResponse
      */
     private function formatResponse(SimpleXMLElement $response)
     {

src/Tradeability.php

Doc Comments +6 added lines, -7 removed lines

@@ -83,7 +83,6 @@ 
     /**
      * Create the LandedCostRequest request.
      *
-     * @param LandedCostRequest $request The request details. Refer to the UPS documentation for available structure
      *
      * @return string
      */
@@ -112,14 +111,14 @@ 
     /**
      * Creates and sends a request for the given data. Most errors are handled in SoapRequest
      *
-     * @param $request
-     * @param $endpoint
-     * @param $operation
-     * @param $wsdl
+     * @param string $request
+     * @param string $endpoint
+     * @param string $operation
+     * @param string $wsdl
      *
      * @throws Exception
      *
-     * @return TimeInTransitRequest
+     * @return \stdClass
      */
     private function sendRequest($request, $endpoint, $operation, $wsdl)
     {
@@ -165,7 +164,7 @@ 
      *
      * @param SimpleXMLElement $response
      *
-     * @return stdClass
+     * @return \stdClass
      */
     private function formatResponse(SimpleXMLElement $response)
     {

src/Tracking.php

Spacing +17 added lines, -17 removed lines

@@ -136,43 +136,43 @@
         $patterns = [
 
             // UPS Mail Innovations tracking numbers
-            '/^MI\d{6}\d{1,22}$/',// MI 000000 00000000+
+            '/^MI\d{6}\d{1,22}$/', // MI 000000 00000000+
 
             // USPS - Certified Mail
-            '/^94071\d{17}$/',    // 9407 1000 0000 0000 0000 00
-            '/^7\d{19}$/',        // 7000 0000 0000 0000 0000
+            '/^94071\d{17}$/', // 9407 1000 0000 0000 0000 00
+            '/^7\d{19}$/', // 7000 0000 0000 0000 0000
 
             // USPS - Collect on Delivery
-            '/^93033\d{17}$/',    // 9303 3000 0000 0000 0000 00
-            '/^M\d{9}$/',         // M000 0000 00
+            '/^93033\d{17}$/', // 9303 3000 0000 0000 0000 00
+            '/^M\d{9}$/', // M000 0000 00
 
             // USPS - Global Express Guaranteed
-            '/^82\d{10}$/',       // 82 000 000 00
+            '/^82\d{10}$/', // 82 000 000 00
 
             // USPS - Priority Mail Express International
-            '/^EC\d{9}US$/',      // EC 000 000 000 US
+            '/^EC\d{9}US$/', // EC 000 000 000 US
 
             // USPS - Priority Mail Express
-            '/^927\d{19}$/',      // 9270 1000 0000 0000 0000 00
-            '/^EA\d{9}US$/',      // EA 000 000 000 US
+            '/^927\d{19}$/', // 9270 1000 0000 0000 0000 00
+            '/^EA\d{9}US$/', // EA 000 000 000 US
 
             // USPS - Priority Mail International
-            '/^CP\d{9}US$/',      // CP 000 000 000 US
+            '/^CP\d{9}US$/', // CP 000 000 000 US
 
             // USPS - Priority Mail
-            '/^92055\d{17}$/',    // 9205 5000 0000 0000 0000 00
-            '/^14\d{18}$/',       // 1400 0000 0000 0000 0000
+            '/^92055\d{17}$/', // 9205 5000 0000 0000 0000 00
+            '/^14\d{18}$/', // 1400 0000 0000 0000 0000
 
             // USPS - Registered Mail
-            '/^92088\d{17}$/',    // 9208 8000 0000 0000 0000 00
-            '/^RA\d{9}US$/',      // RA 000 000 000 US
+            '/^92088\d{17}$/', // 9208 8000 0000 0000 0000 00
+            '/^RA\d{9}US$/', // RA 000 000 000 US
 
             // USPS - Signature Confirmation
-            '/^9202\d{16}US$/',   // 9202 1000 0000 0000 0000 00
-            '/^23\d{16}US$/',     // 2300 0000 0000 0000 0000
+            '/^9202\d{16}US$/', // 9202 1000 0000 0000 0000 00
+            '/^23\d{16}US$/', // 2300 0000 0000 0000 0000
 
             // USPS - Tracking
-            '/^94\d{20}$/',       // 9400 1000 0000 0000 0000 00
+            '/^94\d{20}$/', // 9400 1000 0000 0000 0000 00
             '/^03\d{18}$/'        // 0300 0000 0000 0000 0000
         ];