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/AddressValidation.php

Spacing +1 added lines, -1 removed lines

@@ -128,7 +128,7 @@
         }
         if ($this->useAVResponseObject) {
             unset($response->Response);
-            $avResponse = new AddressValidationResponse($response,$requestOption);
+            $avResponse = new AddressValidationResponse($response, $requestOption);
             return $avResponse;
         }
         return $this->formatResponse($response);

src/Entity/AddressValidation/AVAddress.php

Spacing +2 added lines, -2 removed lines

@@ -64,9 +64,9 @@
      * @param string $extendedDivider
      * @return string
      */
-    public function getPostalCode($withExtended = false,$extendedDivider = '-')
+    public function getPostalCode($withExtended = false, $extendedDivider = '-')
     {
-        if($withExtended) {
+        if ($withExtended) {
             return $this->postcodePrimaryLow . $extendedDivider . $this->postcodeExtendedLow;
         }
         return $this->postcodePrimaryLow;

src/Entity/AddressValidationResponse.php

Spacing +10 added lines, -10 removed lines

@@ -15,7 +15,7 @@ 
      * @param \SimpleXMLElement $xmlDocument
      * @param $requestAction
      */
-    public function __construct(\SimpleXMLElement $xmlDocument,$requestAction)
+    public function __construct(\SimpleXMLElement $xmlDocument, $requestAction)
     {
         $this->response = $xmlDocument;
         $this->requestAction = $requestAction;
@@ -30,8 +30,8 @@ 
      */
     public function noCandidates()
     {
-        if(AddressValidation::REQUEST_OPTION_ADDRESS_CLASSIFICATION == $this->requestAction) {
-            throw new \BadMethodCallException(__METHOD__.' should not be called on Address Classification only requests.');
+        if (AddressValidation::REQUEST_OPTION_ADDRESS_CLASSIFICATION == $this->requestAction) {
+            throw new \BadMethodCallException(__METHOD__ . ' should not be called on Address Classification only requests.');
         }
         return isset($this->response->NoCandidatesIndicator);
     }
@@ -44,7 +44,7 @@ 
      */
     public function isValid()
     {
-        if(AddressValidation::REQUEST_OPTION_ADDRESS_CLASSIFICATION == $this->requestAction) {
+        if (AddressValidation::REQUEST_OPTION_ADDRESS_CLASSIFICATION == $this->requestAction) {
             return $this->response->AddressClassification->Code > 0;
         }
         return isset($this->response->ValidAddressIndicator);
@@ -60,8 +60,8 @@ 
      */
     public function isAmbiguous()
     {
-        if(AddressValidation::REQUEST_OPTION_ADDRESS_CLASSIFICATION == $this->requestAction) {
-            throw new \BadMethodCallException(__METHOD__.' should not be called on Address Classification only requests.');
+        if (AddressValidation::REQUEST_OPTION_ADDRESS_CLASSIFICATION == $this->requestAction) {
+            throw new \BadMethodCallException(__METHOD__ . ' should not be called on Address Classification only requests.');
         }
         return isset($this->response->AmbiguousAddressIndicator);
     }
@@ -72,7 +72,7 @@ 
      */
     public function getAddressClassification()
     {
-        if($this->requestAction < AddressValidation::REQUEST_OPTION_ADDRESS_CLASSIFICATION) {
+        if ($this->requestAction < AddressValidation::REQUEST_OPTION_ADDRESS_CLASSIFICATION) {
             throw new \BadMethodCallException('Address Classification was not requested.');
         }
         return new AddressClassification($this->response->AddressClassification);
@@ -83,11 +83,11 @@ 
      */
     public function getCandidateAddressList()
     {
-        if(!isset($this->response->AddressKeyFormat)) {
+        if (!isset($this->response->AddressKeyFormat)) {
             return [];
         }
         $candidates = [];
-        foreach($this->response->AddressKeyFormat as $address) {
+        foreach ($this->response->AddressKeyFormat as $address) {
             $candidates[] = new AVAddress($address);
         }
         return $candidates;
@@ -95,7 +95,7 @@ 
 
     public function getValidatedAddress()
     {
-        if($this->requestAction == AddressValidation::REQUEST_OPTION_ADDRESS_CLASSIFICATION) {
+        if ($this->requestAction == AddressValidation::REQUEST_OPTION_ADDRESS_CLASSIFICATION) {
             throw new \BadMethodCallException('Only Address Classification was requested. There is no address.');
         }