PHP Linting (Pint)

Author: rawilk

src/Apis/AddressValidation/AddressValidation.php

@@ -22,11 +22,11 @@ class AddressValidation extends Api
 
     protected int $requestOption = AddressValidationOption::ADDRESS_VALIDATION;
 
-    protected null|Address $address = null;
+    protected ?Address $address = null;
 
     protected static array $supportedCountries = ['US', 'PR'];
 
-    public function validate(Address $address = null): AddressValidationResponse
+    public function validate(?Address $address = null): AddressValidationResponse
     {
         // The UPS Customer Integration Environment (sandbox = true) only allows certain states to be
         // validated, so we will always use the production api instead since it's free anyways.

src/Apis/Shipping/LabelRecovery.php

@@ -16,11 +16,11 @@ class LabelRecovery extends Api
     /** @var string */
     protected const ENDPOINT = '/LabelRecovery';
 
-    protected null|LabelSpecification $labelSpecification = null;
+    protected ?LabelSpecification $labelSpecification = null;
 
-    protected null|Translate $translate = null;
+    protected ?Translate $translate = null;
 
-    protected null|LabelDelivery $labelDelivery = null;
+    protected ?LabelDelivery $labelDelivery = null;
 
     protected string $trackingNumber = '';
 

src/Apis/Shipping/ShipConfirm.php

@@ -23,11 +23,11 @@ class ShipConfirm extends Api
 
     protected string $requestOption = ShipConfirmOptions::NON_VALIDATE;
 
-    protected null|Shipment $shipment = null;
+    protected ?Shipment $shipment = null;
 
-    protected null|LabelSpecification $labelSpecification = null;
+    protected ?LabelSpecification $labelSpecification = null;
 
-    protected null|ReceiptSpecification $receiptSpecification = null;
+    protected ?ReceiptSpecification $receiptSpecification = null;
 
     public function getDigest(): ShipConfirmResponse
     {

src/Apis/Shipping/VoidShipment.php

@@ -42,9 +42,9 @@ public function void(): VoidResponse
 
         return VoidResponse::fromXml(
             $this
-                    ->allowRequestErrors()
-                    ->processRequest()
-                    ->response()
+                ->allowRequestErrors()
+                ->processRequest()
+                ->response()
         );
     }
 

src/Concerns/HasAttributes.php

@@ -21,7 +21,7 @@ trait HasAttributes
      */
     protected bool $castEmptyArraysAsTrue = true;
 
-    public function convertPropertyNamesToSnakeCase(array $data, string $parentKey = null): array
+    public function convertPropertyNamesToSnakeCase(array $data, ?string $parentKey = null): array
     {
         $properties = [];
 

src/Concerns/HasRelationships.php

@@ -31,7 +31,7 @@ public function relationResolver($class, $key)
         return null;
     }
 
-    protected function createRelationshipFromArray(string $relationship, array $data, string $parentKey = null)
+    protected function createRelationshipFromArray(string $relationship, array $data, ?string $parentKey = null)
     {
         // If we have a non-associative array, we probably have an array of related entities.
         if (! $this->isAssociativeArray($data)) {

src/Entity/Activity/Activity.php

@@ -17,7 +17,7 @@
  * @property null|string $gmt_offset Format: (+/-) hh:mm
  * @property \Carbon\Carbon $date_time Parsed date and time object. Tries to use GMT date/time first, but falls back on date/time.
  * @property null|string $signed_for_by_name
- *      If this activity is a delivery activity and there is a signature, it will be returned from the <ActivityLocation> Container.
+ *                                           If this activity is a delivery activity and there is a signature, it will be returned from the <ActivityLocation> Container.
  * @property null|\Rawilk\Ups\Entity\Activity\ActivityLocation $activity_location
  * @property null|\Rawilk\Ups\Entity\Tracking\Status $status Package activity status container.
  */
@@ -57,7 +57,7 @@ public function isDelivered(): bool
         return $this->status->isDelivered();
     }
 
-    public function getSignedForByNameAttribute(): null|string
+    public function getSignedForByNameAttribute(): ?string
     {
         return $this->activity_location->signed_for_by_name ?? null;
     }

src/Entity/AddressValidation/AddressValidationAddress.php

@@ -15,7 +15,7 @@
  * @property null|string $state
  * @property null|string $postal_code
  * @property null|string $postcode_extended_low
- *      Low-end extended postal code in a range. Example in quotes: Postal Code 30076-'1234'. Only returned in candidate list. May be alphanumeric.
+ *                                              Low-end extended postal code in a range. Example in quotes: Postal Code 30076-'1234'. Only returned in candidate list. May be alphanumeric.
  * @property string $country_code
  * @property null|string $consignee_name Name of business, company or person. Not returned if user selects the RegionalRequestIndicator.
  * @property null|string $building_name Name of building. Not returned if user selects the RegionalRequestIndicator.

src/Entity/Entity.php

@@ -16,14 +16,14 @@
 use Rawilk\Ups\Support\Xml;
 use SimpleXMLElement;
 
-abstract class Entity implements ArrayAccess, Arrayable, Jsonable, JsonSerializable, Xmlable
+abstract class Entity implements Arrayable, ArrayAccess, Jsonable, JsonSerializable, Xmlable
 {
     use EntityHasAttributes;
-    use HasRelationships;
     use HasAttributes {
         setAttribute as hasAttributesSetAttribute;
         getAttribute as hasAttributesGetAttribute;
     }
+    use HasRelationships;
 
     public $exists = false;
 
@@ -144,7 +144,7 @@ public function toJson($options = 0): string
     {
         $json = json_encode($this->jsonSerialize(), $options);
 
-        if (JSON_ERROR_NONE !== json_last_error()) {
+        if (json_last_error() !== JSON_ERROR_NONE) {
             throw new JsonEncodingException(
                 'Error encoding UPS entity [' . get_class($this) . '] to JSON: ' . json_last_error_msg()
             );

src/Entity/Payment/BillShipper.php

@@ -8,7 +8,7 @@
 
 /**
  * @property null|string $account_number
- *      UPS account number. Must be the same account number as the one provided in Shipment/Shipper/ShipperNumber attribute.
+ *                                       UPS account number. Must be the same account number as the one provided in Shipment/Shipper/ShipperNumber attribute.
  * @property null|\Rawilk\Ups\Entity\Payment\CreditCard $credit_card
  */
 class BillShipper extends Entity

src/Entity/Payment/BillThirdPartyConsignee.php

@@ -8,7 +8,7 @@
 
 /**
  * @property string $account_number
- *      The UPS account number of the third party consignee.
+ *                                  The UPS account number of the third party consignee.
  * @property \Rawilk\Ups\Entity\Payment\ThirdParty $third_party
  */
 class BillThirdPartyConsignee extends Entity

src/Entity/Payment/BillThirdPartyShipper.php

@@ -8,7 +8,7 @@
 
 /**
  * @property string $account_number
- *      The account number of the third party shipper.
+ *                                  The account number of the third party shipper.
  * @property \Rawilk\Ups\Entity\Payment\ThirdParty $third_party
  */
 class BillThirdPartyShipper extends Entity

src/Entity/Payment/ItemizedPaymentInformation.php

@@ -9,8 +9,8 @@
 /**
  * @property \Rawilk\Ups\Entity\Payment\ShipmentCharge[] $shipment_charges
  * @property bool $split_duty_vat
- *      The presence indicates the payer specified for Transportation Charges will pay
- *      transportation charges and any duties that apply to the shipment.
+ *                                The presence indicates the payer specified for Transportation Charges will pay
+ *                                transportation charges and any duties that apply to the shipment.
  */
 class ItemizedPaymentInformation extends Entity
 {

src/Entity/Payment/RateInformation.php

@@ -8,11 +8,11 @@
 
 /**
  * @property bool $negotiated_rates
- *      If true and the shipper is authorized, then Negotiated Rates should be returned in the response.
+ *                                  If true and the shipper is authorized, then Negotiated Rates should be returned in the response.
  * @property bool $rate_chart
- *      If true, the response will contain a RateChart Element.
+ *                            If true, the response will contain a RateChart Element.
  * @property bool $user_level_discount
- *      If true, user level discount will be applied to rates if applicable.
+ *                                     If true, user level discount will be applied to rates if applicable.
  */
 class RateInformation extends Entity
 {

src/Entity/Payment/ShipmentCharge.php

@@ -12,7 +12,7 @@
  * @property null|\Rawilk\Ups\Entity\Payment\BillReceiver $bill_receiver
  * @property null|\Rawilk\Ups\Entity\Payment\BillThirdParty $bill_third_party
  * @property bool $consignee_billed
- *     Valid for shipment charge type of transportation only.
+ *                                  Valid for shipment charge type of transportation only.
  */
 class ShipmentCharge extends Entity
 {

src/Entity/Shipment/Label/LabelImage.php

@@ -10,10 +10,10 @@
  * @property \Rawilk\Ups\Entity\Shipment\Label\LabelImageFormat $label_image_format
  * @property string $graphic_image Base 64 encoded graphic image
  * @property string $html_image
- *      Base 64 encoded html browser image rendering software. This is only returned for GIF image formats.
+ *                              Base 64 encoded html browser image rendering software. This is only returned for GIF image formats.
  * @property string $url
- *      This is only returned if the label link is requested to be returned and only at the first package
- *      result.
+ *                       This is only returned if the label link is requested to be returned and only at the first package
+ *                       result.
  */
 class LabelImage extends Entity
 {

src/Entity/Shipment/Label/LabelResult.php

@@ -9,8 +9,8 @@
 
 /**
  * @property null|string $tracking_number
- *      Package Tracking number. Package 1Z number. Returned only if TrackingNumber or Combination of Reference Number
- *      and Shipper Number is present in request.
+ *                                        Package Tracking number. Package 1Z number. Returned only if TrackingNumber or Combination of Reference Number
+ *                                        and Shipper Number is present in request.
  * @property \Rawilk\Ups\Entity\Shipment\Label\LabelImage $label_image
  * @property null|\Rawilk\Ups\Entity\Shipment\Receipt\Receipt $receipt
  */

src/Entity/Shipment/Label/LabelSpecification.php

@@ -8,11 +8,11 @@
 
 /**
  * @property null|string $http_user_agent
- *      Browser HTTPUserAgent String. This is the preferred way of identifying GIF image type to be generated.
+ *                                        Browser HTTPUserAgent String. This is the preferred way of identifying GIF image type to be generated.
  * @property null|string $character_set
  * @property \Rawilk\Ups\Entity\Shipment\Label\LabelPrintMethod $label_print_method
  * @property null|\Rawilk\Ups\Entity\Shipment\Label\LabelStockSize $label_stock_size
- *      For EPL2, ZPL, STARPL, and SPL labels.
+ *                                                                                   For EPL2, ZPL, STARPL, and SPL labels.
  * @property \Rawilk\Ups\Entity\Shipment\Label\LabelImageFormat $label_image_format
  * @property null|\Rawilk\Ups\Entity\Shipment\Label\Instruction $instruction
  */

src/Entity/Shipment/Package.php

@@ -13,9 +13,9 @@
 /**
  * @property bool $additional_handling Additional handling required.
  * @property null|string $description
- *      Merchandise description of package. Required for shipment with return service.
+ *                                    Merchandise description of package. Required for shipment with return service.
  * @property null|string $pallet_description
- *      Description of articles & special marks. Applicable for Air Freight only.
+ *                                           Description of articles & special marks. Applicable for Air Freight only.
  * @property bool $is_large
  * @property string $tracking_number
  * @property bool $ups_premium_care_indicator
@@ -29,7 +29,7 @@
  * @property \Rawilk\Ups\Entity\Shipment\ReferenceNumber $reference_number
  * @property \Rawilk\Ups\Entity\Shipment\ReferenceNumber $reference_number2
  * @property null|\Rawilk\Ups\Entity\Tracking\EstimatedDeliveryWindow $estimated_delivery_window
- *      Only applies to tracking api responses.
+ *                                                                                               Only applies to tracking api responses.
  */
 class Package extends Entity
 {
@@ -152,7 +152,7 @@ public function isPickedUp(): bool
      * Returns the name of the person who signed for the package if
      * it has been delivered when using the tracking api.
      */
-    public function signedForByName(): null|string
+    public function signedForByName(): ?string
     {
         if (! $this->isDelivered()) {
             return null;

src/Entity/Shipment/PackageResult.php

@@ -22,7 +22,7 @@ public function labelImage(): string
         return LabelImage::class;
     }
 
-    public function getDecodedImageContent(): null|string
+    public function getDecodedImageContent(): ?string
     {
         if (! $this->label_image->graphic_image) {
             return null;

src/Entity/Shipment/PackageServiceOptions/HazMat.php

@@ -9,14 +9,14 @@
 
 /**
  * @property int $packaging_type_quantity
- *      The number of pieces of the specific commodity.
+ *                                        The number of pieces of the specific commodity.
  * @property string $sub_risk_class
  * @property string $adr_item_number
- *      The type of regulated goods for an ADR package where ADR is for Europe to Europe ground movement.
+ *                                   The type of regulated goods for an ADR package where ADR is for Europe to Europe ground movement.
  * @property string $adr_packaging_group_letter
  * @property string $technical_name
  * @property string $hazard_label_required
- *      Defines the type of label that is required on the package for the commodity.
+ *                                         Defines the type of label that is required on the package for the commodity.
  * @property string $class_division_number
  * @property string $reference_number
  * @property string $quantity

src/Entity/Shipment/PackageServiceOptions/PackageServiceOptions.php

@@ -17,7 +17,7 @@
  * @property null|\Rawilk\Ups\Entity\Shipment\ShipmentServiceOptions\COD $cod
  * @property null|\Rawilk\Ups\Entity\Shipment\ShipmentServiceOptions\AccessPointCOD $access_point_cod
  * @property null|\Rawilk\Ups\Entity\Shipment\PackageServiceOptions\HazMat|\Rawilk\Ups\Entity\Shipment\PackageServiceOptions\HazMat[] $haz_mat
- *      Max of 3 allowed.
+ *                                                                                                                                             Max of 3 allowed.
  * @property null|\Rawilk\Ups\Entity\Shipment\PackageServiceOptions\HazMatPackageInformation $haz_mat_package_information
  */
 class PackageServiceOptions extends Entity

src/Entity/Shipment/ReferenceNumber.php

@@ -9,9 +9,9 @@
 /**
  * @property bool $barcode
  * @property string $code
- *      Reference Number type code. For the entire shipment, the code specifies the reference name.
+ *                        Reference Number type code. For the entire shipment, the code specifies the reference name.
  * @property string $value
- *      The customer supplied reference number.
+ *                         The customer supplied reference number.
  */
 class ReferenceNumber extends Entity
 {

src/Entity/Shipment/ShipFrom.php

@@ -11,9 +11,9 @@
  * @property string $company_name Origin location's company name.
  * @property null|string $attention_name Contact name at the pickup location.
  * @property null|string $tax_identification_number
- *      Company's tax identification number at the pickup location.
+ *                                                  Company's tax identification number at the pickup location.
  * @property null|\Rawilk\Ups\Entity\Shipment\TaxIDType $tax_id_type
- *      Applies to EEI form only.
+ *                                                                   Applies to EEI form only.
  * @property null|string $phone_number Origin location's phone number.
  * @property null|string $fax_number Origin location's fax number.
  * @property \Rawilk\Ups\Entity\Address\Address $address Address of the pickup location.

src/Entity/Shipment/ShipTo.php

@@ -9,7 +9,7 @@
 
 /**
  * @property null|string $location_id
- *      LocationID is a unique identifier referring to a specific shipping/receiving location.
+ *                                    LocationID is a unique identifier referring to a specific shipping/receiving location.
  * @property string $receiving_address_name
  * @property string $bookmark
  * @property string $shipper_assigned_identification_number

src/Entity/Shipment/Shipment.php

@@ -17,26 +17,26 @@
 
 /**
  * @property null|string $description
- *      The description of Goods for the shipment. Applies to international and domestic shipments.
+ *                                    The description of Goods for the shipment. Applies to international and domestic shipments.
  * @property bool $documents_only
- *      Indicates a shipment contains written typed, or printed communication of no commercial value.
+ *                                Indicates a shipment contains written typed, or printed communication of no commercial value.
  * @property bool $goods_not_in_free_circulation
  * @property null|int $num_of_pieces_in_shipment
- *      Total number of pieces in all pallets in a UPS World Wide Express Freight Shipment.
+ *                                               Total number of pieces in all pallets in a UPS World Wide Express Freight Shipment.
  * @property bool $rating_method_requested
- *      If true, Billable Weight Collection information and Rating Method information would be returned
- *      in response.
+ *                                         If true, Billable Weight Collection information and Rating Method information would be returned
+ *                                         in response.
  * @property bool $tax_information
- *      If true, any taxes that may be applicable to a shipment would be returned in a response.
+ *                                 If true, any taxes that may be applicable to a shipment would be returned in a response.
  * @property bool $master_carton
  * @property null|string $master_carton_id
  * @property null|\Rawilk\Ups\Entity\Shipment\ReturnService $return_service
- *      Type of return service. When this entity is present, the shipment is a return shipment.
+ *                                                                          Type of return service. When this entity is present, the shipment is a return shipment.
  * @property \Rawilk\Ups\Entity\Shipment\Shipper $shipper
- *      Container for the shipper's information.
+ *                                                        Container for the shipper's information.
  * @property \Rawilk\Ups\Entity\Shipment\ShipTo $ship_to
  * @property \Rawilk\Ups\Entity\Shipment\ShipFrom $ship_from
- *      Required for return shipment or if pickup location is different than the shipper's address.
+ *                                                           Required for return shipment or if pickup location is different than the shipper's address.
  * @property null|\Rawilk\Ups\Entity\Shipment\SoldTo $sold_to
  * @property null|\Rawilk\Ups\Entity\Payment\PaymentInformation $payment_information
  * @property null|\Rawilk\Ups\Entity\Payment\ItemizedPaymentInformation $itemized_payment_information
@@ -48,9 +48,9 @@
  * @property \Illuminate\Support\Collection|\Rawilk\Ups\Entity\Shipment\Package[] $packages
  * @property null|\Rawilk\Ups\Entity\Shipment\ShipmentIndicationType $shipment_indication_type
  * @property null|\Rawilk\Ups\Entity\Shipment\ReferenceNumber $reference_number
- *      Shipment reference number. Applies to tracking api responses.
+ *                                                                              Shipment reference number. Applies to tracking api responses.
  * @property null|\Carbon\Carbon $pickup_date
- *      Date shipment was picked up. Only applies to tracking api responses. Format: YYYYMMDD.
+ *                                            Date shipment was picked up. Only applies to tracking api responses. Format: YYYYMMDD.
  * @property null|string $shipment_identification_number Only applies to tracking api responses.
  */
 class Shipment extends Entity

src/Entity/Shipment/ShipmentServiceOptions/COD.php

@@ -13,7 +13,7 @@
  *
  * @property string $cod_code
  * @property string $cod_funds_code
- *      For valid values refer to: Rating and Shipping COD Supported Countries or Territories in the UPS developer docs Appendix.
+ *                                  For valid values refer to: Rating and Shipping COD Supported Countries or Territories in the UPS developer docs Appendix.
  * @property \Rawilk\Ups\Entity\Shipment\ShipmentServiceOptions\CODAmount $cod_amount
  */
 class COD extends Entity