diff --git a/app/code/Magento/Shipping/Block/Adminhtml/Create.php b/app/code/Magento/Shipping/Block/Adminhtml/Create.php index 454ba99c6422e..f5637a87a58ff 100644 --- a/app/code/Magento/Shipping/Block/Adminhtml/Create.php +++ b/app/code/Magento/Shipping/Block/Adminhtml/Create.php @@ -5,29 +5,34 @@ */ namespace Magento\Shipping\Block\Adminhtml; +use Magento\Backend\Block\Widget\Context as WidgetContext; +use Magento\Backend\Block\Widget\Form\Container as FormContainer; +use Magento\Framework\Registry; +use Magento\Sales\Model\Order\Shipment as OrderShipment; + /** * Adminhtml shipment create * * @api * @since 100.0.2 */ -class Create extends \Magento\Backend\Block\Widget\Form\Container +class Create extends FormContainer { /** * Core registry * - * @var \Magento\Framework\Registry + * @var Registry */ protected $_coreRegistry = null; /** - * @param \Magento\Backend\Block\Widget\Context $context - * @param \Magento\Framework\Registry $registry + * @param WidgetContext $context + * @param Registry $registry * @param array $data */ public function __construct( - \Magento\Backend\Block\Widget\Context $context, - \Magento\Framework\Registry $registry, + WidgetContext $context, + Registry $registry, array $data = [] ) { $this->_coreRegistry = $registry; @@ -51,7 +56,7 @@ protected function _construct() /** * Retrieve shipment model instance * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getShipment() { diff --git a/app/code/Magento/Shipping/Block/Adminhtml/Create/Form.php b/app/code/Magento/Shipping/Block/Adminhtml/Create/Form.php index 4869a685f3064..a7fea6b04f790 100644 --- a/app/code/Magento/Shipping/Block/Adminhtml/Create/Form.php +++ b/app/code/Magento/Shipping/Block/Adminhtml/Create/Form.php @@ -5,7 +5,14 @@ */ namespace Magento\Shipping\Block\Adminhtml\Create; +use Magento\Backend\Block\Template\Context as TemplateContext; use Magento\Framework\App\ObjectManager; +use Magento\Framework\Registry; +use Magento\Framework\View\Element\AbstractBlock; +use Magento\Sales\Block\Adminhtml\Order\AbstractOrder; +use Magento\Sales\Helper\Admin; +use Magento\Sales\Model\Order; +use Magento\Sales\Model\Order\Shipment as OrderShipment; use Magento\Tax\Helper\Data as TaxHelper; /** @@ -14,19 +21,19 @@ * @api * @since 100.0.2 */ -class Form extends \Magento\Sales\Block\Adminhtml\Order\AbstractOrder +class Form extends AbstractOrder { /** - * @param \Magento\Backend\Block\Template\Context $context - * @param \Magento\Framework\Registry $registry - * @param \Magento\Sales\Helper\Admin $adminHelper + * @param TemplateContext $context + * @param Registry $registry + * @param Admin $adminHelper * @param array $data * @param TaxHelper|null $taxHelper */ public function __construct( - \Magento\Backend\Block\Template\Context $context, - \Magento\Framework\Registry $registry, - \Magento\Sales\Helper\Admin $adminHelper, + TemplateContext $context, + Registry $registry, + Admin $adminHelper, array $data = [], ?TaxHelper $taxHelper = null ) { @@ -37,7 +44,7 @@ public function __construct( /** * Retrieve invoice order * - * @return \Magento\Sales\Model\Order + * @return Order */ public function getOrder() { @@ -47,7 +54,7 @@ public function getOrder() /** * Retrieve source * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getSource() { @@ -57,7 +64,7 @@ public function getSource() /** * Retrieve shipment model instance * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getShipment() { @@ -67,11 +74,11 @@ public function getShipment() /** * Prepare layout. * - * @return \Magento\Framework\View\Element\AbstractBlock + * @return AbstractBlock */ protected function _prepareLayout() { - $this->addChild('items', \Magento\Shipping\Block\Adminhtml\Create\Items::class); + $this->addChild('items', Items::class); return parent::_prepareLayout(); } diff --git a/app/code/Magento/Shipping/Block/Adminhtml/Create/Items.php b/app/code/Magento/Shipping/Block/Adminhtml/Create/Items.php index 6909772a8852c..ff4c3d1d759ba 100644 --- a/app/code/Magento/Shipping/Block/Adminhtml/Create/Items.php +++ b/app/code/Magento/Shipping/Block/Adminhtml/Create/Items.php @@ -5,42 +5,53 @@ */ namespace Magento\Shipping\Block\Adminhtml\Create; +use Magento\Backend\Block\Template\Context as TemplateContext; +use Magento\Backend\Block\Widget\Button as WidgetButton; +use Magento\CatalogInventory\Api\StockConfigurationInterface; +use Magento\CatalogInventory\Api\StockRegistryInterface; +use Magento\Framework\Registry; +use Magento\Sales\Block\Adminhtml\Items\AbstractItems; +use Magento\Sales\Helper\Data as SalesHelper; +use Magento\Sales\Model\Order; +use Magento\Sales\Model\Order\Shipment as OrderShipment; +use Magento\Shipping\Model\CarrierFactory; + /** * Adminhtml shipment items grid * * @api * @since 100.0.2 */ -class Items extends \Magento\Sales\Block\Adminhtml\Items\AbstractItems +class Items extends AbstractItems { /** * Sales data * - * @var \Magento\Sales\Helper\Data + * @var SalesHelper */ protected $_salesData; /** - * @var \Magento\Shipping\Model\CarrierFactory + * @var CarrierFactory */ protected $_carrierFactory; /** - * @param \Magento\Backend\Block\Template\Context $context - * @param \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry - * @param \Magento\CatalogInventory\Api\StockConfigurationInterface $stockConfiguration - * @param \Magento\Framework\Registry $registry - * @param \Magento\Sales\Helper\Data $salesData - * @param \Magento\Shipping\Model\CarrierFactory $carrierFactory + * @param TemplateContext $context + * @param StockRegistryInterface $stockRegistry + * @param StockConfigurationInterface $stockConfiguration + * @param Registry $registry + * @param SalesHelper $salesData + * @param CarrierFactory $carrierFactory * @param array $data */ public function __construct( - \Magento\Backend\Block\Template\Context $context, - \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry, - \Magento\CatalogInventory\Api\StockConfigurationInterface $stockConfiguration, - \Magento\Framework\Registry $registry, - \Magento\Sales\Helper\Data $salesData, - \Magento\Shipping\Model\CarrierFactory $carrierFactory, + TemplateContext $context, + StockRegistryInterface $stockRegistry, + StockConfigurationInterface $stockConfiguration, + Registry $registry, + SalesHelper $salesData, + CarrierFactory $carrierFactory, array $data = [] ) { $this->_salesData = $salesData; @@ -51,7 +62,7 @@ public function __construct( /** * Retrieve invoice order * - * @return \Magento\Sales\Model\Order + * @return Order */ public function getOrder() { @@ -61,7 +72,7 @@ public function getOrder() /** * Retrieve source * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getSource() { @@ -71,7 +82,7 @@ public function getSource() /** * Retrieve shipment model instance * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getShipment() { @@ -87,7 +98,7 @@ protected function _beforeToHtml() { $this->addChild( 'submit_button', - \Magento\Backend\Block\Widget\Button::class, + WidgetButton::class, [ 'label' => __('Submit Shipment'), 'class' => 'save submit-button primary', diff --git a/app/code/Magento/Shipping/Block/Adminhtml/Order/Packaging.php b/app/code/Magento/Shipping/Block/Adminhtml/Order/Packaging.php index f66b37a9cd34f..8383f4c4c290e 100644 --- a/app/code/Magento/Shipping/Block/Adminhtml/Order/Packaging.php +++ b/app/code/Magento/Shipping/Block/Adminhtml/Order/Packaging.php @@ -6,8 +6,17 @@ namespace Magento\Shipping\Block\Adminhtml\Order; +use Magento\Backend\Block\Template; +use Magento\Backend\Block\Template\Context as TemplateContext; use Magento\Framework\App\ObjectManager; +use Magento\Framework\DataObject; +use Magento\Framework\Json\EncoderInterface; +use Magento\Framework\Registry; +use Magento\Sales\Model\Order\Shipment as OrderShipment; use Magento\Shipping\Helper\Carrier; +use Magento\Shipping\Model\Carrier\Source\GenericInterface as SourceGenericInterface; +use Magento\Shipping\Model\CarrierFactory; +use Magento\Store\Model\ScopeInterface; /** * Adminhtml shipment packaging @@ -15,47 +24,47 @@ * @api * @since 100.0.2 */ -class Packaging extends \Magento\Backend\Block\Template +class Packaging extends Template { /** * Source size model * - * @var \Magento\Shipping\Model\Carrier\Source\GenericInterface + * @var SourceGenericInterface */ protected $_sourceSizeModel; /** * Core registry * - * @var \Magento\Framework\Registry + * @var Registry */ protected $_coreRegistry = null; /** - * @var \Magento\Framework\Json\EncoderInterface + * @var EncoderInterface */ protected $_jsonEncoder; /** - * @var \Magento\Shipping\Model\CarrierFactory + * @var CarrierFactory */ protected $_carrierFactory; /** - * @param \Magento\Backend\Block\Template\Context $context - * @param \Magento\Framework\Json\EncoderInterface $jsonEncoder - * @param \Magento\Shipping\Model\Carrier\Source\GenericInterface $sourceSizeModel - * @param \Magento\Framework\Registry $coreRegistry - * @param \Magento\Shipping\Model\CarrierFactory $carrierFactory + * @param TemplateContext $context + * @param EncoderInterface $jsonEncoder + * @param SourceGenericInterface $sourceSizeModel + * @param Registry $coreRegistry + * @param CarrierFactory $carrierFactory * @param array $data * @param Carrier|null $carrierHelper */ public function __construct( - \Magento\Backend\Block\Template\Context $context, - \Magento\Framework\Json\EncoderInterface $jsonEncoder, - \Magento\Shipping\Model\Carrier\Source\GenericInterface $sourceSizeModel, - \Magento\Framework\Registry $coreRegistry, - \Magento\Shipping\Model\CarrierFactory $carrierFactory, + TemplateContext $context, + EncoderInterface $jsonEncoder, + SourceGenericInterface $sourceSizeModel, + Registry $coreRegistry, + CarrierFactory $carrierFactory, array $data = [], ?Carrier $carrierHelper = null ) { @@ -70,7 +79,7 @@ public function __construct( /** * Retrieve shipment model instance * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getShipment() { @@ -154,12 +163,12 @@ public function getContainers() $address = $order->getShippingAddress(); $carrier = $this->_carrierFactory->create($order->getShippingMethod(true)->getCarrierCode()); $countryShipper = $this->_scopeConfig->getValue( - \Magento\Sales\Model\Order\Shipment::XML_PATH_STORE_COUNTRY_ID, - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + OrderShipment::XML_PATH_STORE_COUNTRY_ID, + ScopeInterface::SCOPE_STORE, $storeId ); if ($carrier) { - $params = new \Magento\Framework\DataObject( + $params = new DataObject( [ 'method' => $order->getShippingMethod(true)->getMethod(), 'country_shipper' => $countryShipper, @@ -216,7 +225,7 @@ public function getDeliveryConfirmationTypeByCode($code) $order = $this->getShipment()->getOrder(); $carrier = $this->_carrierFactory->create($order->getShippingMethod(true)->getCarrierCode()); if ($carrier) { - $params = new \Magento\Framework\DataObject(['country_recipient' => $countryId]); + $params = new DataObject(['country_recipient' => $countryId]); $confirmationTypes = $carrier->getDeliveryConfirmationTypes($params); $confirmationType = !empty($confirmationTypes[$code]) ? $confirmationTypes[$code] : ''; return $confirmationType; @@ -254,7 +263,7 @@ public function getPackages() * * @param string $itemId * @param string $itemsOf - * @return \Magento\Framework\DataObject + * @return DataObject */ public function getShipmentItem($itemId, $itemsOf) { @@ -268,7 +277,7 @@ public function getShipmentItem($itemId, $itemsOf) } } } - return new \Magento\Framework\DataObject(); + return new DataObject(); } /** @@ -282,8 +291,8 @@ public function displayCustomsValue() $order = $this->getShipment()->getOrder(); $address = $order->getShippingAddress(); $shipperAddressCountryCode = $this->_scopeConfig->getValue( - \Magento\Sales\Model\Order\Shipment::XML_PATH_STORE_COUNTRY_ID, - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + OrderShipment::XML_PATH_STORE_COUNTRY_ID, + ScopeInterface::SCOPE_STORE, $storeId ); $recipientAddressCountryCode = $address->getCountryId(); @@ -303,7 +312,7 @@ public function getDeliveryConfirmationTypes() $countryId = $this->getShipment()->getOrder()->getShippingAddress()->getCountryId(); $order = $this->getShipment()->getOrder(); $carrier = $this->_carrierFactory->create($order->getShippingMethod(true)->getCarrierCode()); - $params = new \Magento\Framework\DataObject(['country_recipient' => $countryId]); + $params = new DataObject(['country_recipient' => $countryId]); if ($carrier && is_array($carrier->getDeliveryConfirmationTypes($params))) { return $carrier->getDeliveryConfirmationTypes($params); } @@ -355,12 +364,12 @@ public function getContentTypes() $address = $order->getShippingAddress(); $carrier = $this->_carrierFactory->create($order->getShippingMethod(true)->getCarrierCode()); $countryShipper = $this->_scopeConfig->getValue( - \Magento\Sales\Model\Order\Shipment::XML_PATH_STORE_COUNTRY_ID, - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + OrderShipment::XML_PATH_STORE_COUNTRY_ID, + ScopeInterface::SCOPE_STORE, $storeId ); if ($carrier) { - $params = new \Magento\Framework\DataObject( + $params = new DataObject( [ 'method' => $order->getShippingMethod(true)->getMethod(), 'country_shipper' => $countryShipper, @@ -424,7 +433,7 @@ public function getQtyOrderedItem($itemId) /** * Get source size model * - * @return \Magento\Shipping\Model\Carrier\Source\GenericInterface + * @return SourceGenericInterface */ public function getSourceSizeModel() { diff --git a/app/code/Magento/Shipping/Block/Adminhtml/Order/Packaging/Grid.php b/app/code/Magento/Shipping/Block/Adminhtml/Order/Packaging/Grid.php index 1d3f6ad1ee5a3..9ae751dd7de15 100644 --- a/app/code/Magento/Shipping/Block/Adminhtml/Order/Packaging/Grid.php +++ b/app/code/Magento/Shipping/Block/Adminhtml/Order/Packaging/Grid.php @@ -5,6 +5,12 @@ */ namespace Magento\Shipping\Block\Adminhtml\Order\Packaging; +use Magento\Backend\Block\Template\Context as TemplateContext; +use Magento\Framework\Registry; +use Magento\Sales\Model\Order\Shipment as OrderShipment; +use Magento\Sales\Model\Order\Shipment\ItemFactory; +use Magento\Store\Model\ScopeInterface; + class Grid extends \Magento\Backend\Block\Template { /** @@ -15,25 +21,25 @@ class Grid extends \Magento\Backend\Block\Template /** * Core registry * - * @var \Magento\Framework\Registry + * @var Registry */ protected $_coreRegistry = null; /** - * @var \Magento\Sales\Model\Order\Shipment\ItemFactory + * @var ItemFactory */ protected $_shipmentItemFactory; /** - * @param \Magento\Backend\Block\Template\Context $context - * @param \Magento\Sales\Model\Order\Shipment\ItemFactory $shipmentItemFactory - * @param \Magento\Framework\Registry $registry + * @param TemplateContext $context + * @param ItemFactory $shipmentItemFactory + * @param Registry $registry * @param array $data */ public function __construct( - \Magento\Backend\Block\Template\Context $context, - \Magento\Sales\Model\Order\Shipment\ItemFactory $shipmentItemFactory, - \Magento\Framework\Registry $registry, + TemplateContext $context, + ItemFactory $shipmentItemFactory, + Registry $registry, array $data = [] ) { $this->_shipmentItemFactory = $shipmentItemFactory; @@ -61,7 +67,7 @@ public function getCollection() /** * Retrieve shipment model instance * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getShipment() { @@ -79,8 +85,8 @@ public function displayCustomsValue() $order = $this->getShipment()->getOrder(); $address = $order->getShippingAddress(); $shipperAddressCountryCode = $this->_scopeConfig->getValue( - \Magento\Sales\Model\Order\Shipment::XML_PATH_STORE_COUNTRY_ID, - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + OrderShipment::XML_PATH_STORE_COUNTRY_ID, + ScopeInterface::SCOPE_STORE, $storeId ); $recipientAddressCountryCode = $address->getCountryId(); diff --git a/app/code/Magento/Shipping/Block/Adminhtml/Order/Tracking.php b/app/code/Magento/Shipping/Block/Adminhtml/Order/Tracking.php index 155911244f300..d37db58bdcf1a 100644 --- a/app/code/Magento/Shipping/Block/Adminhtml/Order/Tracking.php +++ b/app/code/Magento/Shipping/Block/Adminhtml/Order/Tracking.php @@ -5,36 +5,43 @@ */ namespace Magento\Shipping\Block\Adminhtml\Order; +use Magento\Backend\Block\Template; +use Magento\Backend\Block\Template\Context as TemplateContext; +use Magento\Backend\Block\Widget\Button as WidgetButton; +use Magento\Framework\Registry; +use Magento\Sales\Model\Order\Shipment as OrderShipment; +use Magento\Shipping\Model\Config as ShippingConfig; + /** * Shipment tracking control form * * @api * @since 100.0.2 */ -class Tracking extends \Magento\Backend\Block\Template +class Tracking extends Template { /** * Core registry * - * @var \Magento\Framework\Registry + * @var Registry */ protected $_coreRegistry = null; /** - * @var \Magento\Shipping\Model\Config + * @var ShippingConfig */ protected $_shippingConfig; /** - * @param \Magento\Backend\Block\Template\Context $context - * @param \Magento\Shipping\Model\Config $shippingConfig - * @param \Magento\Framework\Registry $registry + * @param TemplateContext $context + * @param ShippingConfig $shippingConfig + * @param Registry $registry * @param array $data */ public function __construct( - \Magento\Backend\Block\Template\Context $context, - \Magento\Shipping\Model\Config $shippingConfig, - \Magento\Framework\Registry $registry, + TemplateContext $context, + ShippingConfig $shippingConfig, + Registry $registry, array $data = [] ) { $this->_shippingConfig = $shippingConfig; @@ -51,7 +58,7 @@ protected function _prepareLayout() { $this->addChild( 'add_button', - \Magento\Backend\Block\Widget\Button::class, + WidgetButton::class, ['label' => __('Add Tracking Number'), 'class' => '', 'onclick' => 'trackingControl.add()'] ); } @@ -59,7 +66,7 @@ protected function _prepareLayout() /** * Retrieve shipment model instance * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getShipment() { diff --git a/app/code/Magento/Shipping/Block/Adminhtml/Order/Tracking/Invoice.php b/app/code/Magento/Shipping/Block/Adminhtml/Order/Tracking/Invoice.php index 503fe2cae19d3..d6411b0b98903 100644 --- a/app/code/Magento/Shipping/Block/Adminhtml/Order/Tracking/Invoice.php +++ b/app/code/Magento/Shipping/Block/Adminhtml/Order/Tracking/Invoice.php @@ -9,16 +9,19 @@ */ namespace Magento\Shipping\Block\Adminhtml\Order\Tracking; +use Magento\Sales\Model\Order\Shipment as OrderShipment; +use Magento\Shipping\Block\Adminhtml\Order\Tracking; + /** * @api * @since 100.0.2 */ -class Invoice extends \Magento\Shipping\Block\Adminhtml\Order\Tracking +class Invoice extends Tracking { /** * Retrieve invoice * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getInvoice() { diff --git a/app/code/Magento/Shipping/Block/Adminhtml/Order/Tracking/View.php b/app/code/Magento/Shipping/Block/Adminhtml/Order/Tracking/View.php index 5830160b60791..adba0814f4205 100644 --- a/app/code/Magento/Shipping/Block/Adminhtml/Order/Tracking/View.php +++ b/app/code/Magento/Shipping/Block/Adminhtml/Order/Tracking/View.php @@ -5,8 +5,16 @@ */ namespace Magento\Shipping\Block\Adminhtml\Order\Tracking; +use Magento\Backend\Block\Template\Context as TemplateContext; +use Magento\Backend\Block\Widget\Button as WidgetButton; use Magento\Framework\App\ObjectManager; +use Magento\Framework\Phrase; +use Magento\Framework\Registry; +use Magento\Sales\Model\Order\Shipment\Track as OrderShipmentTrack; +use Magento\Shipping\Block\Adminhtml\Order\Tracking; use Magento\Shipping\Helper\Data as ShippingHelper; +use Magento\Shipping\Model\CarrierFactory; +use Magento\Shipping\Model\Config; /** * Shipment tracking control form @@ -14,26 +22,26 @@ * @api * @since 100.0.2 */ -class View extends \Magento\Shipping\Block\Adminhtml\Order\Tracking +class View extends Tracking { /** - * @var \Magento\Shipping\Model\CarrierFactory + * @var CarrierFactory */ protected $_carrierFactory; /** - * @param \Magento\Backend\Block\Template\Context $context - * @param \Magento\Shipping\Model\Config $shippingConfig - * @param \Magento\Framework\Registry $registry - * @param \Magento\Shipping\Model\CarrierFactory $carrierFactory + * @param TemplateContext $context + * @param Config $shippingConfig + * @param Registry $registry + * @param CarrierFactory $carrierFactory * @param array $data * @param ShippingHelper|null $shippingHelper */ public function __construct( - \Magento\Backend\Block\Template\Context $context, - \Magento\Shipping\Model\Config $shippingConfig, - \Magento\Framework\Registry $registry, - \Magento\Shipping\Model\CarrierFactory $carrierFactory, + TemplateContext $context, + Config $shippingConfig, + Registry $registry, + CarrierFactory $carrierFactory, array $data = [], ?ShippingHelper $shippingHelper = null ) { @@ -52,7 +60,7 @@ protected function _prepareLayout() $onclick = "saveTrackingInfo($('shipment_tracking_info').parentNode, '" . $this->getSubmitUrl() . "')"; $this->addChild( 'save_button', - \Magento\Backend\Block\Widget\Button::class, + WidgetButton::class, ['label' => __('Add'), 'class' => 'save', 'onclick' => $onclick] ); } @@ -80,7 +88,7 @@ public function getSaveButtonHtml() /** * Retrieve remove url * - * @param \Magento\Sales\Model\Order\Shipment\Track $track + * @param OrderShipmentTrack $track * @return string */ public function getRemoveUrl($track) @@ -96,7 +104,7 @@ public function getRemoveUrl($track) * * @param string $code * - * @return \Magento\Framework\Phrase|string|bool + * @return Phrase|string|bool */ public function getCarrierTitle($code) { diff --git a/app/code/Magento/Shipping/Block/Adminhtml/View.php b/app/code/Magento/Shipping/Block/Adminhtml/View.php index 04df7f6e35e24..229ef35d6eacb 100644 --- a/app/code/Magento/Shipping/Block/Adminhtml/View.php +++ b/app/code/Magento/Shipping/Block/Adminhtml/View.php @@ -5,6 +5,14 @@ */ namespace Magento\Shipping\Block\Adminhtml; +use DateTime; +use IntlDateFormatter; +use Magento\Backend\Block\Widget\Context; +use Magento\Backend\Block\Widget\Form\Container as FormContainer; +use Magento\Framework\Phrase; +use Magento\Framework\Registry; +use Magento\Sales\Model\Order\Shipment as OrderShipment; + /** * Adminhtml shipment create * @@ -12,23 +20,23 @@ * @author Magento Core Team * @since 100.0.2 */ -class View extends \Magento\Backend\Block\Widget\Form\Container +class View extends FormContainer { /** * Core registry * - * @var \Magento\Framework\Registry + * @var Registry */ protected $_coreRegistry = null; /** - * @param \Magento\Backend\Block\Widget\Context $context - * @param \Magento\Framework\Registry $registry + * @param Context $context + * @param Registry $registry * @param array $data */ public function __construct( - \Magento\Backend\Block\Widget\Context $context, - \Magento\Framework\Registry $registry, + Context $context, + Registry $registry, array $data = [] ) { $this->_coreRegistry = $registry; @@ -77,7 +85,7 @@ protected function _construct() /** * Retrieve shipment model instance * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getShipment() { @@ -85,7 +93,7 @@ public function getShipment() } /** - * @return \Magento\Framework\Phrase + * @return Phrase */ public function getHeaderText() { @@ -99,8 +107,8 @@ public function getHeaderText() $this->getShipment()->getIncrementId(), $emailSent, $this->formatDate( - $this->_localeDate->date(new \DateTime($this->getShipment()->getCreatedAt())), - \IntlDateFormatter::MEDIUM, + $this->_localeDate->date(new DateTime($this->getShipment()->getCreatedAt())), + IntlDateFormatter::MEDIUM, true ) ); diff --git a/app/code/Magento/Shipping/Block/Adminhtml/View/Comments.php b/app/code/Magento/Shipping/Block/Adminhtml/View/Comments.php index 7c852d7ebbf71..727d0599d92c7 100644 --- a/app/code/Magento/Shipping/Block/Adminhtml/View/Comments.php +++ b/app/code/Magento/Shipping/Block/Adminhtml/View/Comments.php @@ -11,27 +11,33 @@ */ namespace Magento\Shipping\Block\Adminhtml\View; +use Magento\Backend\Block\Text\ListText; +use Magento\Framework\Registry; +use Magento\Framework\View\Element\Context as ElementContext; +use Magento\Sales\Model\Order; +use Magento\Sales\Model\Order\Shipment as OrderShipment; + /** * @api * @since 100.0.2 */ -class Comments extends \Magento\Backend\Block\Text\ListText +class Comments extends ListText { /** * Core registry * - * @var \Magento\Framework\Registry + * @var Registry */ protected $_coreRegistry = null; /** - * @param \Magento\Framework\View\Element\Context $context - * @param \Magento\Framework\Registry $registry + * @param ElementContext $context + * @param Registry $registry * @param array $data */ public function __construct( - \Magento\Framework\View\Element\Context $context, - \Magento\Framework\Registry $registry, + ElementContext $context, + Registry $registry, array $data = [] ) { $this->_coreRegistry = $registry; @@ -41,7 +47,7 @@ public function __construct( /** * Retrieve shipment model instance * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getShipment() { @@ -51,7 +57,7 @@ public function getShipment() /** * Retrieve invoice order * - * @return \Magento\Sales\Model\Order + * @return Order */ public function getOrder() { @@ -61,7 +67,7 @@ public function getOrder() /** * Retrieve source * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getSource() { diff --git a/app/code/Magento/Shipping/Block/Adminhtml/View/Form.php b/app/code/Magento/Shipping/Block/Adminhtml/View/Form.php index 8467a34ed0368..a08b6c8916e69 100644 --- a/app/code/Magento/Shipping/Block/Adminhtml/View/Form.php +++ b/app/code/Magento/Shipping/Block/Adminhtml/View/Form.php @@ -11,35 +11,43 @@ */ namespace Magento\Shipping\Block\Adminhtml\View; +use Magento\Backend\Block\Template\Context as TemplateContext; +use Magento\Backend\Block\Widget\Button as WidgetButton; use Magento\Framework\App\ObjectManager; +use Magento\Framework\Registry; +use Magento\Sales\Block\Adminhtml\Order\AbstractOrder; +use Magento\Sales\Helper\Admin; +use Magento\Sales\Model\Order; +use Magento\Sales\Model\Order\Shipment as OrderShipment; use Magento\Shipping\Helper\Data as ShippingHelper; +use Magento\Shipping\Model\CarrierFactory; use Magento\Tax\Helper\Data as TaxHelper; /** * @api * @since 100.0.2 */ -class Form extends \Magento\Sales\Block\Adminhtml\Order\AbstractOrder +class Form extends AbstractOrder { /** - * @var \Magento\Shipping\Model\CarrierFactory + * @var CarrierFactory */ protected $_carrierFactory; /** - * @param \Magento\Backend\Block\Template\Context $context - * @param \Magento\Framework\Registry $registry - * @param \Magento\Sales\Helper\Admin $adminHelper - * @param \Magento\Shipping\Model\CarrierFactory $carrierFactory + * @param TemplateContext $context + * @param Registry $registry + * @param Admin $adminHelper + * @param CarrierFactory $carrierFactory * @param array $data * @param ShippingHelper|null $shippingHelper * @param TaxHelper|null $taxHelper */ public function __construct( - \Magento\Backend\Block\Template\Context $context, - \Magento\Framework\Registry $registry, - \Magento\Sales\Helper\Admin $adminHelper, - \Magento\Shipping\Model\CarrierFactory $carrierFactory, + TemplateContext $context, + Registry $registry, + Admin $adminHelper, + CarrierFactory $carrierFactory, array $data = [], ?ShippingHelper $shippingHelper = null, ?TaxHelper $taxHelper = null @@ -53,7 +61,7 @@ public function __construct( /** * Retrieve shipment model instance * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getShipment() { @@ -63,7 +71,7 @@ public function getShipment() /** * Retrieve invoice order * - * @return \Magento\Sales\Model\Order + * @return Order */ public function getOrder() { @@ -73,7 +81,7 @@ public function getOrder() /** * Retrieve source * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getSource() { @@ -91,7 +99,7 @@ public function getCreateLabelButton() $data['shipment_id'] = $this->getShipment()->getId(); $url = $this->getUrl('adminhtml/order_shipment/createLabel', $data); return $this->getLayout()->createBlock( - \Magento\Backend\Block\Widget\Button::class + WidgetButton::class )->setData( [ 'label' => __('Create Shipping Label...'), @@ -111,7 +119,7 @@ public function getPrintLabelButton() $data['shipment_id'] = $this->getShipment()->getId(); $url = $this->getUrl('adminhtml/order_shipment/printLabel', $data); return $this->getLayout()->createBlock( - \Magento\Backend\Block\Widget\Button::class + WidgetButton::class )->setData( ['label' => __('Print Shipping Label'), 'onclick' => 'setLocation(\'' . $url . '\')'] )->toHtml(); @@ -125,7 +133,7 @@ public function getPrintLabelButton() public function getShowPackagesButton() { return $this->getLayout()->createBlock( - \Magento\Backend\Block\Widget\Button::class + WidgetButton::class )->setData( ['label' => __('Show Packages'), 'onclick' => 'showPackedWindow();'] )->toHtml(); diff --git a/app/code/Magento/Shipping/Block/Adminhtml/View/Items.php b/app/code/Magento/Shipping/Block/Adminhtml/View/Items.php index 3eea3fe8eef91..c36f6e8d073eb 100644 --- a/app/code/Magento/Shipping/Block/Adminhtml/View/Items.php +++ b/app/code/Magento/Shipping/Block/Adminhtml/View/Items.php @@ -6,18 +6,22 @@ namespace Magento\Shipping\Block\Adminhtml\View; +use Magento\Sales\Block\Adminhtml\Items\AbstractItems; +use Magento\Sales\Model\Order; +use Magento\Sales\Model\Order\Shipment as OrderShipment; + /** * Adminhtml sales item renderer * * @api * @since 100.0.2 */ -class Items extends \Magento\Sales\Block\Adminhtml\Items\AbstractItems +class Items extends AbstractItems { /** * Retrieve shipment model instance * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getShipment() { @@ -27,7 +31,7 @@ public function getShipment() /** * Retrieve invoice order * - * @return \Magento\Sales\Model\Order + * @return Order */ public function getOrder() { @@ -37,7 +41,7 @@ public function getOrder() /** * Retrieve source * - * @return \Magento\Sales\Model\Order\Shipment + * @return OrderShipment */ public function getSource() { diff --git a/app/code/Magento/Shipping/Block/DataProviders/Tracking/DeliveryDateTitle.php b/app/code/Magento/Shipping/Block/DataProviders/Tracking/DeliveryDateTitle.php index ec1ee277a5a51..d3eb4b224dd86 100644 --- a/app/code/Magento/Shipping/Block/DataProviders/Tracking/DeliveryDateTitle.php +++ b/app/code/Magento/Shipping/Block/DataProviders/Tracking/DeliveryDateTitle.php @@ -6,6 +6,7 @@ namespace Magento\Shipping\Block\DataProviders\Tracking; +use Magento\Framework\Phrase; use Magento\Framework\View\Element\Block\ArgumentInterface; use Magento\Shipping\Model\Tracking\Result\Status; @@ -18,7 +19,7 @@ class DeliveryDateTitle implements ArgumentInterface * Returns Title in case if carrier defined * * @param Status $trackingStatus - * @return \Magento\Framework\Phrase|string + * @return Phrase|string */ public function getTitle(Status $trackingStatus) { diff --git a/app/code/Magento/Shipping/Block/Items.php b/app/code/Magento/Shipping/Block/Items.php index 59f92e8ea303d..611c7988959b8 100644 --- a/app/code/Magento/Shipping/Block/Items.php +++ b/app/code/Magento/Shipping/Block/Items.php @@ -11,29 +11,35 @@ */ namespace Magento\Shipping\Block; +use Magento\Framework\Registry; +use Magento\Framework\View\Element\Template\Context as TemplateContext; +use Magento\Sales\Block\Items\AbstractItems; +use Magento\Sales\Model\Order; +use Magento\Sales\Model\Order\Shipment as OrderShipment; + /** * Shipping Items Block * * @api * @since 100.0.2 */ -class Items extends \Magento\Sales\Block\Items\AbstractItems +class Items extends AbstractItems { /** * Core registry * - * @var \Magento\Framework\Registry + * @var Registry */ protected $_coreRegistry = null; /** - * @param \Magento\Framework\View\Element\Template\Context $context - * @param \Magento\Framework\Registry $registry + * @param TemplateContext $context + * @param Registry $registry * @param array $data */ public function __construct( - \Magento\Framework\View\Element\Template\Context $context, - \Magento\Framework\Registry $registry, + TemplateContext $context, + Registry $registry, array $data = [] ) { $this->_coreRegistry = $registry; @@ -43,7 +49,7 @@ public function __construct( /** * Retrieve current order model instance * - * @return \Magento\Sales\Model\Order + * @return Order */ public function getOrder() { @@ -75,7 +81,7 @@ public function getPrintAllShipmentsUrl($order) /** * Get html of shipment comments block * - * @param \Magento\Sales\Model\Order\Shipment $shipment + * @param OrderShipment $shipment * @return string */ public function getCommentsHtml($shipment) diff --git a/app/code/Magento/Shipping/Block/Order/Shipment.php b/app/code/Magento/Shipping/Block/Order/Shipment.php index 21e960985d6b6..76057b517974c 100644 --- a/app/code/Magento/Shipping/Block/Order/Shipment.php +++ b/app/code/Magento/Shipping/Block/Order/Shipment.php @@ -6,6 +6,13 @@ namespace Magento\Shipping\Block\Order; use Magento\Customer\Model\Context; +use Magento\Framework\App\Http\Context as HttpContext; +use Magento\Framework\Phrase; +use Magento\Framework\Registry; +use Magento\Framework\View\Element\Template; +use Magento\Framework\View\Element\Template\Context as TemplateContext; +use Magento\Payment\Helper\Data as PaymentHelper; +use Magento\Sales\Model\Order; /** * Sales order view block @@ -13,7 +20,7 @@ * @api * @since 100.0.2 */ -class Shipment extends \Magento\Framework\View\Element\Template +class Shipment extends Template { /** * @var string @@ -23,37 +30,31 @@ class Shipment extends \Magento\Framework\View\Element\Template /** * Core registry * - * @var \Magento\Framework\Registry + * @var Registry */ protected $_coreRegistry = null; /** - * @var \Magento\Framework\App\Http\Context - */ - protected $httpContext; - - /** - * @var \Magento\Payment\Helper\Data + * @var PaymentHelper */ protected $_paymentHelper; /** - * @param \Magento\Framework\View\Element\Template\Context $context - * @param \Magento\Framework\Registry $registry - * @param \Magento\Framework\App\Http\Context $httpContext - * @param \Magento\Payment\Helper\Data $paymentHelper + * @param TemplateContext $context + * @param Registry $registry + * @param HttpContext $httpContext + * @param PaymentHelper $paymentHelper * @param array $data */ public function __construct( - \Magento\Framework\View\Element\Template\Context $context, - \Magento\Framework\Registry $registry, - \Magento\Framework\App\Http\Context $httpContext, - \Magento\Payment\Helper\Data $paymentHelper, + TemplateContext $context, + Registry $registry, + protected readonly HttpContext $httpContext, + PaymentHelper $paymentHelper, array $data = [] ) { $this->_paymentHelper = $paymentHelper; $this->_coreRegistry = $registry; - $this->httpContext = $httpContext; parent::__construct($context, $data); $this->_isScopePrivate = true; } @@ -79,7 +80,7 @@ public function getPaymentInfoHtml() /** * Retrieve current order model instance * - * @return \Magento\Sales\Model\Order + * @return Order */ public function getOrder() { @@ -102,7 +103,7 @@ public function getBackUrl() /** * Return back title for logged in and guest users * - * @return \Magento\Framework\Phrase + * @return Phrase */ public function getBackTitle() { diff --git a/app/code/Magento/Shipping/Block/Tracking/Ajax.php b/app/code/Magento/Shipping/Block/Tracking/Ajax.php index c63218c05d886..2cc0560c8082a 100644 --- a/app/code/Magento/Shipping/Block/Tracking/Ajax.php +++ b/app/code/Magento/Shipping/Block/Tracking/Ajax.php @@ -5,6 +5,8 @@ */ namespace Magento\Shipping\Block\Tracking; -class Ajax extends \Magento\Framework\View\Element\Template +use Magento\Framework\View\Element\Template; + +class Ajax extends Template { } diff --git a/app/code/Magento/Shipping/Block/Tracking/Link.php b/app/code/Magento/Shipping/Block/Tracking/Link.php index 5762a18fc1c70..8c84152a788b9 100644 --- a/app/code/Magento/Shipping/Block/Tracking/Link.php +++ b/app/code/Magento/Shipping/Block/Tracking/Link.php @@ -5,38 +5,45 @@ */ namespace Magento\Shipping\Block\Tracking; +use Magento\Framework\Registry; +use Magento\Framework\View\Element\Html\Link as HtmlLink; +use Magento\Framework\View\Element\Template\Context as TemplateContext; +use Magento\Sales\Model\AbstractModel; +use Magento\Sales\Model\Order; +use Magento\Shipping\Helper\Data as ShippingHelper; + /** * Tracking info link * * @api * @since 100.0.2 */ -class Link extends \Magento\Framework\View\Element\Html\Link +class Link extends HtmlLink { /** * Core registry * - * @var \Magento\Framework\Registry + * @var Registry */ protected $_coreRegistry; /** * Shipping data * - * @var \Magento\Shipping\Helper\Data + * @var ShippingHelper */ protected $_shippingData; /** - * @param \Magento\Framework\View\Element\Template\Context $context - * @param \Magento\Framework\Registry $registry - * @param \Magento\Shipping\Helper\Data $shippingData + * @param TemplateContext $context + * @param Registry $registry + * @param ShippingHelper $shippingData * @param array $data */ public function __construct( - \Magento\Framework\View\Element\Template\Context $context, - \Magento\Framework\Registry $registry, - \Magento\Shipping\Helper\Data $shippingData, + TemplateContext $context, + Registry $registry, + ShippingHelper $shippingData, array $data = [] ) { $this->_shippingData = $shippingData; @@ -45,7 +52,7 @@ public function __construct( } /** - * @param \Magento\Sales\Model\AbstractModel $model + * @param AbstractModel $model * @return string */ public function getWindowUrl($model) @@ -56,7 +63,7 @@ public function getWindowUrl($model) /** * Retrieve current order model instance * - * @return \Magento\Sales\Model\Order + * @return Order */ public function getOrder() { diff --git a/app/code/Magento/Shipping/Block/Tracking/Popup.php b/app/code/Magento/Shipping/Block/Tracking/Popup.php index 1eb679bd8cc76..4e43f5b63591d 100644 --- a/app/code/Magento/Shipping/Block/Tracking/Popup.php +++ b/app/code/Magento/Shipping/Block/Tracking/Popup.php @@ -6,7 +6,14 @@ namespace Magento\Shipping\Block\Tracking; +use DateTime; +use IntlDateFormatter; +use Magento\Framework\Registry; use Magento\Framework\Stdlib\DateTime\DateTimeFormatterInterface; +use Magento\Framework\View\Element\Template; +use Magento\Framework\View\Element\Template\Context as TemplateContext; +use Magento\Shipping\Model\Info; +use Magento\Store\Model\ScopeInterface; /** * Tracking popup @@ -14,35 +21,29 @@ * @api * @since 100.0.2 */ -class Popup extends \Magento\Framework\View\Element\Template +class Popup extends Template { /** * Core registry * - * @var \Magento\Framework\Registry + * @var Registry */ protected $_registry; /** - * @var DateTimeFormatterInterface - */ - protected $dateTimeFormatter; - - /** - * @param \Magento\Framework\View\Element\Template\Context $context - * @param \Magento\Framework\Registry $registry + * @param TemplateContext $context + * @param Registry $registry * @param DateTimeFormatterInterface $dateTimeFormatter * @param array $data */ public function __construct( - \Magento\Framework\View\Element\Template\Context $context, - \Magento\Framework\Registry $registry, - DateTimeFormatterInterface $dateTimeFormatter, + TemplateContext $context, + Registry $registry, + protected readonly DateTimeFormatterInterface $dateTimeFormatter, array $data = [] ) { $this->_registry = $registry; parent::__construct($context, $data); - $this->dateTimeFormatter = $dateTimeFormatter; } /** @@ -52,7 +53,7 @@ public function __construct( */ public function getTrackingInfo() { - /* @var $info \Magento\Shipping\Model\Info */ + /* @var Info $info */ $info = $this->_registry->registry('current_shipping_info'); return $info->getTrackingInfo(); @@ -78,8 +79,8 @@ public function formatDeliveryDateTime($date, $time) */ public function formatDeliveryDate($date) { - $format = $this->_localeDate->getDateFormat(\IntlDateFormatter::MEDIUM); - return $this->dateTimeFormatter->formatObject($this->_localeDate->date(new \DateTime($date)), $format); + $format = $this->_localeDate->getDateFormat(IntlDateFormatter::MEDIUM); + return $this->dateTimeFormatter->formatObject($this->_localeDate->date(new DateTime($date)), $format); } /** @@ -95,8 +96,8 @@ public function formatDeliveryTime($time, $date = null) $time = $date . ' ' . $time; } - $format = $this->_localeDate->getTimeFormat(\IntlDateFormatter::SHORT); - return $this->dateTimeFormatter->formatObject($this->_localeDate->date(new \DateTime($time)), $format); + $format = $this->_localeDate->getTimeFormat(IntlDateFormatter::SHORT); + return $this->dateTimeFormatter->formatObject($this->_localeDate->date(new DateTime($time)), $format); } /** @@ -109,7 +110,7 @@ public function getContactUsEnabled() { return $this->_scopeConfig->isSetFlag( 'contact/contact/enabled', - \Magento\Store\Model\ScopeInterface::SCOPE_STORE + ScopeInterface::SCOPE_STORE ); } @@ -122,7 +123,7 @@ public function getStoreSupportEmail() { return $this->_scopeConfig->getValue( 'trans_email/ident_support/email', - \Magento\Store\Model\ScopeInterface::SCOPE_STORE + ScopeInterface::SCOPE_STORE ); } diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/AddComment.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/AddComment.php index 483ac21689baf..7df7c41ecb9c3 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/AddComment.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/AddComment.php @@ -7,11 +7,15 @@ namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment; +use Exception; +use Magento\Framework\Exception\LocalizedException; +use Magento\Framework\Json\Helper\Data as Json; use Magento\Sales\Model\Order\Email\Sender\ShipmentCommentSender; use Magento\Backend\App\Action; use Magento\Framework\View\Result\LayoutFactory; +use Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader; -class AddComment extends \Magento\Backend\App\Action +class AddComment extends Action { /** * Authorization level of a basic admin session @@ -20,36 +24,18 @@ class AddComment extends \Magento\Backend\App\Action */ const ADMIN_RESOURCE = 'Magento_Sales::shipment'; - /** - * @var \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader - */ - protected $shipmentLoader; - - /** - * @var ShipmentCommentSender - */ - protected $shipmentCommentSender; - - /** - * @var LayoutFactory - */ - protected $resultLayoutFactory; - /** * @param Action\Context $context - * @param \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader + * @param ShipmentLoader $shipmentLoader * @param ShipmentCommentSender $shipmentCommentSender * @param LayoutFactory $resultLayoutFactory */ public function __construct( Action\Context $context, - \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader, - ShipmentCommentSender $shipmentCommentSender, - LayoutFactory $resultLayoutFactory + protected readonly ShipmentLoader $shipmentLoader, + protected readonly ShipmentCommentSender $shipmentCommentSender, + protected readonly LayoutFactory $resultLayoutFactory ) { - $this->shipmentLoader = $shipmentLoader; - $this->shipmentCommentSender = $shipmentCommentSender; - $this->resultLayoutFactory = $resultLayoutFactory; parent::__construct($context); } @@ -64,7 +50,7 @@ public function execute() $this->getRequest()->setParam('shipment_id', $this->getRequest()->getParam('id')); $data = $this->getRequest()->getPost('comment'); if (empty($data['comment'])) { - throw new \Magento\Framework\Exception\LocalizedException( + throw new LocalizedException( __('The comment is missing. Enter and try again.') ); } @@ -84,13 +70,13 @@ public function execute() $resultLayout = $this->resultLayoutFactory->create(); $resultLayout->addDefaultHandle(); $response = $resultLayout->getLayout()->getBlock('shipment_comments')->toHtml(); - } catch (\Magento\Framework\Exception\LocalizedException $e) { + } catch (LocalizedException $e) { $response = ['error' => true, 'message' => $e->getMessage()]; - } catch (\Exception $e) { + } catch (Exception $e) { $response = ['error' => true, 'message' => __('Cannot add new comment.')]; } if (is_array($response)) { - $response = $this->_objectManager->get(\Magento\Framework\Json\Helper\Data::class)->jsonEncode($response); + $response = $this->_objectManager->get(Json::class)->jsonEncode($response); $this->getResponse()->representJson($response); } else { $this->getResponse()->setBody($response); diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/AddTrack.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/AddTrack.php index c417a202321b2..f59b8e3f638a0 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/AddTrack.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/AddTrack.php @@ -7,6 +7,7 @@ namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment; +use Exception; use Magento\Backend\App\Action; use Magento\Framework\App\Action\HttpPostActionInterface; use Magento\Framework\App\ObjectManager; @@ -30,26 +31,6 @@ class AddTrack extends Action implements HttpPostActionInterface */ const ADMIN_RESOURCE = 'Magento_Sales::shipment'; - /** - * @var ShipmentLoader - */ - protected $shipmentLoader; - - /** - * @var ShipmentRepositoryInterface - */ - private $shipmentRepository; - - /** - * @var ShipmentTrackInterfaceFactory - */ - private $trackFactory; - - /** - * @var SerializerInterface - */ - private $serializer; - /** * @param Action\Context $context * @param ShipmentLoader $shipmentLoader @@ -59,14 +40,13 @@ class AddTrack extends Action implements HttpPostActionInterface */ public function __construct( Action\Context $context, - ShipmentLoader $shipmentLoader, - ShipmentRepositoryInterface $shipmentRepository = null, - ShipmentTrackInterfaceFactory $trackFactory = null, - SerializerInterface $serializer = null + protected readonly ShipmentLoader $shipmentLoader, + private ?ShipmentRepositoryInterface $shipmentRepository = null, + private ?ShipmentTrackInterfaceFactory $trackFactory = null, + private ?SerializerInterface $serializer = null ) { parent::__construct($context); - $this->shipmentLoader = $shipmentLoader; $this->shipmentRepository = $shipmentRepository ?: ObjectManager::getInstance() ->get(ShipmentRepositoryInterface::class); $this->trackFactory = $trackFactory ?: ObjectManager::getInstance() @@ -121,7 +101,7 @@ public function execute() } } catch (LocalizedException $e) { $response = ['error' => true, 'message' => $e->getMessage()]; - } catch (\Exception $e) { + } catch (Exception $e) { $response = ['error' => true, 'message' => __('Cannot add tracking number.')]; } diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/CreateLabel.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/CreateLabel.php index 464c8a01528a4..9c9040f43c84a 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/CreateLabel.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/CreateLabel.php @@ -6,9 +6,15 @@ */ namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment; +use Exception; use Magento\Backend\App\Action; +use Magento\Framework\DataObject; +use Magento\Framework\Exception\LocalizedException; +use Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader; +use Magento\Shipping\Model\Shipping\LabelGenerator; +use Psr\Log\LoggerInterface; -class CreateLabel extends \Magento\Backend\App\Action +class CreateLabel extends Action { /** * Authorization level of a basic admin session @@ -17,28 +23,16 @@ class CreateLabel extends \Magento\Backend\App\Action */ const ADMIN_RESOURCE = 'Magento_Sales::shipment'; - /** - * @var \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader - */ - protected $shipmentLoader; - - /** - * @var \Magento\Shipping\Model\Shipping\LabelGenerator - */ - protected $labelGenerator; - /** * @param Action\Context $context - * @param \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader - * @param \Magento\Shipping\Model\Shipping\LabelGenerator $labelGenerator + * @param ShipmentLoader $shipmentLoader + * @param LabelGenerator $labelGenerator */ public function __construct( Action\Context $context, - \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader, - \Magento\Shipping\Model\Shipping\LabelGenerator $labelGenerator + protected readonly ShipmentLoader $shipmentLoader, + protected readonly LabelGenerator $labelGenerator ) { - $this->shipmentLoader = $shipmentLoader; - $this->labelGenerator = $labelGenerator; parent::__construct($context); } @@ -49,7 +43,7 @@ public function __construct( */ public function execute() { - $response = new \Magento\Framework\DataObject(); + $response = new DataObject(); try { $this->shipmentLoader->setOrderId($this->getRequest()->getParam('order_id')); $this->shipmentLoader->setShipmentId($this->getRequest()->getParam('shipment_id')); @@ -60,11 +54,11 @@ public function execute() $shipment->save(); $this->messageManager->addSuccess(__('You created the shipping label.')); $response->setOk(true); - } catch (\Magento\Framework\Exception\LocalizedException $e) { + } catch (LocalizedException $e) { $response->setError(true); $response->setMessage($e->getMessage()); - } catch (\Exception $e) { - $this->_objectManager->get(\Psr\Log\LoggerInterface::class)->critical($e); + } catch (Exception $e) { + $this->_objectManager->get(LoggerInterface::class)->critical($e); $response->setError(true); $response->setMessage(__('An error occurred while creating shipping label.')); } diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Email.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Email.php index 1f5d6e2cb7a89..c55eff88fed15 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Email.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Email.php @@ -6,15 +6,20 @@ */ namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment; +use Exception; use Magento\Backend\App\Action; +use Magento\Backend\Model\View\Result\Redirect as ResultRedirect; use Magento\Framework\Controller\ResultFactory; +use Magento\Framework\Exception\LocalizedException; +use Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader; +use Magento\Shipping\Model\ShipmentNotifier; /** * Class Email * * @package Magento\Shipping\Controller\Adminhtml\Order\Shipment */ -class Email extends \Magento\Backend\App\Action +class Email extends Action { /** * Authorization level of a basic admin session @@ -23,27 +28,21 @@ class Email extends \Magento\Backend\App\Action */ const ADMIN_RESOURCE = 'Magento_Sales::shipment'; - /** - * @var \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader - */ - protected $shipmentLoader; - /** * @param Action\Context $context - * @param \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader + * @param ShipmentLoader $shipmentLoader */ public function __construct( Action\Context $context, - \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader + protected readonly ShipmentLoader $shipmentLoader ) { - $this->shipmentLoader = $shipmentLoader; parent::__construct($context); } /** * Send email with shipment data to customer * - * @return \Magento\Backend\Model\View\Result\Redirect + * @return ResultRedirect */ public function execute() { @@ -54,14 +53,14 @@ public function execute() $this->shipmentLoader->setTracking($this->getRequest()->getParam('tracking')); $shipment = $this->shipmentLoader->load(); if ($shipment) { - $this->_objectManager->create(\Magento\Shipping\Model\ShipmentNotifier::class) + $this->_objectManager->create(ShipmentNotifier::class) ->notify($shipment); $shipment->save(); $this->messageManager->addSuccess(__('You sent the shipment.')); } - } catch (\Magento\Framework\Exception\LocalizedException $e) { + } catch (LocalizedException $e) { $this->messageManager->addError($e->getMessage()); - } catch (\Exception $e) { + } catch (Exception $e) { $this->messageManager->addError(__('Cannot send shipment information.')); } diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/GetShippingItemsGrid.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/GetShippingItemsGrid.php index 9a0956d9b61f2..22fc00d3c81c1 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/GetShippingItemsGrid.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/GetShippingItemsGrid.php @@ -8,8 +8,10 @@ use Magento\Backend\App\Action; use Magento\Framework\App\ResponseInterface; +use Magento\Shipping\Block\Adminhtml\Order\Packaging\Grid as PackagingGrid; +use Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader; -class GetShippingItemsGrid extends \Magento\Backend\App\Action +class GetShippingItemsGrid extends Action { /** * Authorization level of a basic admin session @@ -18,20 +20,14 @@ class GetShippingItemsGrid extends \Magento\Backend\App\Action */ const ADMIN_RESOURCE = 'Magento_Sales::shipment'; - /** - * @var \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader - */ - protected $shipmentLoader; - /** * @param Action\Context $context - * @param \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader + * @param ShipmentLoader $shipmentLoader */ public function __construct( Action\Context $context, - \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader + protected readonly ShipmentLoader $shipmentLoader ) { - $this->shipmentLoader = $shipmentLoader; parent::__construct($context); } @@ -49,7 +45,7 @@ public function execute() $this->shipmentLoader->load(); return $this->getResponse()->setBody( $this->_view->getLayout()->createBlock( - \Magento\Shipping\Block\Adminhtml\Order\Packaging\Grid::class + PackagingGrid::class )->setIndex( $this->getRequest()->getParam('index') )->toHtml() diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Index.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Index.php index 77baa2894d43c..3240ec47632ab 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Index.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Index.php @@ -6,6 +6,8 @@ */ namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment; -class Index extends \Magento\Sales\Controller\Adminhtml\Shipment\AbstractShipment\Index +use Magento\Sales\Controller\Adminhtml\Shipment\AbstractShipment\Index as AbstractShipmentIndex; + +class Index extends AbstractShipmentIndex { } diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/MassPrintShippingLabel.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/MassPrintShippingLabel.php index bfe3dc1f94f06..8f2cc8dbfc8de 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/MassPrintShippingLabel.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/MassPrintShippingLabel.php @@ -10,6 +10,8 @@ use Magento\Framework\App\ResponseInterface; use Magento\Framework\App\Filesystem\DirectoryList; use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection; +use Magento\Sales\Controller\Adminhtml\Order\AbstractMassAction; +use Magento\Sales\Model\Order\Shipment as OrderShipment; use Magento\Ui\Component\MassAction\Filter; use Magento\Backend\App\Action\Context; use Magento\Shipping\Model\Shipping\LabelGenerator; @@ -21,7 +23,7 @@ /** * @SuppressWarnings(PHPMD.CouplingBetweenObjects) */ -class MassPrintShippingLabel extends \Magento\Sales\Controller\Adminhtml\Order\AbstractMassAction +class MassPrintShippingLabel extends AbstractMassAction { /** * Authorization level of a basic admin session @@ -30,26 +32,11 @@ class MassPrintShippingLabel extends \Magento\Sales\Controller\Adminhtml\Order\A */ const ADMIN_RESOURCE = 'Magento_Sales::shipment'; - /** - * @var LabelGenerator - */ - protected $labelGenerator; - - /** - * @var FileFactory - */ - protected $fileFactory; - /** * @var CollectionFactory */ protected $collectionFactory; - /** - * @var ShipmentCollectionFactory - */ - protected $shipmentCollectionFactory; - /** * @param Context $context * @param Filter $filter @@ -62,14 +49,11 @@ public function __construct( Context $context, Filter $filter, CollectionFactory $collectionFactory, - FileFactory $fileFactory, - LabelGenerator $labelGenerator, - ShipmentCollectionFactory $shipmentCollectionFactory + protected readonly FileFactory $fileFactory, + protected readonly LabelGenerator $labelGenerator, + protected readonly ShipmentCollectionFactory $shipmentCollectionFactory ) { - $this->fileFactory = $fileFactory; $this->collectionFactory = $collectionFactory; - $this->shipmentCollectionFactory = $shipmentCollectionFactory; - $this->labelGenerator = $labelGenerator; parent::__construct($context, $filter); } @@ -86,7 +70,7 @@ protected function massAction(AbstractCollection $collection) $shipments = $this->shipmentCollectionFactory->create()->setOrderFilter(['in' => $collection->getAllIds()]); if ($shipments->getSize()) { - /** @var \Magento\Sales\Model\Order\Shipment $shipment */ + /** @var OrderShipment $shipment */ foreach ($shipments as $shipment) { $labelContent = $shipment->getShippingLabel(); if ($labelContent) { diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/NewAction.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/NewAction.php index 7231bc8b9c6e0..5e74ff9228b36 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/NewAction.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/NewAction.php @@ -6,11 +6,14 @@ */ namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment; +use Magento\Backend\Model\Session as BackendSession; use Magento\Framework\App\Action\HttpGetActionInterface as HttpGetActionInterface; use Magento\Backend\App\Action; use Magento\Framework\App\ObjectManager; +use Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader; +use Magento\Shipping\Model\ShipmentProviderInterface; -class NewAction extends \Magento\Backend\App\Action implements HttpGetActionInterface +class NewAction extends Action implements HttpGetActionInterface { /** * Authorization level of a basic admin session @@ -19,29 +22,18 @@ class NewAction extends \Magento\Backend\App\Action implements HttpGetActionInte */ const ADMIN_RESOURCE = 'Magento_Sales::shipment'; - /** - * @var \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader - */ - protected $shipmentLoader; - - /** - * @var \Magento\Shipping\Model\ShipmentProviderInterface - */ - private $shipmentProvider; - /** * @param Action\Context $context - * @param \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader - * @param \Magento\Shipping\Model\ShipmentProviderInterface $shipmentProvider + * @param ShipmentLoader $shipmentLoader + * @param ShipmentProviderInterface $shipmentProvider */ public function __construct( Action\Context $context, - \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader, - \Magento\Shipping\Model\ShipmentProviderInterface $shipmentProvider = null + protected readonly ShipmentLoader $shipmentLoader, + private ?ShipmentProviderInterface $shipmentProvider = null ) { - $this->shipmentLoader = $shipmentLoader; $this->shipmentProvider = $shipmentProvider ?: ObjectManager::getInstance() - ->get(\Magento\Shipping\Model\ShipmentProviderInterface::class); + ->get(ShipmentProviderInterface::class); parent::__construct($context); } @@ -58,7 +50,7 @@ public function execute() $this->shipmentLoader->setTracking($this->getRequest()->getParam('tracking')); $shipment = $this->shipmentLoader->load(); if ($shipment) { - $comment = $this->_objectManager->get(\Magento\Backend\Model\Session::class)->getCommentText(true); + $comment = $this->_objectManager->get(BackendSession::class)->getCommentText(true); if ($comment) { $shipment->setCommentText($comment); } diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Pdfshipments.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Pdfshipments.php index 2fa6379a923e1..e7ad094c9ab30 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Pdfshipments.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Pdfshipments.php @@ -6,6 +6,8 @@ */ namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment; -class Pdfshipments extends \Magento\Sales\Controller\Adminhtml\Shipment\AbstractShipment\Pdfshipments +use Magento\Sales\Controller\Adminhtml\Shipment\AbstractShipment\Pdfshipments as AbstractShipmentPdfshipments; + +class Pdfshipments extends AbstractShipmentPdfshipments { } diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/PrintAction.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/PrintAction.php index 74e8b3ad2a1cc..e067f77931ac8 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/PrintAction.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/PrintAction.php @@ -6,6 +6,8 @@ */ namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment; -class PrintAction extends \Magento\Sales\Controller\Adminhtml\Shipment\AbstractShipment\PrintAction +use Magento\Sales\Controller\Adminhtml\Shipment\AbstractShipment\PrintAction as AbstractShipmentPrintAction; + +class PrintAction extends AbstractShipmentPrintAction { } diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/PrintLabel.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/PrintLabel.php index 323cbde977d64..626773baf006e 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/PrintLabel.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/PrintLabel.php @@ -7,10 +7,16 @@ namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment; use Magento\Backend\App\Action; +use Magento\Framework\App\Response\Http\FileFactory; use Magento\Framework\App\ResponseInterface; use Magento\Framework\App\Filesystem\DirectoryList; +use Magento\Framework\Exception\LocalizedException; +use Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader; +use Magento\Shipping\Model\Shipping\LabelGenerator; +use Psr\Log\LoggerInterface; +use Zend_Pdf; -class PrintLabel extends \Magento\Backend\App\Action +class PrintLabel extends Action { /** * Authorization level of a basic admin session @@ -20,34 +26,22 @@ class PrintLabel extends \Magento\Backend\App\Action const ADMIN_RESOURCE = 'Magento_Sales::shipment'; /** - * @var \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader - */ - protected $shipmentLoader; - - /** - * @var \Magento\Shipping\Model\Shipping\LabelGenerator - */ - protected $labelGenerator; - - /** - * @var \Magento\Framework\App\Response\Http\FileFactory + * @var FileFactory */ protected $_fileFactory; /** * @param Action\Context $context - * @param \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader - * @param \Magento\Shipping\Model\Shipping\LabelGenerator $labelGenerator - * @param \Magento\Framework\App\Response\Http\FileFactory $fileFactory + * @param ShipmentLoader $shipmentLoader + * @param LabelGenerator $labelGenerator + * @param FileFactory $fileFactory */ public function __construct( Action\Context $context, - \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader, - \Magento\Shipping\Model\Shipping\LabelGenerator $labelGenerator, - \Magento\Framework\App\Response\Http\FileFactory $fileFactory + protected readonly ShipmentLoader $shipmentLoader, + protected readonly LabelGenerator $labelGenerator, + FileFactory $fileFactory ) { - $this->shipmentLoader = $shipmentLoader; - $this->labelGenerator = $labelGenerator; $this->_fileFactory = $fileFactory; parent::__construct($context); } @@ -71,7 +65,7 @@ public function execute() if (stripos($labelContent, '%PDF-') !== false) { $pdfContent = $labelContent; } else { - $pdf = new \Zend_Pdf(); + $pdf = new Zend_Pdf(); $page = $this->labelGenerator->createPdfPageFromImageString($labelContent); if (!$page) { $this->messageManager->addError( @@ -92,10 +86,10 @@ public function execute() 'application/pdf' ); } - } catch (\Magento\Framework\Exception\LocalizedException $e) { + } catch (LocalizedException $e) { $this->messageManager->addError($e->getMessage()); } catch (\Exception $e) { - $this->_objectManager->get(\Psr\Log\LoggerInterface::class)->critical($e); + $this->_objectManager->get(LoggerInterface::class)->critical($e); $this->messageManager->addError(__('An error occurred while creating shipping label.')); } $this->_redirect( diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/PrintPackage.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/PrintPackage.php index bba3fb417e18f..10dfcd5cfa790 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/PrintPackage.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/PrintPackage.php @@ -7,10 +7,15 @@ namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment; use Magento\Backend\App\Action; +use Magento\Framework\App\Response\Http\FileFactory; use Magento\Framework\App\ResponseInterface; use Magento\Framework\App\Filesystem\DirectoryList; +use Magento\Framework\Stdlib\DateTime\DateTime; +use Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader; +use Magento\Shipping\Model\Order\Pdf\Packaging as PdfPackaging; +use Zend_Pdf; -class PrintPackage extends \Magento\Backend\App\Action +class PrintPackage extends Action { /** * Authorization level of a basic admin session @@ -20,26 +25,20 @@ class PrintPackage extends \Magento\Backend\App\Action const ADMIN_RESOURCE = 'Magento_Sales::shipment'; /** - * @var \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader - */ - protected $shipmentLoader; - - /** - * @var \Magento\Framework\App\Response\Http\FileFactory + * @var FileFactory */ protected $_fileFactory; /** * @param Action\Context $context - * @param \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader - * @param \Magento\Framework\App\Response\Http\FileFactory $fileFactory + * @param ShipmentLoader $shipmentLoader + * @param FileFactory $fileFactory */ public function __construct( Action\Context $context, - \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader, - \Magento\Framework\App\Response\Http\FileFactory $fileFactory + protected readonly ShipmentLoader $shipmentLoader, + FileFactory $fileFactory ) { - $this->shipmentLoader = $shipmentLoader; $this->_fileFactory = $fileFactory; parent::__construct($context); } @@ -58,11 +57,11 @@ public function execute() $shipment = $this->shipmentLoader->load(); if ($shipment) { - /** @var \Zend_Pdf $pdf */ - $pdf = $this->_objectManager->create(\Magento\Shipping\Model\Order\Pdf\Packaging::class)->getPdf($shipment); + /** @var Zend_Pdf $pdf */ + $pdf = $this->_objectManager->create(PdfPackaging::class)->getPdf($shipment); return $this->_fileFactory->create( 'packingslip' . $this->_objectManager->get( - \Magento\Framework\Stdlib\DateTime\DateTime::class + DateTime::class )->date( 'Y-m-d_H-i-s' ) . '.pdf', diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/RemoveTrack.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/RemoveTrack.php index aa969737f98d9..acc6f5795dfaa 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/RemoveTrack.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/RemoveTrack.php @@ -6,9 +6,13 @@ */ namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment; +use Exception; use Magento\Backend\App\Action; +use Magento\Framework\Json\Helper\Data as Json; +use Magento\Sales\Model\Order\Shipment\Track as OrderShipmentTrack; +use Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader; -class RemoveTrack extends \Magento\Backend\App\Action +class RemoveTrack extends Action { /** * Authorization level of a basic admin session @@ -17,20 +21,14 @@ class RemoveTrack extends \Magento\Backend\App\Action */ const ADMIN_RESOURCE = 'Magento_Sales::shipment'; - /** - * @var \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader - */ - protected $shipmentLoader; - /** * @param Action\Context $context - * @param \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader + * @param ShipmentLoader $shipmentLoader */ public function __construct( Action\Context $context, - \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader + protected readonly ShipmentLoader $shipmentLoader ) { - $this->shipmentLoader = $shipmentLoader; parent::__construct($context); } @@ -42,8 +40,8 @@ public function __construct( public function execute() { $trackId = $this->getRequest()->getParam('track_id'); - /** @var \Magento\Sales\Model\Order\Shipment\Track $track */ - $track = $this->_objectManager->create(\Magento\Sales\Model\Order\Shipment\Track::class)->load($trackId); + /** @var OrderShipmentTrack $track */ + $track = $this->_objectManager->create(OrderShipmentTrack::class)->load($trackId); if ($track->getId()) { try { $this->shipmentLoader->setOrderId($this->getRequest()->getParam('order_id')); @@ -63,7 +61,7 @@ public function execute() 'message' => __('We can\'t initialize shipment for delete tracking number.'), ]; } - } catch (\Exception $e) { + } catch (Exception $e) { $response = ['error' => true, 'message' => __('We can\'t delete tracking number.')]; } } else { @@ -73,7 +71,7 @@ public function execute() ]; } if (is_array($response)) { - $response = $this->_objectManager->get(\Magento\Framework\Json\Helper\Data::class)->jsonEncode($response); + $response = $this->_objectManager->get(Json::class)->jsonEncode($response); $this->getResponse()->representJson($response); } else { $this->getResponse()->setBody($response); diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Save.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Save.php index 0c9738540322c..4455672d2d7cd 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Save.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Save.php @@ -6,16 +6,31 @@ namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment; +use Magento\Backend\App\Action; +use Magento\Backend\App\Action\Context as ActionContext; +use Magento\Backend\Model\Session as BackendSession; +use Magento\Backend\Model\View\Result\Redirect as ResultRedirect; use Magento\Framework\App\Action\HttpPostActionInterface; +use Magento\Framework\App\ObjectManager; use Magento\Framework\Controller\ResultFactory; +use Magento\Framework\Controller\ResultInterface; +use Magento\Framework\DataObject; +use Magento\Framework\DB\Transaction; +use Magento\Framework\Exception\LocalizedException; use Magento\Sales\Helper\Data as SalesData; +use Magento\Sales\Model\Order\Email\Sender\ShipmentSender; +use Magento\Sales\Model\Order\Shipment as OrderShipment; +use Magento\Sales\Model\Order\Shipment\ShipmentValidatorInterface; use Magento\Sales\Model\Order\Shipment\Validation\QuantityValidator; +use Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader; +use Magento\Shipping\Model\Shipping\LabelGenerator; +use Psr\Log\LoggerInterface; /** * Controller for generation of new Shipments from Backend * @SuppressWarnings(PHPMD.CouplingBetweenObjects) */ -class Save extends \Magento\Backend\App\Action implements HttpPostActionInterface +class Save extends Action implements HttpPostActionInterface { /** * Authorization level of a basic admin session @@ -25,68 +40,40 @@ class Save extends \Magento\Backend\App\Action implements HttpPostActionInterfac const ADMIN_RESOURCE = 'Magento_Sales::shipment'; /** - * @var \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader - */ - protected $shipmentLoader; - - /** - * @var \Magento\Shipping\Model\Shipping\LabelGenerator - */ - protected $labelGenerator; - - /** - * @var \Magento\Sales\Model\Order\Email\Sender\ShipmentSender - */ - protected $shipmentSender; - - /** - * @var \Magento\Sales\Model\Order\Shipment\ShipmentValidatorInterface - */ - private $shipmentValidator; - - /** - * @var SalesData - */ - private $salesData; - - /** - * @param \Magento\Backend\App\Action\Context $context - * @param \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader - * @param \Magento\Shipping\Model\Shipping\LabelGenerator $labelGenerator - * @param \Magento\Sales\Model\Order\Email\Sender\ShipmentSender $shipmentSender - * @param \Magento\Sales\Model\Order\Shipment\ShipmentValidatorInterface|null $shipmentValidator + * @param ActionContext $context + * @param ShipmentLoader $shipmentLoader + * @param LabelGenerator $labelGenerator + * @param ShipmentSender $shipmentSender + * @param ShipmentValidatorInterface|null $shipmentValidator * @param SalesData $salesData */ public function __construct( - \Magento\Backend\App\Action\Context $context, - \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader, - \Magento\Shipping\Model\Shipping\LabelGenerator $labelGenerator, - \Magento\Sales\Model\Order\Email\Sender\ShipmentSender $shipmentSender, - \Magento\Sales\Model\Order\Shipment\ShipmentValidatorInterface $shipmentValidator = null, - SalesData $salesData = null + ActionContext $context, + protected readonly ShipmentLoader $shipmentLoader, + protected readonly LabelGenerator $labelGenerator, + protected readonly ShipmentSender $shipmentSender, + private ?ShipmentValidatorInterface $shipmentValidator = null, + private ?SalesData $salesData = null ) { parent::__construct($context); - $this->shipmentLoader = $shipmentLoader; - $this->labelGenerator = $labelGenerator; - $this->shipmentSender = $shipmentSender; - $this->shipmentValidator = $shipmentValidator ?: \Magento\Framework\App\ObjectManager::getInstance() - ->get(\Magento\Sales\Model\Order\Shipment\ShipmentValidatorInterface::class); - $this->salesData = $salesData ?: \Magento\Framework\App\ObjectManager::getInstance() + $this->shipmentValidator = $shipmentValidator ?: ObjectManager::getInstance() + ->get(ShipmentValidatorInterface::class); + $this->salesData = $salesData ?: ObjectManager::getInstance() ->get(SalesData::class); } /** * Save shipment and order in one transaction * - * @param \Magento\Sales\Model\Order\Shipment $shipment + * @param OrderShipment $shipment * @return $this */ protected function _saveShipment($shipment) { $shipment->getOrder()->setIsInProcess(true); $transaction = $this->_objectManager->create( - \Magento\Framework\DB\Transaction::class + Transaction::class ); $transaction->addObject( $shipment @@ -102,13 +89,13 @@ protected function _saveShipment($shipment) * * We can save only new shipment. Existing shipments are not editable * - * @return \Magento\Framework\Controller\ResultInterface + * @return ResultInterface * @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.NPathComplexity) */ public function execute() { - /** @var \Magento\Backend\Model\View\Result\Redirect $resultRedirect */ + /** @var ResultRedirect $resultRedirect */ $resultRedirect = $this->resultRedirectFactory->create(); $formKeyIsValid = $this->_formKeyValidator->validate($this->getRequest()); @@ -122,11 +109,11 @@ public function execute() $orderId = $this->getRequest()->getParam('order_id'); if (!empty($data['comment_text'])) { - $this->_objectManager->get(\Magento\Backend\Model\Session::class)->setCommentText($data['comment_text']); + $this->_objectManager->get(BackendSession::class)->setCommentText($data['comment_text']); } $isNeedCreateLabel = isset($data['create_shipping_label']) && $data['create_shipping_label']; - $responseAjax = new \Magento\Framework\DataObject(); + $responseAjax = new DataObject(); try { $this->shipmentLoader->setOrderId($orderId); @@ -177,8 +164,8 @@ public function execute() $this->messageManager->addSuccessMessage( $isNeedCreateLabel ? $shipmentCreatedMessage . ' ' . $labelCreatedMessage : $shipmentCreatedMessage ); - $this->_objectManager->get(\Magento\Backend\Model\Session::class)->getCommentText(true); - } catch (\Magento\Framework\Exception\LocalizedException $e) { + $this->_objectManager->get(BackendSession::class)->getCommentText(true); + } catch (LocalizedException $e) { if ($isNeedCreateLabel) { $responseAjax->setError(true); $responseAjax->setMessage($e->getMessage()); @@ -187,7 +174,7 @@ public function execute() return $resultRedirect->setPath('*/*/new', ['order_id' => $orderId]); } } catch (\Exception $e) { - $this->_objectManager->get(\Psr\Log\LoggerInterface::class)->critical($e); + $this->_objectManager->get(LoggerInterface::class)->critical($e); if ($isNeedCreateLabel) { $responseAjax->setError(true); $responseAjax->setMessage(__('An error occurred while creating shipping label.')); diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Start.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Start.php index 8a874ddc79526..3fcca0db9ad2a 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Start.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Start.php @@ -6,9 +6,10 @@ */ namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment; +use Magento\Backend\App\Action; use Magento\Framework\App\Action\HttpGetActionInterface as HttpGetActionInterface; -class Start extends \Magento\Backend\App\Action implements HttpGetActionInterface +class Start extends Action implements HttpGetActionInterface { /** * Authorization level of a basic admin session diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/View.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/View.php index d903a1a7d5889..021852ff8a50d 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/View.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/View.php @@ -7,9 +7,12 @@ namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment; use Magento\Backend\App\Action; +use Magento\Backend\Model\View\Result\ForwardFactory; use Magento\Framework\App\Action\HttpGetActionInterface as HttpGetActionInterface; +use Magento\Framework\View\Result\PageFactory; +use Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader; -class View extends \Magento\Backend\App\Action implements HttpGetActionInterface +class View extends Action implements HttpGetActionInterface { /** * Authorization level of a basic admin session @@ -18,36 +21,18 @@ class View extends \Magento\Backend\App\Action implements HttpGetActionInterface */ const ADMIN_RESOURCE = 'Magento_Sales::shipment'; - /** - * @var \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader - */ - protected $shipmentLoader; - - /** - * @var \Magento\Framework\View\Result\PageFactory - */ - protected $resultPageFactory; - - /** - * @var \Magento\Backend\Model\View\Result\ForwardFactory - */ - protected $resultForwardFactory; - /** * @param Action\Context $context - * @param \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader - * @param \Magento\Framework\View\Result\PageFactory $resultPageFactory - * @param \Magento\Backend\Model\View\Result\ForwardFactory $resultForwardFactory + * @param ShipmentLoader $shipmentLoader + * @param PageFactory $resultPageFactory + * @param ForwardFactory $resultForwardFactory */ public function __construct( Action\Context $context, - \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader, - \Magento\Framework\View\Result\PageFactory $resultPageFactory, - \Magento\Backend\Model\View\Result\ForwardFactory $resultForwardFactory + protected readonly ShipmentLoader $shipmentLoader, + protected readonly PageFactory $resultPageFactory, + protected readonly ForwardFactory $resultForwardFactory ) { - $this->shipmentLoader = $shipmentLoader; - $this->resultPageFactory = $resultPageFactory; - $this->resultForwardFactory = $resultForwardFactory; parent::__construct($context); } diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Order/ShipmentLoader.php b/app/code/Magento/Shipping/Controller/Adminhtml/Order/ShipmentLoader.php index 5f0a2fb24c96f..9f3b980edbfc2 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Order/ShipmentLoader.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Order/ShipmentLoader.php @@ -5,6 +5,7 @@ */ namespace Magento\Shipping\Controller\Adminhtml\Order; +use Exception; use Magento\Framework\DataObject; use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Message\ManagerInterface; @@ -14,6 +15,7 @@ use Magento\Sales\Api\Data\ShipmentItemCreationInterfaceFactory; use Magento\Sales\Api\ShipmentRepositoryInterface; use Magento\Sales\Api\OrderRepositoryInterface; +use Magento\Sales\Model\Order\Shipment as OrderShipment; use Magento\Sales\Model\Order\ShipmentDocumentFactory; use Magento\Sales\Api\Data\ShipmentItemCreationInterface; @@ -32,41 +34,6 @@ class ShipmentLoader extends DataObject { const SHIPMENT = 'shipment'; - /** - * @var ManagerInterface - */ - private $messageManager; - - /** - * @var Registry - */ - private $registry; - - /** - * @var ShipmentRepositoryInterface - */ - private $shipmentRepository; - - /** - * @var OrderRepositoryInterface - */ - private $orderRepository; - - /** - * @var ShipmentDocumentFactory - */ - private $documentFactory; - - /** - * @var ShipmentTrackCreationInterfaceFactory - */ - private $trackFactory; - - /** - * @var ShipmentItemCreationInterfaceFactory - */ - private $itemFactory; - /** * @param ManagerInterface $messageManager * @param Registry $registry @@ -78,30 +45,23 @@ class ShipmentLoader extends DataObject * @param array $data */ public function __construct( - ManagerInterface $messageManager, - Registry $registry, - ShipmentRepositoryInterface $shipmentRepository, - OrderRepositoryInterface $orderRepository, - ShipmentDocumentFactory $documentFactory, - ShipmentTrackCreationInterfaceFactory $trackFactory, - ShipmentItemCreationInterfaceFactory $itemFactory, + private readonly ManagerInterface $messageManager, + private readonly Registry $registry, + private readonly ShipmentRepositoryInterface $shipmentRepository, + private readonly OrderRepositoryInterface $orderRepository, + private readonly ShipmentDocumentFactory $documentFactory, + private readonly ShipmentTrackCreationInterfaceFactory $trackFactory, + private readonly ShipmentItemCreationInterfaceFactory $itemFactory, array $data = [] ) { - $this->messageManager = $messageManager; - $this->registry = $registry; - $this->shipmentRepository = $shipmentRepository; - $this->orderRepository = $orderRepository; - $this->documentFactory = $documentFactory; - $this->trackFactory = $trackFactory; - $this->itemFactory = $itemFactory; parent::__construct($data); } /** * Initialize shipment model instance * - * @return bool|\Magento\Sales\Model\Order\Shipment - * @throws \Magento\Framework\Exception\LocalizedException + * @return bool|OrderShipment + * @throws LocalizedException */ public function load() { @@ -111,7 +71,7 @@ public function load() if ($shipmentId) { try { $shipment = $this->shipmentRepository->get($shipmentId); - } catch (\Exception $e) { + } catch (Exception $e) { $this->messageManager->addErrorMessage(__('This shipment no longer exists.')); return false; } diff --git a/app/code/Magento/Shipping/Controller/Adminhtml/Shipment/MassPrintShippingLabel.php b/app/code/Magento/Shipping/Controller/Adminhtml/Shipment/MassPrintShippingLabel.php index e57a4ca87ae10..35cd51115ae37 100644 --- a/app/code/Magento/Shipping/Controller/Adminhtml/Shipment/MassPrintShippingLabel.php +++ b/app/code/Magento/Shipping/Controller/Adminhtml/Shipment/MassPrintShippingLabel.php @@ -10,6 +10,8 @@ use Magento\Framework\App\ResponseInterface; use Magento\Framework\App\Filesystem\DirectoryList; use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection; +use Magento\Sales\Controller\Adminhtml\Order\AbstractMassAction; +use Magento\Sales\Model\Order\Shipment as OrderShipment; use Magento\Ui\Component\MassAction\Filter; use Magento\Backend\App\Action\Context; use Magento\Shipping\Model\Shipping\LabelGenerator; @@ -17,7 +19,7 @@ use Magento\Framework\Controller\ResultInterface; use Magento\Sales\Model\ResourceModel\Order\Shipment\CollectionFactory; -class MassPrintShippingLabel extends \Magento\Sales\Controller\Adminhtml\Order\AbstractMassAction +class MassPrintShippingLabel extends AbstractMassAction { /** * Authorization level of a basic admin session @@ -26,16 +28,6 @@ class MassPrintShippingLabel extends \Magento\Sales\Controller\Adminhtml\Order\A */ const ADMIN_RESOURCE = 'Magento_Sales::shipment'; - /** - * @var LabelGenerator - */ - protected $labelGenerator; - - /** - * @var FileFactory - */ - protected $fileFactory; - /** * @param Context $context * @param Filter $filter @@ -46,13 +38,11 @@ class MassPrintShippingLabel extends \Magento\Sales\Controller\Adminhtml\Order\A public function __construct( Context $context, Filter $filter, - FileFactory $fileFactory, - LabelGenerator $labelGenerator, + protected readonly FileFactory $fileFactory, + protected readonly LabelGenerator $labelGenerator, CollectionFactory $collectionFactory ) { $this->collectionFactory = $collectionFactory; - $this->fileFactory = $fileFactory; - $this->labelGenerator = $labelGenerator; parent::__construct($context, $filter); } @@ -68,7 +58,7 @@ protected function massAction(AbstractCollection $collection) $labelsContent = []; if ($collection->getSize()) { - /** @var \Magento\Sales\Model\Order\Shipment $shipment */ + /** @var OrderShipment $shipment */ foreach ($collection as $shipment) { $labelContent = $shipment->getShippingLabel(); if ($labelContent) { diff --git a/app/code/Magento/Shipping/Controller/Tracking/Popup.php b/app/code/Magento/Shipping/Controller/Tracking/Popup.php index e7067fb6c5736..53e932e0e58ef 100644 --- a/app/code/Magento/Shipping/Controller/Tracking/Popup.php +++ b/app/code/Magento/Shipping/Controller/Tracking/Popup.php @@ -6,38 +6,43 @@ */ namespace Magento\Shipping\Controller\Tracking; +use Magento\Framework\App\Action\Action; +use Magento\Framework\App\Action\Context; use Magento\Framework\Exception\NotFoundException; +use Magento\Framework\Registry; +use Magento\Sales\Model\OrderFactory; +use Magento\Shipping\Model\InfoFactory; -class Popup extends \Magento\Framework\App\Action\Action +class Popup extends Action { /** * Core registry * - * @var \Magento\Framework\Registry + * @var Registry */ protected $_coreRegistry; /** - * @var \Magento\Shipping\Model\InfoFactory + * @var InfoFactory */ protected $_shippingInfoFactory; /** - * @var \Magento\Sales\Model\OrderFactory + * @var OrderFactory */ protected $_orderFactory; /** - * @param \Magento\Framework\App\Action\Context $context - * @param \Magento\Framework\Registry $coreRegistry - * @param \Magento\Shipping\Model\InfoFactory $shippingInfoFactory - * @param \Magento\Sales\Model\OrderFactory $orderFactory + * @param Context $context + * @param Registry $coreRegistry + * @param InfoFactory $shippingInfoFactory + * @param OrderFactory $orderFactory */ public function __construct( - \Magento\Framework\App\Action\Context $context, - \Magento\Framework\Registry $coreRegistry, - \Magento\Shipping\Model\InfoFactory $shippingInfoFactory, - \Magento\Sales\Model\OrderFactory $orderFactory + Context $context, + Registry $coreRegistry, + InfoFactory $shippingInfoFactory, + OrderFactory $orderFactory ) { $this->_coreRegistry = $coreRegistry; $this->_shippingInfoFactory = $shippingInfoFactory; diff --git a/app/code/Magento/Shipping/Helper/Carrier.php b/app/code/Magento/Shipping/Helper/Carrier.php index a81d898b55748..9601c9c228c41 100644 --- a/app/code/Magento/Shipping/Helper/Carrier.php +++ b/app/code/Magento/Shipping/Helper/Carrier.php @@ -5,14 +5,19 @@ */ namespace Magento\Shipping\Helper; +use Magento\Framework\App\Helper\AbstractHelper; +use Magento\Framework\App\Helper\Context; +use Magento\Framework\Locale\ResolverInterface; use Magento\Framework\Measure\Exception\MeasureException; use Magento\Framework\Measure\Length; use Magento\Framework\Measure\Weight; +use Magento\Store\Model\ScopeInterface; +use Magento\Store\Model\Store; /** * Carrier helper */ -class Carrier extends \Magento\Framework\App\Helper\AbstractHelper +class Carrier extends AbstractHelper { /** * Carriers root xml path @@ -25,28 +30,20 @@ class Carrier extends \Magento\Framework\App\Helper\AbstractHelper public const XML_PATH_EU_COUNTRIES_LIST = 'general/country/eu_countries'; /** - * Locale interface - * - * @var \Magento\Framework\Locale\ResolverInterface $localeResolver - */ - protected $localeResolver; - - /** - * @param \Magento\Framework\App\Helper\Context $context - * @param \Magento\Framework\Locale\ResolverInterface $localeResolver + * @param Context $context + * @param ResolverInterface $localeResolver Locale interface */ public function __construct( - \Magento\Framework\App\Helper\Context $context, - \Magento\Framework\Locale\ResolverInterface $localeResolver + Context $context, + protected readonly ResolverInterface $localeResolver ) { - $this->localeResolver = $localeResolver; parent::__construct($context); } /** * Get online shipping carrier codes * - * @param int|\Magento\Store\Model\Store|null $store + * @param int|Store|null $store * @return array */ public function getOnlineCarrierCodes($store = null) @@ -54,7 +51,7 @@ public function getOnlineCarrierCodes($store = null) $carriersCodes = []; foreach ($this->scopeConfig->getValue( self::XML_PATH_CARRIERS_ROOT, - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $store ) as $carrierCode => $carrier) { if (isset($carrier['is_online']) && $carrier['is_online']) { @@ -76,7 +73,7 @@ public function getCarrierConfigValue($carrierCode, $configPath, $store = null) { return $this->scopeConfig->getValue( sprintf('%s/%s/%s', self::XML_PATH_CARRIERS_ROOT, $carrierCode, $configPath), - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $store ); } @@ -165,7 +162,7 @@ public function isCountryInEU($countryCode, $storeId = null) ',', $this->scopeConfig->getValue( self::XML_PATH_EU_COUNTRIES_LIST, - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $storeId ) ); diff --git a/app/code/Magento/Shipping/Helper/Data.php b/app/code/Magento/Shipping/Helper/Data.php index 835454389cf7a..150c088863fef 100644 --- a/app/code/Magento/Shipping/Helper/Data.php +++ b/app/code/Magento/Shipping/Helper/Data.php @@ -9,11 +9,17 @@ */ namespace Magento\Shipping\Helper; +use Magento\Framework\App\Helper\AbstractHelper; +use Magento\Framework\App\Helper\Context; use Magento\Framework\App\ObjectManager; use Magento\Framework\UrlInterface; +use Magento\Sales\Model\AbstractModel; +use Magento\Sales\Model\Order; +use Magento\Sales\Model\Order\Shipment; +use Magento\Sales\Model\Order\Shipment\Track; use Magento\Store\Model\StoreManagerInterface; -class Data extends \Magento\Framework\App\Helper\AbstractHelper +class Data extends AbstractHelper { /** * Allowed hash keys @@ -28,19 +34,14 @@ class Data extends \Magento\Framework\App\Helper\AbstractHelper protected $_storeManager; /** - * @var UrlInterface|null - */ - private $url; - - /** - * @param \Magento\Framework\App\Helper\Context $context + * @param Context $context * @param StoreManagerInterface $storeManager * @param UrlInterface|null $url */ public function __construct( - \Magento\Framework\App\Helper\Context $context, + Context $context, StoreManagerInterface $storeManager, - UrlInterface $url = null + private ?UrlInterface $url = null ) { $this->_storeManager = $storeManager; $this->url = $url ?: ObjectManager::getInstance()->get(UrlInterface::class); @@ -51,7 +52,7 @@ public function __construct( /** * Decode url hash * - * @param string $hash + * @param string $hash * @return array */ public function decodeTrackingHash($hash) @@ -66,10 +67,9 @@ public function decodeTrackingHash($hash) /** * Retrieve tracking url with params * - * @param string $key - * @param \Magento\Sales\Model\Order - * |\Magento\Sales\Model\Order\Shipment|\Magento\Sales\Model\Order\Shipment\Track $model - * @param string $method Optional - method of a model to get id + * @param string $key + * @param Order|Shipment|Track $model + * @param string $method Optional - method of a model to get id * @return string */ protected function _getTrackingUrl($key, $model, $method = 'getId') @@ -88,16 +88,16 @@ protected function _getTrackingUrl($key, $model, $method = 'getId') /** * Shipping tracking popup URL getter * - * @param \Magento\Sales\Model\AbstractModel $model + * @param AbstractModel $model * @return string */ public function getTrackingPopupUrlBySalesModel($model) { - if ($model instanceof \Magento\Sales\Model\Order) { + if ($model instanceof Order) { return $this->_getTrackingUrl('order_id', $model); - } elseif ($model instanceof \Magento\Sales\Model\Order\Shipment) { + } elseif ($model instanceof Shipment) { return $this->_getTrackingUrl('ship_id', $model); - } elseif ($model instanceof \Magento\Sales\Model\Order\Shipment\Track) { + } elseif ($model instanceof Track) { return $this->_getTrackingUrl('track_id', $model, 'getEntityId'); } return ''; diff --git a/app/code/Magento/Shipping/Model/Carrier/AbstractCarrier.php b/app/code/Magento/Shipping/Model/Carrier/AbstractCarrier.php index d8a16023702d4..cde66d416b54f 100644 --- a/app/code/Magento/Shipping/Model/Carrier/AbstractCarrier.php +++ b/app/code/Magento/Shipping/Model/Carrier/AbstractCarrier.php @@ -6,8 +6,18 @@ namespace Magento\Shipping\Model\Carrier; +use Exception; +use Magento\Framework\App\Config\ScopeConfigInterface; +use Magento\Framework\DataObject; +use Magento\Framework\Model\AbstractModel; +use Magento\Quote\Model\Quote\Address\RateRequest; use Magento\Quote\Model\Quote\Address\RateResult\Error; +use Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory; +use Magento\Quote\Model\Quote\Address\RateResult\Method; use Magento\Shipping\Model\Shipment\Request; +use Magento\Store\Model\ScopeInterface; +use Psr\Log\LoggerInterface; +use SimpleXMLElement; /** * Class AbstractCarrier @@ -16,7 +26,7 @@ * @api * @since 100.0.2 */ -abstract class AbstractCarrier extends \Magento\Framework\DataObject implements AbstractCarrierInterface +abstract class AbstractCarrier extends DataObject implements AbstractCarrierInterface { public const DEBUG_KEYS_MASK = '****'; @@ -72,30 +82,30 @@ abstract class AbstractCarrier extends \Magento\Framework\DataObject implements /** * Core store config * - * @var \Magento\Framework\App\Config\ScopeConfigInterface + * @var ScopeConfigInterface */ protected $_scopeConfig; /** - * @var \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory + * @var ErrorFactory */ protected $_rateErrorFactory; /** - * @var \Psr\Log\LoggerInterface + * @var LoggerInterface */ protected $_logger; /** - * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig - * @param \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory - * @param \Psr\Log\LoggerInterface $logger + * @param ScopeConfigInterface $scopeConfig + * @param ErrorFactory $rateErrorFactory + * @param LoggerInterface $logger * @param array $data */ public function __construct( - \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, - \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory, - \Psr\Log\LoggerInterface $logger, + ScopeConfigInterface $scopeConfig, + ErrorFactory $rateErrorFactory, + LoggerInterface $logger, array $data = [] ) { parent::__construct($data); @@ -119,7 +129,7 @@ public function getConfigData($field) return $this->_scopeConfig->getValue( $path, - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $this->getStore() ); } @@ -140,7 +150,7 @@ public function getConfigFlag($field) return $this->_scopeConfig->isSetFlag( $path, - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $this->getStore() ); } @@ -151,12 +161,12 @@ public function getConfigFlag($field) * Implementation must be in overridden method * * @param Request $request - * @return \Magento\Framework\DataObject + * @return DataObject * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ public function requestToShipment($request) { - return new \Magento\Framework\DataObject(); + return new DataObject(); } /** @@ -165,22 +175,22 @@ public function requestToShipment($request) * Implementation must be in overridden method * * @param Request $request - * @return \Magento\Framework\DataObject + * @return DataObject * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ public function returnOfShipment($request) { - return new \Magento\Framework\DataObject(); + return new DataObject(); } /** * Return container types of carrier * - * @param \Magento\Framework\DataObject|null $params + * @param DataObject|null $params * @return array * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ - public function getContainerTypes(\Magento\Framework\DataObject $params = null) + public function getContainerTypes(DataObject $params = null) { return []; } @@ -188,12 +198,12 @@ public function getContainerTypes(\Magento\Framework\DataObject $params = null) /** * Get allowed containers of carrier * - * @param \Magento\Framework\DataObject|null $params + * @param DataObject|null $params * @return array|bool * @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.NPathComplexity) */ - protected function _getAllowedContainers(\Magento\Framework\DataObject $params = null) + protected function _getAllowedContainers(DataObject $params = null) { $containersAll = $this->getContainerTypesAll(); if (empty($containersAll)) { @@ -253,11 +263,11 @@ public function getCustomizableContainerTypes() /** * Return delivery confirmation types of carrier * - * @param \Magento\Framework\DataObject|null $params + * @param DataObject|null $params * @return array * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ - public function getDeliveryConfirmationTypes(\Magento\Framework\DataObject $params = null) + public function getDeliveryConfirmationTypes(DataObject $params = null) { return []; } @@ -265,11 +275,11 @@ public function getDeliveryConfirmationTypes(\Magento\Framework\DataObject $para /** * Validate request for available ship countries. * - * @param \Magento\Framework\DataObject $request - * @return $this|bool|false|\Magento\Framework\Model\AbstractModel + * @param DataObject $request + * @return $this|bool|false|AbstractModel * @SuppressWarnings(PHPMD.CyclomaticComplexity) */ - public function checkAvailableShipCountries(\Magento\Framework\DataObject $request) + public function checkAvailableShipCountries(DataObject $request) { $speCountriesAllow = $this->getConfigData('sallowspecific'); /* @@ -315,12 +325,12 @@ public function checkAvailableShipCountries(\Magento\Framework\DataObject $reque /** * Processing additional validation to check is carrier applicable. * - * @param \Magento\Framework\DataObject $request - * @return $this|bool|\Magento\Framework\DataObject + * @param DataObject $request + * @return $this|bool|DataObject * @SuppressWarnings(PHPMD.UnusedFormalParameter) * @since 100.2.6 */ - public function processAdditionalValidation(\Magento\Framework\DataObject $request) + public function processAdditionalValidation(DataObject $request) { return $this; } @@ -328,12 +338,12 @@ public function processAdditionalValidation(\Magento\Framework\DataObject $reque /** * Processing additional validation to check is carrier applicable. * - * @param \Magento\Framework\DataObject $request - * @return $this|bool|\Magento\Framework\DataObject + * @param DataObject $request + * @return $this|bool|DataObject * @deprecated 100.2.6 * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ - public function proccessAdditionalValidation(\Magento\Framework\DataObject $request) + public function proccessAdditionalValidation(DataObject $request) { return $this->processAdditionalValidation($request); } @@ -393,7 +403,7 @@ public function getSortOrder() /** * Check if the request has free shipping weight * - * @param \Magento\Quote\Model\Quote\Address\RateRequest $request + * @param RateRequest $request * @return bool */ private function hasFreeMethodWeight($request): bool @@ -410,7 +420,7 @@ private function hasFreeMethodWeight($request): bool /** * Allows free shipping when all product items have free shipping. * - * @param \Magento\Quote\Model\Quote\Address\RateRequest $request + * @param RateRequest $request * @return void * @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.NPathComplexity) @@ -447,12 +457,12 @@ protected function _updateFreeMethodQuote($request) // phpstan:ignore $result = $this->_getQuotes(); if ($result && ($rates = $result->getAllRates()) && count($rates) > 0) { - if (count($rates) == 1 && $rates[0] instanceof \Magento\Quote\Model\Quote\Address\RateResult\Method) { + if (count($rates) == 1 && $rates[0] instanceof Method) { $price = $rates[0]->getPrice(); } if (count($rates) > 1) { foreach ($rates as $rate) { - if ($rate instanceof \Magento\Quote\Model\Quote\Address\RateResult\Method && + if ($rate instanceof Method && $rate->getMethod() == $freeMethod ) { $price = $rate->getPrice(); @@ -640,11 +650,11 @@ public function getCarrierCode() /** * Return content types of package * - * @param \Magento\Framework\DataObject $params + * @param DataObject $params * @return array * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ - public function getContentTypes(\Magento\Framework\DataObject $params) + public function getContentTypes(DataObject $params) { return []; } @@ -670,10 +680,10 @@ public function getContentTypes(\Magento\Framework\DataObject $params) protected function filterDebugData($data) { try { - $xml = new \SimpleXMLElement($data); + $xml = new SimpleXMLElement($data); $this->filterXmlData($xml); $data = $xml->asXML(); - } catch (\Exception $e) { + } catch (Exception $e) { $this->_logger->critical($e); } return $data; @@ -682,12 +692,12 @@ protected function filterDebugData($data) /** * Recursive replace sensitive xml nodes values by specified mask. * - * @param \SimpleXMLElement $xml + * @param SimpleXMLElement $xml * @return void */ - private function filterXmlData(\SimpleXMLElement $xml) + private function filterXmlData(SimpleXMLElement $xml) { - /** @var \SimpleXMLElement $child */ + /** @var SimpleXMLElement $child */ foreach ($xml->children() as $child) { if ($child->count()) { $this->filterXmlData($child); diff --git a/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierInterface.php b/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierInterface.php index a410a2ee18114..65aa981549e2e 100644 --- a/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierInterface.php +++ b/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierInterface.php @@ -5,6 +5,8 @@ */ namespace Magento\Shipping\Model\Carrier; +use Magento\Framework\DataObject; +use Magento\Framework\Model\AbstractModel; use Magento\Quote\Model\Quote\Address\RateRequest; /** @@ -26,33 +28,33 @@ public function getConfigData($field); * Collect and get rates * * @param RateRequest $request - * @return \Magento\Framework\DataObject|bool|null + * @return DataObject|bool|null */ public function collectRates(RateRequest $request); /** * Do request to shipment - Implementation must be in overridden method * - * @param \Magento\Framework\DataObject $request - * @return \Magento\Framework\DataObject + * @param DataObject $request + * @return DataObject */ public function requestToShipment($request); /** * Do return of shipment - Implementation must be in overridden method * - * @param \Magento\Framework\DataObject $request - * @return \Magento\Framework\DataObject + * @param DataObject $request + * @return DataObject */ public function returnOfShipment($request); /** * Return container types of carrier * - * @param \Magento\Framework\DataObject|null $params + * @param DataObject|null $params * @return array */ - public function getContainerTypes(\Magento\Framework\DataObject $params = null); + public function getContainerTypes(DataObject $params = null); /** * Get Container Types, that could be customized @@ -64,26 +66,26 @@ public function getCustomizableContainerTypes(); /** * Return delivery confirmation types of carrier * - * @param \Magento\Framework\DataObject|null $params + * @param DataObject|null $params * @return array */ - public function getDeliveryConfirmationTypes(\Magento\Framework\DataObject $params = null); + public function getDeliveryConfirmationTypes(DataObject $params = null); /** * Validate request for available ship countries * - * @param \Magento\Framework\DataObject $request - * @return $this|bool|false|\Magento\Framework\Model\AbstractModel + * @param DataObject $request + * @return $this|bool|false|AbstractModel */ - public function checkAvailableShipCountries(\Magento\Framework\DataObject $request); + public function checkAvailableShipCountries(DataObject $request); /** * Processing additional validation to check is carrier applicable. * - * @param \Magento\Framework\DataObject $request - * @return $this|\Magento\Framework\DataObject|boolean + * @param DataObject $request + * @return $this|DataObject|boolean */ - public function proccessAdditionalValidation(\Magento\Framework\DataObject $request); + public function proccessAdditionalValidation(DataObject $request); /** * Determine whether current carrier enabled for activity @@ -176,8 +178,8 @@ public function getCarrierCode(); /** * Return content types of package * - * @param \Magento\Framework\DataObject $params + * @param DataObject $params * @return array */ - public function getContentTypes(\Magento\Framework\DataObject $params); + public function getContentTypes(DataObject $params); } diff --git a/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierOnline.php b/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierOnline.php index 5e13688466618..e6c5ea691eb68 100644 --- a/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierOnline.php +++ b/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierOnline.php @@ -6,11 +6,29 @@ namespace Magento\Shipping\Model\Carrier; +use Magento\CatalogInventory\Api\StockRegistryInterface; +use Magento\Directory\Helper\Data as DirectoryHelper; +use Magento\Directory\Model\CountryFactory; +use Magento\Directory\Model\CurrencyFactory; +use Magento\Directory\Model\RegionFactory; +use Magento\Framework\App\Config\ScopeConfigInterface; +use Magento\Framework\DataObject; use Magento\Framework\Exception\LocalizedException; use Magento\Quote\Model\Quote\Address\RateRequest; use Magento\Quote\Model\Quote\Address\RateResult\Error; +use Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory as RateResultErrorFactory; +use Magento\Quote\Model\Quote\Address\RateResult\MethodFactory; +use Magento\Quote\Model\Quote\Item as QuoteItem; +use Magento\Shipping\Model\Rate\ResultFactory as RateResultFactory; use Magento\Shipping\Model\Shipment\Request; use Magento\Framework\Xml\Security; +use Magento\Shipping\Model\Simplexml\ElementFactory; +use Magento\Shipping\Model\Tracking\Result as TrackingResult; +use Magento\Shipping\Model\Tracking\Result\ErrorFactory; +use Magento\Shipping\Model\Tracking\Result\StatusFactory; +use Magento\Shipping\Model\Tracking\ResultFactory; +use Psr\Log\LoggerInterface; +use SimpleXMLElement; /** * Abstract online shipping carrier model @@ -41,108 +59,98 @@ abstract class AbstractCarrierOnline extends AbstractCarrier protected $_activeFlag = 'active'; /** - * @var \Magento\Directory\Helper\Data + * @var DirectoryHelper */ protected $_directoryData = null; /** - * @var \Magento\Shipping\Model\Simplexml\ElementFactory + * @var ElementFactory */ protected $_xmlElFactory; /** - * @var \Magento\Shipping\Model\Rate\ResultFactory + * @var RateResultFactory */ protected $_rateFactory; /** - * @var \Magento\Quote\Model\Quote\Address\RateResult\MethodFactory + * @var MethodFactory */ protected $_rateMethodFactory; /** - * @var \Magento\Shipping\Model\Tracking\ResultFactory + * @var ResultFactory */ protected $_trackFactory; /** - * @var \Magento\Shipping\Model\Tracking\Result\ErrorFactory + * @var ErrorFactory */ protected $_trackErrorFactory; /** - * @var \Magento\Shipping\Model\Tracking\Result\StatusFactory + * @var StatusFactory */ protected $_trackStatusFactory; /** - * @var \Magento\Directory\Model\RegionFactory + * @var RegionFactory */ protected $_regionFactory; /** - * @var \Magento\Directory\Model\CountryFactory + * @var CountryFactory */ protected $_countryFactory; /** - * @var \Magento\Directory\Model\CurrencyFactory + * @var CurrencyFactory */ protected $_currencyFactory; - /** - * @var \Magento\CatalogInventory\Api\StockRegistryInterface - */ - protected $stockRegistry; - /** * Raw rate request data * - * @var \Magento\Framework\DataObject|null + * @var DataObject|null */ protected $_rawRequest = null; /** - * @var Security - */ - protected $xmlSecurity; - - /** - * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig - * @param \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory - * @param \Psr\Log\LoggerInterface $logger + * @param ScopeConfigInterface $scopeConfig + * @param RateResultErrorFactory $rateErrorFactory + * @param LoggerInterface $logger * @param Security $xmlSecurity - * @param \Magento\Shipping\Model\Simplexml\ElementFactory $xmlElFactory - * @param \Magento\Shipping\Model\Rate\ResultFactory $rateFactory - * @param \Magento\Quote\Model\Quote\Address\RateResult\MethodFactory $rateMethodFactory - * @param \Magento\Shipping\Model\Tracking\ResultFactory $trackFactory - * @param \Magento\Shipping\Model\Tracking\Result\ErrorFactory $trackErrorFactory - * @param \Magento\Shipping\Model\Tracking\Result\StatusFactory $trackStatusFactory - * @param \Magento\Directory\Model\RegionFactory $regionFactory - * @param \Magento\Directory\Model\CountryFactory $countryFactory - * @param \Magento\Directory\Model\CurrencyFactory $currencyFactory - * @param \Magento\Directory\Helper\Data $directoryData - * @param \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry + * @param ElementFactory $xmlElFactory + * @param RateResultFactory $rateFactory + * @param MethodFactory $rateMethodFactory + * @param ResultFactory $trackFactory + * @param ErrorFactory $trackErrorFactory + * @param StatusFactory $trackStatusFactory + * @param RegionFactory $regionFactory + * @param CountryFactory $countryFactory + * @param CurrencyFactory $currencyFactory + * @param DirectoryHelper $directoryData + * @param StockRegistryInterface $stockRegistry * @param array $data * * @SuppressWarnings(PHPMD.ExcessiveParameterList) */ public function __construct( - \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, - \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory, - \Psr\Log\LoggerInterface $logger, - Security $xmlSecurity, - \Magento\Shipping\Model\Simplexml\ElementFactory $xmlElFactory, - \Magento\Shipping\Model\Rate\ResultFactory $rateFactory, - \Magento\Quote\Model\Quote\Address\RateResult\MethodFactory $rateMethodFactory, - \Magento\Shipping\Model\Tracking\ResultFactory $trackFactory, - \Magento\Shipping\Model\Tracking\Result\ErrorFactory $trackErrorFactory, - \Magento\Shipping\Model\Tracking\Result\StatusFactory $trackStatusFactory, - \Magento\Directory\Model\RegionFactory $regionFactory, - \Magento\Directory\Model\CountryFactory $countryFactory, - \Magento\Directory\Model\CurrencyFactory $currencyFactory, - \Magento\Directory\Helper\Data $directoryData, - \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry, + ScopeConfigInterface $scopeConfig, + RateResultErrorFactory $rateErrorFactory, + LoggerInterface $logger, + protected readonly Security $xmlSecurity, + ElementFactory $xmlElFactory, + RateResultFactory $rateFactory, + MethodFactory $rateMethodFactory, + ResultFactory $trackFactory, + ErrorFactory $trackErrorFactory, + StatusFactory $trackStatusFactory, + RegionFactory $regionFactory, + CountryFactory $countryFactory, + CurrencyFactory $currencyFactory, + DirectoryHelper $directoryData, + protected readonly StockRegistryInterface $stockRegistry, array $data = [] ) { $this->_xmlElFactory = $xmlElFactory; @@ -155,9 +163,7 @@ public function __construct( $this->_countryFactory = $countryFactory; $this->_currencyFactory = $currencyFactory; $this->_directoryData = $directoryData; - $this->stockRegistry = $stockRegistry; parent::__construct($scopeConfig, $rateErrorFactory, $logger, $data); - $this->xmlSecurity = $xmlSecurity; } /** @@ -193,7 +199,7 @@ public function getTrackingInfo($tracking) { $result = $this->getTracking($tracking); - if ($result instanceof \Magento\Shipping\Model\Tracking\Result) { + if ($result instanceof TrackingResult) { $trackings = $result->getAllTrackings(); if ($trackings) { return $trackings[0]; @@ -266,7 +272,7 @@ public function getAllItems(RateRequest $request) $items = []; if ($request->getAllItems()) { foreach ($request->getAllItems() as $item) { - /* @var $item \Magento\Quote\Model\Quote\Item */ + /* @var QuoteItem $item */ if ($item->getProduct()->isVirtual() || $item->getParentItem()) { // Don't process children here - we will process (or already have processed) them below continue; @@ -291,13 +297,13 @@ public function getAllItems(RateRequest $request) /** * Processing additional validation to check if carrier applicable. * - * @param \Magento\Framework\DataObject $request - * @return $this|bool|\Magento\Framework\DataObject + * @param DataObject $request + * @return $this|bool|DataObject * @deprecated 100.2.6 * @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.NPathComplexity) */ - public function proccessAdditionalValidation(\Magento\Framework\DataObject $request) + public function proccessAdditionalValidation(DataObject $request) { return $this->processAdditionalValidation($request); } @@ -305,13 +311,13 @@ public function proccessAdditionalValidation(\Magento\Framework\DataObject $requ /** * Processing additional validation to check if carrier applicable. * - * @param \Magento\Framework\DataObject $request - * @return $this|bool|\Magento\Framework\DataObject + * @param DataObject $request + * @return $this|bool|DataObject * @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.NPathComplexity) * @since 100.2.6 */ - public function processAdditionalValidation(\Magento\Framework\DataObject $request) + public function processAdditionalValidation(DataObject $request) { //Skip by item validation if there is no items in request if (!count($this->getAllItems($request))) { @@ -324,7 +330,7 @@ public function processAdditionalValidation(\Magento\Framework\DataObject $reque $defaultErrorMsg = __('The shipping module is not available.'); $showMethod = $this->getConfigData('showmethod'); - /** @var $item \Magento\Quote\Model\Quote\Item */ + /** @var QuoteItem $item */ foreach ($this->getAllItems($request) as $item) { $product = $item->getProduct(); if ($product && $product->getId()) { @@ -438,10 +444,10 @@ protected function _prepareServiceName($name) /** * Prepare shipment request. Validate and correct request information * - * @param \Magento\Framework\DataObject $request + * @param DataObject $request * @return void */ - protected function _prepareShipmentRequest(\Magento\Framework\DataObject $request) + protected function _prepareShipmentRequest(DataObject $request) { $phonePattern = '/[\s\_\-\(\)]+/'; $phoneNumber = $request->getShipperContactPhoneNumber(); @@ -456,8 +462,8 @@ protected function _prepareShipmentRequest(\Magento\Framework\DataObject $reques * Do request to shipment * * @param Request $request - * @return \Magento\Framework\DataObject - * @throws \Magento\Framework\Exception\LocalizedException + * @return DataObject + * @throws LocalizedException */ public function requestToShipment($request) { @@ -473,7 +479,7 @@ public function requestToShipment($request) $request->setPackageId($packageId); $request->setPackagingType($package['params']['container']); $request->setPackageWeight($package['params']['weight']); - $request->setPackageParams(new \Magento\Framework\DataObject($package['params'])); + $request->setPackageParams(new DataObject($package['params'])); $request->setPackageItems($package['items']); $result = $this->_doShipmentRequest($request); @@ -492,7 +498,7 @@ public function requestToShipment($request) } } - $response = new \Magento\Framework\DataObject(['info' => $data]); + $response = new DataObject(['info' => $data]); if ($result->getErrors()) { $response->setErrors($result->getErrors()); } @@ -504,8 +510,8 @@ public function requestToShipment($request) * Do request to RMA shipment * * @param Request $request - * @return \Magento\Framework\DataObject - * @throws \Magento\Framework\Exception\LocalizedException + * @return DataObject + * @throws LocalizedException */ public function returnOfShipment($request) { @@ -522,7 +528,7 @@ public function returnOfShipment($request) $request->setPackageId($packageId); $request->setPackagingType($package['params']['container']); $request->setPackageWeight($package['params']['weight']); - $request->setPackageParams(new \Magento\Framework\DataObject($package['params'])); + $request->setPackageParams(new DataObject($package['params'])); $request->setPackageItems($package['items']); $result = $this->_doShipmentRequest($request); @@ -541,7 +547,7 @@ public function returnOfShipment($request) } } - $response = new \Magento\Framework\DataObject(['info' => $data]); + $response = new DataObject(['info' => $data]); if ($result->getErrors()) { $response->setErrors($result->getErrors()); } @@ -566,10 +572,10 @@ public function rollBack($data) /** * Do shipment request to carrier web service, obtain Print Shipping Labels and process errors in response * - * @param \Magento\Framework\DataObject $request - * @return \Magento\Framework\DataObject + * @param DataObject $request + * @return DataObject */ - abstract protected function _doShipmentRequest(\Magento\Framework\DataObject $request); + abstract protected function _doShipmentRequest(DataObject $request); /** * Check is Country U.S. Possessions and Trust Territories @@ -616,7 +622,7 @@ public function isGirthAllowed($countyDest = null, $carrierMethodCode = null) /** * Set Raw Request * - * @param \Magento\Framework\DataObject|null $request + * @param DataObject|null $request * @return $this */ public function setRawRequest($request) @@ -651,7 +657,7 @@ public function getMethodPrice($cost, $method = '') * * @param string $xmlContent * @param string $customSimplexml - * @return \SimpleXMLElement|bool + * @return SimpleXMLElement|bool * @throws LocalizedException */ public function parseXml($xmlContent, $customSimplexml = 'SimpleXMLElement') @@ -685,7 +691,7 @@ public function canCollectRates() protected function debugErrors($errors) { if ($this->getConfigData('showmethod')) { - /* @var $error Error */ + /* @var Error $error */ $this->_debug($errors); } } @@ -698,7 +704,7 @@ protected function debugErrors($errors) protected function getErrorMessage() { if ($this->getConfigData('showmethod')) { - /* @var $error Error */ + /* @var Error $error */ $error = $this->_rateErrorFactory->create(); $error->setCarrier($this->getCarrierCode()); $error->setCarrierTitle($this->getConfigData('title')); diff --git a/app/code/Magento/Shipping/Model/CarrierFactory.php b/app/code/Magento/Shipping/Model/CarrierFactory.php index d6aa42465eef2..9aceebbf65375 100644 --- a/app/code/Magento/Shipping/Model/CarrierFactory.php +++ b/app/code/Magento/Shipping/Model/CarrierFactory.php @@ -5,6 +5,10 @@ */ namespace Magento\Shipping\Model; +use Magento\Framework\App\Config\ScopeConfigInterface; +use Magento\Framework\ObjectManagerInterface; +use Magento\Store\Model\ScopeInterface; + /** * Class CarrierFactory */ @@ -13,22 +17,22 @@ class CarrierFactory implements CarrierFactoryInterface /** * Core store config * - * @var \Magento\Framework\App\Config\ScopeConfigInterface + * @var ScopeConfigInterface */ protected $_scopeConfig; /** - * @var \Magento\Framework\ObjectManagerInterface + * @var ObjectManagerInterface */ protected $_objectManager; /** - * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig - * @param \Magento\Framework\ObjectManagerInterface $objectManager + * @param ScopeConfigInterface $scopeConfig + * @param ObjectManagerInterface $objectManager */ public function __construct( - \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, - \Magento\Framework\ObjectManagerInterface $objectManager + ScopeConfigInterface $scopeConfig, + ObjectManagerInterface $objectManager ) { $this->_scopeConfig = $scopeConfig; $this->_objectManager = $objectManager; @@ -44,7 +48,7 @@ public function get($carrierCode) { $className = $this->_scopeConfig->getValue( 'carriers/' . $carrierCode . '/model', - \Magento\Store\Model\ScopeInterface::SCOPE_STORE + ScopeInterface::SCOPE_STORE ); if (!$className) { return false; @@ -65,7 +69,7 @@ public function create($carrierCode, $storeId = null) { $className = $this->_scopeConfig->getValue( 'carriers/' . $carrierCode . '/model', - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $storeId ); if (!$className) { @@ -89,7 +93,7 @@ public function getIfActive($carrierCode) { return $this->_scopeConfig->isSetFlag( 'carriers/' . $carrierCode . '/active', - \Magento\Store\Model\ScopeInterface::SCOPE_STORE + ScopeInterface::SCOPE_STORE ) ? $this->get( $carrierCode ) : false; @@ -106,7 +110,7 @@ public function createIfActive($carrierCode, $storeId = null) { return $this->_scopeConfig->isSetFlag( 'carriers/' . $carrierCode . '/active', - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $storeId ) ? $this->create( $carrierCode, diff --git a/app/code/Magento/Shipping/Model/Config/Source/Allmethods.php b/app/code/Magento/Shipping/Model/Config/Source/Allmethods.php index f64c24856eba5..d6dbdab7ee951 100644 --- a/app/code/Magento/Shipping/Model/Config/Source/Allmethods.php +++ b/app/code/Magento/Shipping/Model/Config/Source/Allmethods.php @@ -5,30 +5,34 @@ */ namespace Magento\Shipping\Model\Config\Source; +use Magento\Framework\App\Config\ScopeConfigInterface; +use Magento\Framework\Option\ArrayInterface; +use Magento\Shipping\Model\Config as ShippingConfig; + /** * @inheritdoc */ -class Allmethods implements \Magento\Framework\Option\ArrayInterface +class Allmethods implements ArrayInterface { /** * Core store config * - * @var \Magento\Framework\App\Config\ScopeConfigInterface + * @var ScopeConfigInterface */ protected $_scopeConfig; /** - * @var \Magento\Shipping\Model\Config + * @var ShippingConfig */ protected $_shippingConfig; /** - * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig - * @param \Magento\Shipping\Model\Config $shippingConfig + * @param ScopeConfigInterface $scopeConfig + * @param ShippingConfig $shippingConfig */ public function __construct( - \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, - \Magento\Shipping\Model\Config $shippingConfig + ScopeConfigInterface $scopeConfig, + ShippingConfig $shippingConfig ) { $this->_scopeConfig = $scopeConfig; $this->_shippingConfig = $shippingConfig; diff --git a/app/code/Magento/Shipping/Model/Config/Source/Allspecificcountries.php b/app/code/Magento/Shipping/Model/Config/Source/Allspecificcountries.php index ebd84c51e0ee5..f844fa250c7eb 100644 --- a/app/code/Magento/Shipping/Model/Config/Source/Allspecificcountries.php +++ b/app/code/Magento/Shipping/Model/Config/Source/Allspecificcountries.php @@ -5,7 +5,9 @@ */ namespace Magento\Shipping\Model\Config\Source; -class Allspecificcountries implements \Magento\Framework\Option\ArrayInterface +use Magento\Framework\Option\ArrayInterface; + +class Allspecificcountries implements ArrayInterface { /** * {@inheritdoc} diff --git a/app/code/Magento/Shipping/Model/Info.php b/app/code/Magento/Shipping/Model/Info.php index ed4c1c3f6d127..be7bccc753273 100644 --- a/app/code/Magento/Shipping/Model/Info.php +++ b/app/code/Magento/Shipping/Model/Info.php @@ -6,9 +6,19 @@ namespace Magento\Shipping\Model; +use Magento\Framework\DataObject; +use Magento\Sales\Api\ShipmentRepositoryInterface; +use Magento\Sales\Model\Order; use Magento\Sales\Model\Order\Shipment; - -class Info extends \Magento\Framework\DataObject +use Magento\Sales\Model\OrderFactory; +use Magento\Shipping\Helper\Data as ShippingHelper; +use Magento\Shipping\Model\Order\Track as OrderTrack; +use Magento\Shipping\Model\Order\TrackFactory as OrderTrackFactory; +use Magento\Shipping\Model\ResourceModel\Order\Track\Collection as OrderTrackCollection; +use Magento\Shipping\Model\ResourceModel\Order\Track\CollectionFactory as OrderTrackCollectionFactory; +use Magento\Sales\Model\ResourceModel\Order\Shipment\Track\CollectionFactory as OrderShipmentTrackCollectionFactory; + +class Info extends DataObject { /** * Tracking info @@ -20,49 +30,43 @@ class Info extends \Magento\Framework\DataObject /** * Shipping data * - * @var \Magento\Shipping\Helper\Data + * @var ShippingHelper */ protected $_shippingData; /** - * @var \Magento\Sales\Model\OrderFactory + * @var OrderFactory */ protected $_orderFactory; /** - * @var \Magento\Sales\Api\ShipmentRepositoryInterface - */ - protected $shipmentRepository; - - /** - * @var \Magento\Shipping\Model\Order\TrackFactory + * @var OrderTrackFactory */ protected $_trackFactory; /** - * @var \Magento\Sales\Model\ResourceModel\Order\Shipment\Track\CollectionFactory + * @var OrderShipmentTrackCollectionFactory */ protected $_trackCollectionFactory; /** - * @param \Magento\Shipping\Helper\Data $shippingData - * @param \Magento\Sales\Model\OrderFactory $orderFactory - * @param \Magento\Sales\Api\ShipmentRepositoryInterface $shipmentRepository - * @param \Magento\Shipping\Model\Order\TrackFactory $trackFactory - * @param \Magento\Shipping\Model\ResourceModel\Order\Track\CollectionFactory $trackCollectionFactory + * @param ShippingHelper $shippingData + * @param OrderFactory $orderFactory + * @param ShipmentRepositoryInterface $shipmentRepository + * @param OrderTrackFactory $trackFactory + * @param OrderTrackCollectionFactory $trackCollectionFactory * @param array $data */ public function __construct( - \Magento\Shipping\Helper\Data $shippingData, - \Magento\Sales\Model\OrderFactory $orderFactory, - \Magento\Sales\Api\ShipmentRepositoryInterface $shipmentRepository, - \Magento\Shipping\Model\Order\TrackFactory $trackFactory, - \Magento\Shipping\Model\ResourceModel\Order\Track\CollectionFactory $trackCollectionFactory, + ShippingHelper $shippingData, + OrderFactory $orderFactory, + protected readonly ShipmentRepositoryInterface $shipmentRepository, + OrderTrackFactory $trackFactory, + OrderTrackCollectionFactory $trackCollectionFactory, array $data = [] ) { $this->_shippingData = $shippingData; $this->_orderFactory = $orderFactory; - $this->shipmentRepository = $shipmentRepository; $this->_trackFactory = $trackFactory; $this->_trackCollectionFactory = $trackCollectionFactory; parent::__construct($data); @@ -76,7 +80,7 @@ public function __construct( */ public function loadByHash($hash) { - /* @var $helper \Magento\Shipping\Helper\Data */ + /* @var ShippingHelper $helper */ $helper = $this->_shippingData; $data = $helper->decodeTrackingHash($hash); if (!empty($data)) { @@ -107,11 +111,11 @@ public function getTrackingInfo() /** * Instantiate order model * - * @return \Magento\Sales\Model\Order|bool + * @return Order|bool */ protected function _initOrder() { - /** @var \Magento\Sales\Model\Order $order */ + /** @var Order $order */ $order = $this->_orderFactory->create()->load($this->getOrderId()); if (!$order->getId() || $this->getProtectCode() !== $order->getProtectCode()) { @@ -128,7 +132,7 @@ protected function _initOrder() */ protected function _initShipment() { - /* @var $model Shipment */ + /* @var Shipment $model */ $ship = $this->shipmentRepository->get($this->getShipId()); if (!$ship->getEntityId() || $this->getProtectCode() !== $ship->getProtectCode()) { return false; @@ -193,7 +197,7 @@ public function getTrackingInfoByShip() */ public function getTrackingInfoByTrackId() { - /** @var \Magento\Shipping\Model\Order\Track $track */ + /** @var OrderTrack $track */ $track = $this->_trackFactory->create()->load($this->getTrackId()); if ($track->getId() && $this->getProtectCode() === $track->getProtectCode()) { $this->_trackingInfo = [[$track->getNumberDetail()]]; @@ -203,7 +207,7 @@ public function getTrackingInfoByTrackId() /** * @param Shipment $shipment - * @return \Magento\Shipping\Model\ResourceModel\Order\Track\Collection + * @return OrderTrackCollection */ protected function _getTracksCollection(Shipment $shipment) { diff --git a/app/code/Magento/Shipping/Model/Observer.php b/app/code/Magento/Shipping/Model/Observer.php index 1f3c85cbd22af..b5bd786b007b4 100644 --- a/app/code/Magento/Shipping/Model/Observer.php +++ b/app/code/Magento/Shipping/Model/Observer.php @@ -5,25 +5,29 @@ */ namespace Magento\Shipping\Model; +use DateTime; +use Magento\Framework\Locale\ResolverInterface; +use Magento\Sales\Model\ResourceModel\Report\ShippingFactory; + class Observer { /** - * @var \Magento\Framework\Locale\ResolverInterface + * @var ResolverInterface */ protected $_localeResolver; /** - * @var \Magento\Sales\Model\ResourceModel\Report\ShippingFactory + * @var ShippingFactory */ protected $_shippingFactory; /** - * @param \Magento\Framework\Locale\ResolverInterface $localeResolver - * @param \Magento\Sales\Model\ResourceModel\Report\ShippingFactory $shippingFactory + * @param ResolverInterface $localeResolver + * @param ShippingFactory $shippingFactory */ public function __construct( - \Magento\Framework\Locale\ResolverInterface $localeResolver, - \Magento\Sales\Model\ResourceModel\Report\ShippingFactory $shippingFactory + ResolverInterface $localeResolver, + ShippingFactory $shippingFactory ) { $this->_localeResolver = $localeResolver; $this->_shippingFactory = $shippingFactory; @@ -37,7 +41,7 @@ public function __construct( public function aggregateSalesReportShipmentData() { $this->_localeResolver->emulate(0); - $currentDate = new \DateTime(); + $currentDate = new DateTime(); $date = $currentDate->modify('-25 hours'); $this->_shippingFactory->create()->aggregate($date); $this->_localeResolver->revert(); diff --git a/app/code/Magento/Shipping/Model/Order/Pdf/Packaging.php b/app/code/Magento/Shipping/Model/Order/Pdf/Packaging.php index e5e206f40275c..3fd541b894657 100644 --- a/app/code/Magento/Shipping/Model/Order/Pdf/Packaging.php +++ b/app/code/Magento/Shipping/Model/Order/Pdf/Packaging.php @@ -5,69 +5,91 @@ */ namespace Magento\Shipping\Model\Order\Pdf; +use Magento\Framework\App\Config\ScopeConfigInterface; +use Magento\Framework\DataObject; +use Magento\Framework\Filesystem; +use Magento\Framework\Locale\ResolverInterface; +use Magento\Framework\Stdlib\DateTime\TimezoneInterface; +use Magento\Framework\Stdlib\StringUtils; +use Magento\Framework\Translate\Inline\StateInterface; +use Magento\Framework\View\LayoutInterface; +use Magento\Payment\Helper\Data as PaymentHelper; +use Magento\Sales\Model\Order\Address\Renderer as OrderAddressRenderer; +use Magento\Sales\Model\Order\Pdf\AbstractPdf; +use Magento\Sales\Model\Order\Pdf\Config as PdfConfig; +use Magento\Sales\Model\Order\Pdf\ItemsFactory as PdfItemsFactory; +use Magento\Sales\Model\Order\Pdf\Total\Factory as PdfTotalFactory; +use Magento\Shipping\Block\Adminhtml\Order\Packaging as OrderPackaging; use Magento\Shipping\Helper\Carrier; +use Magento\Shipping\Helper\Carrier as ShippingCarrierHelper; +use Magento\Shipping\Model\Order\Pdf\Packaging as PdfPackaging; +use Magento\Store\Model\StoreManagerInterface; +use Zend_Pdf; +use Zend_Pdf_Color_GrayScale; +use Zend_Pdf_Color_Rgb; +use Zend_Pdf_Page; /** * @SuppressWarnings(PHPMD.CouplingBetweenObjects) */ -class Packaging extends \Magento\Sales\Model\Order\Pdf\AbstractPdf +class Packaging extends AbstractPdf { /** * Carrier helper * - * @var \Magento\Shipping\Helper\Carrier + * @var ShippingCarrierHelper */ protected $_carrierHelper; /** - * @var \Magento\Store\Model\StoreManagerInterface + * @var StoreManagerInterface */ protected $_storeManager; /** - * @var \Magento\Framework\View\LayoutInterface + * @var LayoutInterface */ protected $_layout; /** - * @var \Magento\Framework\Locale\ResolverInterface + * @var ResolverInterface */ protected $_localeResolver; /** - * @param \Magento\Payment\Helper\Data $paymentData - * @param \Magento\Framework\Stdlib\StringUtils $string - * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig - * @param \Magento\Framework\Filesystem $filesystem - * @param \Magento\Sales\Model\Order\Pdf\Config $pdfConfig - * @param \Magento\Sales\Model\Order\Pdf\Total\Factory $pdfTotalFactory - * @param \Magento\Sales\Model\Order\Pdf\ItemsFactory $pdfItemsFactory - * @param \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate - * @param \Magento\Framework\Translate\Inline\StateInterface $inlineTranslation - * @param \Magento\Sales\Model\Order\Address\Renderer $addressRenderer + * @param PaymentHelper $paymentData + * @param StringUtils $string + * @param ScopeConfigInterface $scopeConfig + * @param Filesystem $filesystem + * @param PdfConfig $pdfConfig + * @param PdfTotalFactory $pdfTotalFactory + * @param PdfItemsFactory $pdfItemsFactory + * @param TimezoneInterface $localeDate + * @param StateInterface $inlineTranslation + * @param OrderAddressRenderer $addressRenderer * @param Carrier $carrierHelper - * @param \Magento\Store\Model\StoreManagerInterface $storeManager - * @param \Magento\Framework\View\LayoutInterface $layout - * @param \Magento\Framework\Locale\ResolverInterface $localeResolver + * @param StoreManagerInterface $storeManager + * @param LayoutInterface $layout + * @param ResolverInterface $localeResolver * @param array $data * * @SuppressWarnings(PHPMD.ExcessiveParameterList) */ public function __construct( - \Magento\Payment\Helper\Data $paymentData, - \Magento\Framework\Stdlib\StringUtils $string, - \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, - \Magento\Framework\Filesystem $filesystem, - \Magento\Sales\Model\Order\Pdf\Config $pdfConfig, - \Magento\Sales\Model\Order\Pdf\Total\Factory $pdfTotalFactory, - \Magento\Sales\Model\Order\Pdf\ItemsFactory $pdfItemsFactory, - \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate, - \Magento\Framework\Translate\Inline\StateInterface $inlineTranslation, - \Magento\Sales\Model\Order\Address\Renderer $addressRenderer, + PaymentHelper $paymentData, + StringUtils $string, + ScopeConfigInterface $scopeConfig, + Filesystem $filesystem, + PdfConfig $pdfConfig, + PdfTotalFactory $pdfTotalFactory, + PdfItemsFactory $pdfItemsFactory, + TimezoneInterface $localeDate, + StateInterface $inlineTranslation, + OrderAddressRenderer $addressRenderer, Carrier $carrierHelper, - \Magento\Store\Model\StoreManagerInterface $storeManager, - \Magento\Framework\View\LayoutInterface $layout, - \Magento\Framework\Locale\ResolverInterface $localeResolver, + StoreManagerInterface $storeManager, + LayoutInterface $layout, + ResolverInterface $localeResolver, array $data = [] ) { $this->_carrierHelper = $carrierHelper; @@ -94,14 +116,14 @@ public function __construct( * Format pdf file * * @param null $shipment - * @return \Zend_Pdf + * @return Zend_Pdf */ public function getPdf($shipment = null) { $this->_beforeGetPdf(); $this->_initRenderer('shipment'); - $pdf = new \Zend_Pdf(); + $pdf = new Zend_Pdf(); $this->_setPdf($pdf); $page = $this->newPage(); @@ -115,7 +137,7 @@ public function getPdf($shipment = null) $this->y = 740; $this->_drawPackageBlock($page); - $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0)); + $page->setFillColor(new Zend_Pdf_Color_GrayScale(0)); $this->_afterGetPdf(); if ($shipment->getStoreId()) { @@ -127,18 +149,18 @@ public function getPdf($shipment = null) /** * Draw header block * - * @param \Zend_Pdf_Page $page - * @return \Magento\Shipping\Model\Order\Pdf\Packaging + * @param Zend_Pdf_Page $page + * @return PdfPackaging */ - protected function _drawHeaderBlock(\Zend_Pdf_Page $page) + protected function _drawHeaderBlock(Zend_Pdf_Page $page) { - $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0.5)); - $page->setLineColor(new \Zend_Pdf_Color_GrayScale(0.5)); + $page->setFillColor(new Zend_Pdf_Color_GrayScale(0.5)); + $page->setLineColor(new Zend_Pdf_Color_GrayScale(0.5)); $page->setLineWidth(0.5); $page->drawRectangle(25, 790, 570, 755); - $page->setFillColor(new \Zend_Pdf_Color_GrayScale(1)); + $page->setFillColor(new Zend_Pdf_Color_GrayScale(1)); $page->drawText(__('Packages'), 35, 770, 'UTF-8'); - $page->setFillColor(new \Zend_Pdf_Color_Rgb(0.93, 0.92, 0.92)); + $page->setFillColor(new Zend_Pdf_Color_Rgb(0.93, 0.92, 0.92)); return $this; } @@ -146,39 +168,39 @@ protected function _drawHeaderBlock(\Zend_Pdf_Page $page) /** * Draw packages block * - * @param \Zend_Pdf_Page $page - * @return \Magento\Shipping\Model\Order\Pdf\Packaging + * @param Zend_Pdf_Page $page + * @return PdfPackaging * @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.NPathComplexity) * @SuppressWarnings(PHPMD.ExcessiveMethodLength) * @SuppressWarnings(PHPMD.UnusedLocalVariable) */ - protected function _drawPackageBlock(\Zend_Pdf_Page $page) + protected function _drawPackageBlock(Zend_Pdf_Page $page) { if ($this->getPackageShippingBlock()) { $packaging = $this->getPackageShippingBlock(); } else { - $packaging = $this->_layout->getBlockSingleton(\Magento\Shipping\Block\Adminhtml\Order\Packaging::class); + $packaging = $this->_layout->getBlockSingleton(OrderPackaging::class); } $packages = $packaging->getPackages(); $packageNum = 1; foreach ($packages as $package) { - $page->setFillColor(new \Zend_Pdf_Color_Rgb(0.93, 0.92, 0.92)); + $page->setFillColor(new Zend_Pdf_Color_Rgb(0.93, 0.92, 0.92)); $page->drawRectangle(25, $this->y + 15, 190, $this->y - 35); $page->drawRectangle(190, $this->y + 15, 350, $this->y - 35); $page->drawRectangle(350, $this->y + 15, 570, $this->y - 35); - $page->setFillColor(new \Zend_Pdf_Color_GrayScale(1)); + $page->setFillColor(new Zend_Pdf_Color_GrayScale(1)); $page->drawRectangle(520, $this->y + 15, 570, $this->y - 5); - $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0)); + $page->setFillColor(new Zend_Pdf_Color_GrayScale(0)); $packageText = __('Package') . ' ' . $packageNum; $page->drawText($packageText, 525, $this->y, 'UTF-8'); $packageNum++; - $package = new \Magento\Framework\DataObject($package); - $params = new \Magento\Framework\DataObject($package->getParams()); + $package = new DataObject($package); + $params = new DataObject($package->getParams()); $dimensionUnits = $this->_carrierHelper->getMeasureDimensionName($params->getDimensionUnits()); $typeText = __('Type') . ' : ' . $packaging->getContainerTypeByCode($params->getContainer()); @@ -257,11 +279,11 @@ protected function _drawPackageBlock(\Zend_Pdf_Page $page) } $this->y = $this->y - 5; - $page->setFillColor(new \Zend_Pdf_Color_GrayScale(1)); + $page->setFillColor(new Zend_Pdf_Color_GrayScale(1)); $page->drawRectangle(25, $this->y, 570, $this->y - 30 - count($package->getItems()) * 12); $this->y = $this->y - 10; - $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0)); + $page->setFillColor(new Zend_Pdf_Color_GrayScale(0)); $page->drawText(__('Items in the Package'), 30, $this->y, 'UTF-8'); $txtIndent = 5; @@ -278,7 +300,7 @@ protected function _drawPackageBlock(\Zend_Pdf_Page $page) } $i = 0; - $page->setFillColor(new \Zend_Pdf_Color_Rgb(0.93, 0.92, 0.92)); + $page->setFillColor(new Zend_Pdf_Color_Rgb(0.93, 0.92, 0.92)); $page->drawRectangle($itemCollsX[$i], $this->y - 5, $itemCollsX[++$i], $this->y - 15); $page->drawRectangle($itemCollsX[$i], $this->y - 5, $itemCollsX[++$i], $this->y - 15); $page->drawRectangle($itemCollsX[$i], $this->y - 5, $itemCollsX[++$i], $this->y - 15); @@ -288,7 +310,7 @@ protected function _drawPackageBlock(\Zend_Pdf_Page $page) $this->y = $this->y - 12; $i = 0; - $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0)); + $page->setFillColor(new Zend_Pdf_Color_GrayScale(0)); $page->drawText(__('Product'), $itemCollsX[$i] + $txtIndent, $this->y, 'UTF-8'); $page->drawText(__('Weight'), $itemCollsX[++$i] + $txtIndent, $this->y, 'UTF-8'); if ($packaging->displayCustomsValue()) { @@ -299,10 +321,10 @@ protected function _drawPackageBlock(\Zend_Pdf_Page $page) $i = 0; foreach ($package->getItems() as $itemId => $item) { - $item = new \Magento\Framework\DataObject($item); + $item = new DataObject($item); $i = 0; - $page->setFillColor(new \Zend_Pdf_Color_GrayScale(1)); + $page->setFillColor(new Zend_Pdf_Color_GrayScale(1)); $page->drawRectangle($itemCollsX[$i], $this->y - 3, $itemCollsX[++$i], $this->y - 15); $page->drawRectangle($itemCollsX[$i], $this->y - 3, $itemCollsX[++$i], $this->y - 15); $page->drawRectangle($itemCollsX[$i], $this->y - 3, $itemCollsX[++$i], $this->y - 15); @@ -311,7 +333,7 @@ protected function _drawPackageBlock(\Zend_Pdf_Page $page) $this->y = $this->y - 12; $i = 0; - $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0)); + $page->setFillColor(new Zend_Pdf_Color_GrayScale(0)); $page->drawText($item->getName(), $itemCollsX[$i] + $txtIndent, $this->y, 'UTF-8'); $page->drawText($item->getWeight(), $itemCollsX[++$i] + $txtIndent, $this->y, 'UTF-8'); if ($packaging->displayCustomsValue()) { diff --git a/app/code/Magento/Shipping/Model/Order/Track.php b/app/code/Magento/Shipping/Model/Order/Track.php index 38aec4a0ccdea..da2a5c8b387d5 100644 --- a/app/code/Magento/Shipping/Model/Order/Track.php +++ b/app/code/Magento/Shipping/Model/Order/Track.php @@ -7,6 +7,17 @@ namespace Magento\Shipping\Model\Order; use Magento\Framework\Api\AttributeValueFactory; +use Magento\Framework\Api\ExtensionAttributesFactory; +use Magento\Framework\Data\Collection\AbstractDb; +use Magento\Framework\Model\Context; +use Magento\Framework\Model\ResourceModel\AbstractResource; +use Magento\Framework\Phrase; +use Magento\Framework\Registry; +use Magento\Sales\Api\Data\ShipmentTrackExtensionInterface; +use Magento\Sales\Api\ShipmentRepositoryInterface; +use Magento\Sales\Model\Order\Shipment\Track as OrderShipmentTrack; +use Magento\Shipping\Model\CarrierFactory; +use Magento\Store\Model\StoreManagerInterface; /** * @method int getParentId() @@ -18,39 +29,39 @@ * @method string getCarrierCode() * @method string getCreatedAt() * @method string getUpdatedAt() - * @method \Magento\Sales\Api\Data\ShipmentTrackExtensionInterface getExtensionAttributes() + * @method ShipmentTrackExtensionInterface getExtensionAttributes() */ -class Track extends \Magento\Sales\Model\Order\Shipment\Track +class Track extends OrderShipmentTrack { /** - * @var \Magento\Shipping\Model\CarrierFactory + * @var CarrierFactory */ protected $_carrierFactory; /** - * @param \Magento\Framework\Model\Context $context - * @param \Magento\Framework\Registry $registry - * @param \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory + * @param Context $context + * @param Registry $registry + * @param ExtensionAttributesFactory $extensionFactory * @param AttributeValueFactory $customAttributeFactory - * @param \Magento\Store\Model\StoreManagerInterface $storeManager - * @param \Magento\Sales\Api\ShipmentRepositoryInterface $shipmentRepository - * @param \Magento\Shipping\Model\CarrierFactory $carrierFactory - * @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource - * @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection + * @param StoreManagerInterface $storeManager + * @param ShipmentRepositoryInterface $shipmentRepository + * @param CarrierFactory $carrierFactory + * @param AbstractResource $resource + * @param AbstractDb $resourceCollection * @param array $data * * @SuppressWarnings(PHPMD.ExcessiveParameterList) */ public function __construct( - \Magento\Framework\Model\Context $context, - \Magento\Framework\Registry $registry, - \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, + Context $context, + Registry $registry, + ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, - \Magento\Store\Model\StoreManagerInterface $storeManager, - \Magento\Sales\Api\ShipmentRepositoryInterface $shipmentRepository, - \Magento\Shipping\Model\CarrierFactory $carrierFactory, - \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null, - \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null, + StoreManagerInterface $storeManager, + ShipmentRepositoryInterface $shipmentRepository, + CarrierFactory $carrierFactory, + AbstractResource $resource = null, + AbstractDb $resourceCollection = null, array $data = [] ) { parent::__construct( @@ -70,7 +81,7 @@ public function __construct( /** * Retrieve detail for shipment track * - * @return \Magento\Framework\Phrase|string + * @return Phrase|string */ public function getNumberDetail() { diff --git a/app/code/Magento/Shipping/Model/Rate/PackageResult.php b/app/code/Magento/Shipping/Model/Rate/PackageResult.php index 4fd4ce63a7e87..65d52d218de2d 100644 --- a/app/code/Magento/Shipping/Model/Rate/PackageResult.php +++ b/app/code/Magento/Shipping/Model/Rate/PackageResult.php @@ -8,6 +8,7 @@ namespace Magento\Shipping\Model\Rate; +use InvalidArgumentException; use Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory; use Magento\Store\Model\StoreManagerInterface; @@ -21,21 +22,15 @@ class PackageResult extends Result */ private $packageResults = []; - /** - * @var ErrorFactory - */ - private $errorFactory; - /** * @param StoreManagerInterface $storeManager * @param ErrorFactory $errorFactory */ public function __construct( StoreManagerInterface $storeManager, - ErrorFactory $errorFactory + private readonly ErrorFactory $errorFactory ) { parent::__construct($storeManager); - $this->errorFactory = $errorFactory; } /** @@ -65,7 +60,7 @@ public function getAllRates() foreach ($this->_rates as $rate) { if ($rate->getMethod() === $currentRate->getMethod()) { if ($rate === $currentRate) { - throw new \InvalidArgumentException('Same object received from carrier.'); + throw new InvalidArgumentException('Same object received from carrier.'); } $rate->setPrice($rate->getPrice() + $currentRate->getPrice()); continue 2; diff --git a/app/code/Magento/Shipping/Model/Rate/Result.php b/app/code/Magento/Shipping/Model/Rate/Result.php index c4ba502b346e8..2b90079e8fc73 100644 --- a/app/code/Magento/Shipping/Model/Rate/Result.php +++ b/app/code/Magento/Shipping/Model/Rate/Result.php @@ -5,6 +5,13 @@ */ namespace Magento\Shipping\Model\Rate; +use Magento\Framework\Filter\Sprintf; +use Magento\Quote\Model\Quote\Address\RateResult\AbstractResult; +use Magento\Quote\Model\Quote\Address\RateResult\Error as RateResultError; +use Magento\Quote\Model\Quote\Address\RateResult\Method as RateResultMethod; +use Magento\Shipping\Model\Rate\Result as RateResult; +use Magento\Store\Model\StoreManagerInterface; + /** * Class Result * @@ -18,7 +25,7 @@ class Result /** * Shipping method rates * - * @var \Magento\Quote\Model\Quote\Address\RateResult\AbstractResult[] + * @var AbstractResult[] */ protected $_rates = []; @@ -30,15 +37,16 @@ class Result protected $_error = null; /** - * @var \Magento\Store\Model\StoreManagerInterface + * @var StoreManagerInterface */ protected $_storeManager; /** - * @param \Magento\Store\Model\StoreManagerInterface $storeManager + * @param StoreManagerInterface $storeManager */ - public function __construct(\Magento\Store\Model\StoreManagerInterface $storeManager) - { + public function __construct( + StoreManagerInterface $storeManager + ) { $this->_storeManager = $storeManager; } @@ -77,17 +85,17 @@ public function getError() /** * Add a rate to the result * - * @param \Magento\Quote\Model\Quote\Address\RateResult\AbstractResult|\Magento\Shipping\Model\Rate\Result $result + * @param AbstractResult|RateResult $result * @return $this */ public function append($result) { - if ($result instanceof \Magento\Quote\Model\Quote\Address\RateResult\Error) { + if ($result instanceof RateResultError) { $this->setError(true); } - if ($result instanceof \Magento\Quote\Model\Quote\Address\RateResult\AbstractResult) { + if ($result instanceof AbstractResult) { $this->_rates[] = $result; - } elseif ($result instanceof \Magento\Shipping\Model\Rate\Result) { + } elseif ($result instanceof RateResult) { $rates = $result->getAllRates(); foreach ($rates as $rate) { $this->append($rate); @@ -99,7 +107,7 @@ public function append($result) /** * Return all quotes in the result * - * @return \Magento\Quote\Model\Quote\Address\RateResult\Method[] + * @return RateResultMethod[] */ public function getAllRates() { @@ -110,7 +118,7 @@ public function getAllRates() * Return rate by id in array * * @param int $id - * @return \Magento\Quote\Model\Quote\Address\RateResult\Method|null + * @return RateResultMethod|null */ public function getRateById($id) { @@ -153,7 +161,7 @@ public function asArray() } elseif ($this->_storeManager->getStore()->getDefaultCurrency()) { $currencyFilter = $this->_storeManager->getStore()->getDefaultCurrency()->getFilter(); } else { - $currencyFilter = new \Magento\Framework\Filter\Sprintf('%s', 2); + $currencyFilter = new Sprintf('%s', 2); } $rates = []; $allRates = $this->getAllRates(); @@ -171,7 +179,7 @@ public function asArray() /** * Get cheapest rate * - * @return null|\Magento\Quote\Model\Quote\Address\RateResult\Method + * @return null|RateResultMethod */ public function getCheapestRate() { @@ -197,7 +205,7 @@ public function sortRatesByPrice() if (!is_array($this->_rates) || !count($this->_rates)) { return $this; } - /* @var $rate \Magento\Quote\Model\Quote\Address\RateResult\Method */ + /* @var RateResultMethod $rate */ foreach ($this->_rates as $i => $rate) { $tmp[$i] = $rate->getPrice(); } diff --git a/app/code/Magento/Shipping/Model/ResourceModel/Order/Track/Collection.php b/app/code/Magento/Shipping/Model/ResourceModel/Order/Track/Collection.php index 4156abd5d8c9a..d2a18c657c3b4 100644 --- a/app/code/Magento/Shipping/Model/ResourceModel/Order/Track/Collection.php +++ b/app/code/Magento/Shipping/Model/ResourceModel/Order/Track/Collection.php @@ -5,12 +5,16 @@ */ namespace Magento\Shipping\Model\ResourceModel\Order\Track; +use Magento\Sales\Model\ResourceModel\Order\Shipment\Track as ResourceOrderShipmentTrack; +use Magento\Sales\Model\ResourceModel\Order\Shipment\Track\Collection as OrderShipmentTrackCollection; +use Magento\Shipping\Model\Order\Track as ModelOrderTrack; + /** * Flat sales order shipment tracks collection * * @SuppressWarnings(PHPMD.DepthOfInheritance) */ -class Collection extends \Magento\Sales\Model\ResourceModel\Order\Shipment\Track\Collection +class Collection extends OrderShipmentTrackCollection { /** * Model initialization @@ -20,8 +24,8 @@ class Collection extends \Magento\Sales\Model\ResourceModel\Order\Shipment\Track protected function _construct() { $this->_init( - \Magento\Shipping\Model\Order\Track::class, - \Magento\Sales\Model\ResourceModel\Order\Shipment\Track::class + ModelOrderTrack::class, + ResourceOrderShipmentTrack::class ); } } diff --git a/app/code/Magento/Shipping/Model/Shipment/Request.php b/app/code/Magento/Shipping/Model/Shipment/Request.php index 23f7924dc0c3a..8b4067197129f 100644 --- a/app/code/Magento/Shipping/Model/Shipment/Request.php +++ b/app/code/Magento/Shipping/Model/Shipment/Request.php @@ -5,64 +5,67 @@ */ namespace Magento\Shipping\Model\Shipment; +use Magento\Framework\DataObject; +use Magento\Sales\Model\Order\Shipment as OrderShipment; + /** - * @method \Magento\Shipping\Model\Shipment\Request setOrderShipment(\Magento\Sales\Model\Order\Shipment $orderShipment) - * @method \Magento\Sales\Model\Order\Shipment getOrderShipment() - * @method \Magento\Shipping\Model\Shipment\Request setShipperContactPersonName(string $value) + * @method Request setOrderShipment(OrderShipment $orderShipment) + * @method OrderShipment getOrderShipment() + * @method Request setShipperContactPersonName(string $value) * @method string getShipperContactPersonName() - * @method \Magento\Shipping\Model\Shipment\Request setShipperContactPersonFirstName(string $value) + * @method Request setShipperContactPersonFirstName(string $value) * @method string getShipperContactPersonFirstName() - * @method \Magento\Shipping\Model\Shipment\Request setShipperContactPersonLastName(string $value) + * @method Request setShipperContactPersonLastName(string $value) * @method string getShipperContactPersonLastName() - * @method \Magento\Shipping\Model\Shipment\Request setShipperContactCompanyName(string $value) + * @method Request setShipperContactCompanyName(string $value) * @method string getShipperContactCompanyName() - * @method \Magento\Shipping\Model\Shipment\Request setShipperContactPhoneNumber(int $value) + * @method Request setShipperContactPhoneNumber(int $value) * @method int getShipperContactPhoneNumber() - * @method \Magento\Shipping\Model\Shipment\Request setShipperAddressStreet(string $value) + * @method Request setShipperAddressStreet(string $value) * @method string getShipperAddressStreet() - * @method \Magento\Shipping\Model\Shipment\Request setShipperAddressStreet1(string $value) + * @method Request setShipperAddressStreet1(string $value) * @method string getShipperAddressStreet1() - * @method \Magento\Shipping\Model\Shipment\Request setShipperAddressStreet2(string $value) + * @method Request setShipperAddressStreet2(string $value) * @method string getShipperAddressStreet2() - * @method \Magento\Shipping\Model\Shipment\Request setShipperAddressCity(string $value) + * @method Request setShipperAddressCity(string $value) * @method string getShipperAddressCity() - * @method \Magento\Shipping\Model\Shipment\Request setShipperAddressStateOrProvinceCode(string $value) + * @method Request setShipperAddressStateOrProvinceCode(string $value) * @method string getShipperAddressStateOrProvinceCode() - * @method \Magento\Shipping\Model\Shipment\Request setShipperAddressPostalCode(int $value) + * @method Request setShipperAddressPostalCode(int $value) * @method int getShipperAddressPostalCode() - * @method \Magento\Shipping\Model\Shipment\Request setShipperAddressCountryCode(string $value) + * @method Request setShipperAddressCountryCode(string $value) * @method string getShipperAddressCountryCode() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientContactPersonName(string $value) + * @method Request setRecipientContactPersonName(string $value) * @method string getRecipientContactPersonName() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientContactPersonFirstName(string $value) + * @method Request setRecipientContactPersonFirstName(string $value) * @method string getRecipientContactPersonFirstName() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientContactPersonLastName(string $value) + * @method Request setRecipientContactPersonLastName(string $value) * @method string getRecipientContactPersonLastName() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientContactCompanyName(string $value) + * @method Request setRecipientContactCompanyName(string $value) * @method string getRecipientContactCompanyName() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientContactPhoneNumber(int $value) + * @method Request setRecipientContactPhoneNumber(int $value) * @method int getRecipientContactPhoneNumber() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientAddressStreet(string $value) + * @method Request setRecipientAddressStreet(string $value) * @method string getRecipientAddressStreet() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientAddressStreet1(string $value) + * @method Request setRecipientAddressStreet1(string $value) * @method string getRecipientAddressStreet1() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientAddressStreet2(string $value) + * @method Request setRecipientAddressStreet2(string $value) * @method string getRecipientAddressStreet2() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientAddressCity(string $value) + * @method Request setRecipientAddressCity(string $value) * @method string getRecipientAddressCity() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientAddressStateOrProvinceCode(string $value) + * @method Request setRecipientAddressStateOrProvinceCode(string $value) * @method string getRecipientAddressStateOrProvinceCode() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientAddressPostalCode(int $value) + * @method Request setRecipientAddressPostalCode(int $value) * @method int getRecipientAddressPostalCode() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientAddressCountryCode(string $value) + * @method Request setRecipientAddressCountryCode(string $value) * @method string getRecipientAddressCountryCode() - * @method \Magento\Shipping\Model\Shipment\Request setShippingMethod(string $value) + * @method Request setShippingMethod(string $value) * @method string getShippingMethod() - * @method \Magento\Shipping\Model\Shipment\Request setPackageWeight(float $value) + * @method Request setPackageWeight(float $value) * @method float getPackageWeight() * * @author Magento Core Team */ -class Request extends \Magento\Framework\DataObject +class Request extends DataObject { } diff --git a/app/code/Magento/Shipping/Model/Shipment/ReturnShipment.php b/app/code/Magento/Shipping/Model/Shipment/ReturnShipment.php index 6a67c5b9c8f97..8c13da420bddc 100644 --- a/app/code/Magento/Shipping/Model/Shipment/ReturnShipment.php +++ b/app/code/Magento/Shipping/Model/Shipment/ReturnShipment.php @@ -5,64 +5,67 @@ */ namespace Magento\Shipping\Model\Shipment; +use Magento\Framework\DataObject; +use Magento\Sales\Model\Order\Shipment as OrderShipment; + /** - * @method \Magento\Shipping\Model\Shipment\Request setOrderShipment(\Magento\Sales\Model\Order\Shipment $orderShipment) - * @method \Magento\Sales\Model\Order\Shipment getOrderShipment() - * @method \Magento\Shipping\Model\Shipment\Request setShipperContactPersonName(string $value) + * @method Request setOrderShipment(OrderShipment $orderShipment) + * @method OrderShipment getOrderShipment() + * @method Request setShipperContactPersonName(string $value) * @method string getShipperContactPersonName() - * @method \Magento\Shipping\Model\Shipment\Request setShipperContactPersonFirstName(string $value) + * @method Request setShipperContactPersonFirstName(string $value) * @method string getShipperContactPersonFirstName() - * @method \Magento\Shipping\Model\Shipment\Request setShipperContactPersonLastName(string $value) + * @method Request setShipperContactPersonLastName(string $value) * @method string getShipperContactPersonLastName() - * @method \Magento\Shipping\Model\Shipment\Request setShipperContactCompanyName(string $value) + * @method Request setShipperContactCompanyName(string $value) * @method string getShipperContactCompanyName() - * @method \Magento\Shipping\Model\Shipment\Request setShipperContactPhoneNumber(int $value) + * @method Request setShipperContactPhoneNumber(int $value) * @method int getShipperContactPhoneNumber() - * @method \Magento\Shipping\Model\Shipment\Request setShipperAddressStreet(string $value) + * @method Request setShipperAddressStreet(string $value) * @method string getShipperAddressStreet() - * @method \Magento\Shipping\Model\Shipment\Request setShipperAddressStreet1(string $value) + * @method Request setShipperAddressStreet1(string $value) * @method string getShipperAddressStreet1() - * @method \Magento\Shipping\Model\Shipment\Request setShipperAddressStreet2(string $value) + * @method Request setShipperAddressStreet2(string $value) * @method string getShipperAddressStreet2() - * @method \Magento\Shipping\Model\Shipment\Request setShipperAddressCity(string $value) + * @method Request setShipperAddressCity(string $value) * @method string getShipperAddressCity() - * @method \Magento\Shipping\Model\Shipment\Request setShipperAddressStateOrProvinceCode(string $value) + * @method Request setShipperAddressStateOrProvinceCode(string $value) * @method string getShipperAddressStateOrProvinceCode() - * @method \Magento\Shipping\Model\Shipment\Request setShipperAddressPostalCode(int $value) + * @method Request setShipperAddressPostalCode(int $value) * @method int getShipperAddressPostalCode() - * @method \Magento\Shipping\Model\Shipment\Request setShipperAddressCountryCode(string $value) + * @method Request setShipperAddressCountryCode(string $value) * @method string getShipperAddressCountryCode() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientContactPersonName(string $value) + * @method Request setRecipientContactPersonName(string $value) * @method string getRecipientContactPersonName() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientContactPersonFirstName(string $value) + * @method Request setRecipientContactPersonFirstName(string $value) * @method string getRecipientContactPersonFirstName() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientContactPersonLastName(string $value) + * @method Request setRecipientContactPersonLastName(string $value) * @method string getRecipientContactPersonLastName() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientContactCompanyName(string $value) + * @method Request setRecipientContactCompanyName(string $value) * @method string getRecipientContactCompanyName() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientContactPhoneNumber(int $value) + * @method Request setRecipientContactPhoneNumber(int $value) * @method int getRecipientContactPhoneNumber() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientAddressStreet(string $value) + * @method Request setRecipientAddressStreet(string $value) * @method string getRecipientAddressStreet() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientAddressStreet1(string $value) + * @method Request setRecipientAddressStreet1(string $value) * @method string getRecipientAddressStreet1() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientAddressStreet2(string $value) + * @method Request setRecipientAddressStreet2(string $value) * @method string getRecipientAddressStreet2() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientAddressCity(string $value) + * @method Request setRecipientAddressCity(string $value) * @method string getRecipientAddressCity() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientAddressStateOrProvinceCode(string $value) + * @method Request setRecipientAddressStateOrProvinceCode(string $value) * @method string getRecipientAddressStateOrProvinceCode() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientAddressPostalCode(int $value) + * @method Request setRecipientAddressPostalCode(int $value) * @method int getRecipientAddressPostalCode() - * @method \Magento\Shipping\Model\Shipment\Request setRecipientAddressCountryCode(string $value) + * @method Request setRecipientAddressCountryCode(string $value) * @method string getRecipientAddressCountryCode() - * @method \Magento\Shipping\Model\Shipment\Request setShippingMethod(string $value) + * @method Request setShippingMethod(string $value) * @method string getShippingMethod() - * @method \Magento\Shipping\Model\Shipment\Request setPackageWeight(float $value) + * @method Request setPackageWeight(float $value) * @method float getPackageWeight() * * @author Magento Core Team */ -class ReturnShipment extends \Magento\Framework\DataObject +class ReturnShipment extends DataObject { } diff --git a/app/code/Magento/Shipping/Model/ShipmentNotifier.php b/app/code/Magento/Shipping/Model/ShipmentNotifier.php index 6a317c068bbc4..182582dd09a8b 100644 --- a/app/code/Magento/Shipping/Model/ShipmentNotifier.php +++ b/app/code/Magento/Shipping/Model/ShipmentNotifier.php @@ -6,6 +6,7 @@ namespace Magento\Shipping\Model; +use Magento\Sales\Model\AbstractNotifier; use Psr\Log\LoggerInterface as Logger; use Magento\Sales\Model\Order\Email\Sender\ShipmentSender; use Magento\Sales\Model\ResourceModel\Order\Status\History\CollectionFactory; @@ -14,7 +15,7 @@ * Class ShipmentNotifier * @package Magento\Shipping\Model */ -class ShipmentNotifier extends \Magento\Sales\Model\AbstractNotifier +class ShipmentNotifier extends AbstractNotifier { /** * @var CollectionFactory @@ -22,7 +23,7 @@ class ShipmentNotifier extends \Magento\Sales\Model\AbstractNotifier protected $historyCollectionFactory; /** - * @var \Psr\Log\LoggerInterface + * @var Logger */ protected $logger; diff --git a/app/code/Magento/Shipping/Model/ShipmentProvider.php b/app/code/Magento/Shipping/Model/ShipmentProvider.php index 917203af72460..82c9dbcec3d09 100644 --- a/app/code/Magento/Shipping/Model/ShipmentProvider.php +++ b/app/code/Magento/Shipping/Model/ShipmentProvider.php @@ -14,17 +14,12 @@ */ class ShipmentProvider implements ShipmentProviderInterface { - /** - * @var RequestInterface - */ - private $request; - /** * @param RequestInterface $request */ - public function __construct(RequestInterface $request) - { - $this->request = $request; + public function __construct( + private readonly RequestInterface $request + ) { } /** diff --git a/app/code/Magento/Shipping/Model/Shipping.php b/app/code/Magento/Shipping/Model/Shipping.php index 7e5a9574e8b92..6d9acb3a92342 100644 --- a/app/code/Magento/Shipping/Model/Shipping.php +++ b/app/code/Magento/Shipping/Model/Shipping.php @@ -6,18 +6,34 @@ namespace Magento\Shipping\Model; +use Magento\Catalog\Model\Product\Type as ProductType; +use Magento\CatalogInventory\Api\StockRegistryInterface; +use Magento\Directory\Model\RegionFactory; +use Magento\Framework\App\Config\ScopeConfigInterface; use Magento\Framework\App\ObjectManager; +use Magento\Framework\DataObject; +use Magento\Framework\Math\Division as MathDivision; use Magento\Quote\Model\Quote\Address\RateCollectorInterface; use Magento\Quote\Model\Quote\Address\RateRequest; use Magento\Quote\Model\Quote\Address\RateRequestFactory; use Magento\Quote\Model\Quote\Address\RateResult\Error; +use Magento\Quote\Model\Quote\Address\RateResult\Error as RateResultError; +use Magento\Quote\Model\Quote\Item as QuoteItem; use Magento\Sales\Model\Order\Shipment; use Magento\Shipping\Model\Carrier\AbstractCarrier; +use Magento\Shipping\Model\Config as ShipmentConfig; use Magento\Shipping\Model\Rate\CarrierResult; use Magento\Shipping\Model\Rate\CarrierResultFactory; use Magento\Shipping\Model\Rate\PackageResult; use Magento\Shipping\Model\Rate\PackageResultFactory; use Magento\Shipping\Model\Rate\Result; +use Magento\Shipping\Model\Rate\Result as RateResult; +use Magento\Shipping\Model\Rate\ResultFactory; +use Magento\Shipping\Model\Shipment\RequestFactory; +use Magento\Store\Api\Data\StoreInterface; +use Magento\Store\Model\ScopeInterface; +use Magento\Store\Model\StoreManagerInterface; +use RuntimeException; /** * @inheritDoc @@ -36,7 +52,7 @@ class Shipping implements RateCollectorInterface /** * Cached result * - * @var \Magento\Shipping\Model\Rate\Result + * @var RateResult */ protected $_result = null; @@ -50,22 +66,22 @@ class Shipping implements RateCollectorInterface /** * Core store config * - * @var \Magento\Framework\App\Config\ScopeConfigInterface + * @var ScopeConfigInterface */ protected $_scopeConfig; /** - * @var \Magento\Store\Model\StoreManagerInterface + * @var StoreManagerInterface */ protected $_storeManager; /** - * @var \Magento\Shipping\Model\Config + * @var ShipmentConfig */ protected $_shippingConfig; /** - * @var \Magento\Shipping\Model\CarrierFactory + * @var CarrierFactory */ protected $_carrierFactory; @@ -80,40 +96,20 @@ class Shipping implements RateCollectorInterface protected $_shipmentRequestFactory; /** - * @var \Magento\Directory\Model\RegionFactory + * @var RegionFactory */ protected $_regionFactory; /** - * @var \Magento\Framework\Math\Division - */ - protected $mathDivision; - - /** - * @var \Magento\CatalogInventory\Api\StockRegistryInterface - */ - protected $stockRegistry; - - /** - * @var RateRequestFactory - */ - private $rateRequestFactory; - - /** - * @var PackageResultFactory - */ - private $packageResultFactory; - - /** - * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig - * @param \Magento\Shipping\Model\Config $shippingConfig - * @param \Magento\Store\Model\StoreManagerInterface $storeManager - * @param \Magento\Shipping\Model\CarrierFactory $carrierFactory + * @param ScopeConfigInterface $scopeConfig + * @param ShipmentConfig $shippingConfig + * @param StoreManagerInterface $storeManager + * @param CarrierFactory $carrierFactory * @param \Magento\Shipping\Model\Rate\CarrierResultFactory $rateResultFactory - * @param \Magento\Shipping\Model\Shipment\RequestFactory $shipmentRequestFactory - * @param \Magento\Directory\Model\RegionFactory $regionFactory - * @param \Magento\Framework\Math\Division $mathDivision - * @param \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry + * @param RequestFactory $shipmentRequestFactory + * @param RegionFactory $regionFactory + * @param MathDivision $mathDivision + * @param StockRegistryInterface $stockRegistry * @param RateRequestFactory $rateRequestFactory * @param PackageResultFactory|null $packageResultFactory * @param CarrierResultFactory|null $carrierResultFactory @@ -121,17 +117,17 @@ class Shipping implements RateCollectorInterface * @SuppressWarnings(PHPMD.ExcessiveParameterList) */ public function __construct( - \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, - \Magento\Shipping\Model\Config $shippingConfig, - \Magento\Store\Model\StoreManagerInterface $storeManager, - \Magento\Shipping\Model\CarrierFactory $carrierFactory, - \Magento\Shipping\Model\Rate\ResultFactory $rateResultFactory, - \Magento\Shipping\Model\Shipment\RequestFactory $shipmentRequestFactory, - \Magento\Directory\Model\RegionFactory $regionFactory, - \Magento\Framework\Math\Division $mathDivision, - \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry, - RateRequestFactory $rateRequestFactory = null, - ?PackageResultFactory $packageResultFactory = null, + ScopeConfigInterface $scopeConfig, + ShipmentConfig $shippingConfig, + StoreManagerInterface $storeManager, + CarrierFactory $carrierFactory, + ResultFactory $rateResultFactory, + RequestFactory $shipmentRequestFactory, + RegionFactory $regionFactory, + protected readonly MathDivision $mathDivision, + protected readonly StockRegistryInterface $stockRegistry, + private ?RateRequestFactory $rateRequestFactory = null, + private ?PackageResultFactory $packageResultFactory = null, ?CarrierResultFactory $carrierResultFactory = null ) { $this->_scopeConfig = $scopeConfig; @@ -142,8 +138,6 @@ public function __construct( $this->_rateResultFactory = $rateResultFactory; $this->_shipmentRequestFactory = $shipmentRequestFactory; $this->_regionFactory = $regionFactory; - $this->mathDivision = $mathDivision; - $this->stockRegistry = $stockRegistry; $this->rateRequestFactory = $rateRequestFactory ?: ObjectManager::getInstance()->get(RateRequestFactory::class); $this->packageResultFactory = $packageResultFactory ?? ObjectManager::getInstance()->get(PackageResultFactory::class); @@ -152,7 +146,7 @@ public function __construct( /** * Get shipping rate result model * - * @return \Magento\Shipping\Model\Rate\Result|CarrierResult + * @return RateResult|CarrierResult */ public function getResult() { @@ -187,7 +181,7 @@ public function resetResult() /** * Retrieve configuration model * - * @return \Magento\Shipping\Model\Config + * @return ShipmentConfig */ public function getConfig() { @@ -197,36 +191,36 @@ public function getConfig() /** * Retrieve all methods for supplied shipping data * - * @param \Magento\Quote\Model\Quote\Address\RateRequest $request + * @param RateRequest $request * @return $this * @todo make it ordered */ - public function collectRates(\Magento\Quote\Model\Quote\Address\RateRequest $request) + public function collectRates(RateRequest $request) { $storeId = $request->getStoreId(); if (!$request->getOrig()) { $request->setCountryId( $this->_scopeConfig->getValue( Shipment::XML_PATH_STORE_COUNTRY_ID, - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $request->getStore() ) )->setRegionId( $this->_scopeConfig->getValue( Shipment::XML_PATH_STORE_REGION_ID, - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $request->getStore() ) )->setCity( $this->_scopeConfig->getValue( Shipment::XML_PATH_STORE_CITY, - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $request->getStore() ) )->setPostcode( $this->_scopeConfig->getValue( Shipment::XML_PATH_STORE_ZIP, - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $request->getStore() ) ); @@ -236,7 +230,7 @@ public function collectRates(\Magento\Quote\Model\Quote\Address\RateRequest $req if (!$limitCarrier) { $carriers = $this->_scopeConfig->getValue( 'carriers', - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $storeId ); @@ -250,7 +244,7 @@ public function collectRates(\Magento\Quote\Model\Quote\Address\RateRequest $req foreach ($limitCarrier as $carrierCode) { $carrierConfig = $this->_scopeConfig->getValue( 'carriers/' . $carrierCode, - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $storeId ); if (!$carrierConfig) { @@ -269,7 +263,7 @@ public function collectRates(\Magento\Quote\Model\Quote\Address\RateRequest $req * @param string $carrierCode * @param RateRequest $request * @return AbstractCarrier - * @throws \RuntimeException + * @throws RuntimeException */ private function prepareCarrier(string $carrierCode, RateRequest $request): AbstractCarrier { @@ -277,7 +271,7 @@ private function prepareCarrier(string $carrierCode, RateRequest $request): Abst ? $this->_carrierFactory->create($carrierCode, $request->getStoreId()) : null; if (!$carrier) { - throw new \RuntimeException('Failed to initialize carrier'); + throw new RuntimeException('Failed to initialize carrier'); } $carrier->setActiveFlag($this->_availabilityConfigField); $result = $carrier->checkAvailableShipCountries($request); @@ -289,10 +283,10 @@ private function prepareCarrier(string $carrierCode, RateRequest $request): Abst * Result will be false if the admin set not to show the shipping module * if the delivery country is not within specific countries */ - throw new \RuntimeException('Cannot collect rates for given request'); + throw new RuntimeException('Cannot collect rates for given request'); } elseif ($result instanceof Error) { $this->getResult()->append($result); - throw new \RuntimeException('Error occurred while preparing a carrier'); + throw new RuntimeException('Error occurred while preparing a carrier'); } return $carrier; @@ -309,11 +303,11 @@ public function collectCarrierRates($carrierCode, $request) { try { $carrier = $this->prepareCarrier($carrierCode, $request); - } catch (\RuntimeException $exception) { + } catch (RuntimeException $exception) { return $this; } - /** @var Result|\Magento\Quote\Model\Quote\Address\RateResult\Error|null $result */ + /** @var Result|RateResultError|null $result */ $result = null; if ($carrier->getConfigData('shipment_requesttype')) { $packages = $this->composePackagesForCarrier($carrier, $request); @@ -351,8 +345,8 @@ public function collectCarrierRates($carrierCode, $request) * * Divides order into items and items into parts if it's necessary * - * @param \Magento\Shipping\Model\Carrier\AbstractCarrier $carrier - * @param \Magento\Quote\Model\Quote\Address\RateRequest $request + * @param AbstractCarrier $carrier + * @param RateRequest $request * @return array [int, float] * @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.NPathComplexity) @@ -365,9 +359,9 @@ public function composePackagesForCarrier($carrier, $request) $maxWeight = (double)$carrier->getConfigData('max_package_weight'); - /** @var $item \Magento\Quote\Model\Quote\Item */ + /** @var QuoteItem $item */ foreach ($allItems as $item) { - if ($item->getProductType() == \Magento\Catalog\Model\Product\Type::TYPE_BUNDLE + if ($item->getProductType() == ProductType::TYPE_BUNDLE && $item->getProduct()->getShipmentType() ) { continue; @@ -393,7 +387,7 @@ public function composePackagesForCarrier($carrier, $request) $itemWeight = (float) $item->getWeight(); if ($item->getIsQtyDecimal() - && $item->getProductType() != \Magento\Catalog\Model\Product\Type::TYPE_BUNDLE + && $item->getProductType() != ProductType::TYPE_BUNDLE ) { $productId = $item->getProduct()->getId(); $itemWeightWhole = $itemWeight * $item->getQty(); @@ -424,7 +418,7 @@ public function composePackagesForCarrier($carrier, $request) if ($changeQty && !$item->getParentItem() && $item->getIsQtyDecimal() - && $item->getProductType() != \Magento\Catalog\Model\Product\Type::TYPE_BUNDLE + && $item->getProductType() != ProductType::TYPE_BUNDLE ) { $qty = 1; } @@ -494,13 +488,13 @@ protected function _makePieces(array $orderItems, float $maxPackageWeight): arra /** * Collect rates by address * - * @param \Magento\Framework\DataObject $address + * @param DataObject $address * @param null|bool|array $limitCarrier * @return $this */ - public function collectRatesByAddress(\Magento\Framework\DataObject $address, $limitCarrier = null) + public function collectRatesByAddress(DataObject $address, $limitCarrier = null) { - /** @var $request \Magento\Quote\Model\Quote\Address\RateRequest */ + /** @var $request RateRequest */ $request = $this->rateRequestFactory->create(); $request->setAllItems($address->getAllItems()); $request->setDestCountryId($address->getCountryId()); @@ -512,7 +506,7 @@ public function collectRatesByAddress(\Magento\Framework\DataObject $address, $l $request->setFreeMethodWeight($address->getFreeMethodWeight()); $request->setPackageQty($address->getItemQty()); - /** @var \Magento\Store\Api\Data\StoreInterface $store */ + /** @var StoreInterface $store */ $store = $this->_storeManager->getStore(); $request->setStoreId($store->getId()); $request->setWebsiteId($store->getWebsiteId()); @@ -548,7 +542,7 @@ private function isShippingCarrierAvailable(string $carrierCode, ?int $storeId = { return $this->_scopeConfig->isSetFlag( 'carriers/' . $carrierCode . '/' . $this->_availabilityConfigField, - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $storeId ); } diff --git a/app/code/Magento/Shipping/Model/Shipping/LabelGenerator.php b/app/code/Magento/Shipping/Model/Shipping/LabelGenerator.php index dad67505b540c..c9dd5caec4287 100644 --- a/app/code/Magento/Shipping/Model/Shipping/LabelGenerator.php +++ b/app/code/Magento/Shipping/Model/Shipping/LabelGenerator.php @@ -6,8 +6,20 @@ */ namespace Magento\Shipping\Model\Shipping; +use Magento\Framework\App\Config\ScopeConfigInterface; use Magento\Framework\App\Filesystem\DirectoryList; use Magento\Framework\App\RequestInterface; +use Magento\Framework\Exception\LocalizedException; +use Magento\Framework\Filesystem; +use Magento\Framework\Filesystem\Directory\Write as DirectoryWrite; +use Magento\Framework\Math\Random as MathRandom; +use Magento\Sales\Model\Order\Shipment as OrderShipment; +use Magento\Sales\Model\Order\Shipment\TrackFactory; +use Magento\Shipping\Model\CarrierFactory; +use Magento\Store\Model\ScopeInterface; +use Zend_Pdf; +use Zend_Pdf_Image; +use Zend_Pdf_Page; /** * @SuppressWarnings(PHPMD.CouplingBetweenObjects) @@ -15,71 +27,41 @@ class LabelGenerator { /** - * @var \Magento\Shipping\Model\CarrierFactory - */ - protected $carrierFactory; - - /** - * @var \Magento\Shipping\Model\Shipping\LabelsFactory - */ - protected $labelFactory; - - /** - * @var \Magento\Framework\App\Config\ScopeConfigInterface - */ - protected $scopeConfig; - - /** - * @var \Magento\Sales\Model\Order\Shipment\TrackFactory - */ - protected $trackFactory; - - /** - * @var \Magento\Framework\Filesystem - */ - protected $filesystem; - - /** - * @param \Magento\Shipping\Model\CarrierFactory $carrierFactory + * @param CarrierFactory $carrierFactory * @param LabelsFactory $labelFactory - * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig - * @param \Magento\Sales\Model\Order\Shipment\TrackFactory $trackFactory - * @param \Magento\Framework\Filesystem $filesystem + * @param ScopeConfigInterface $scopeConfig + * @param TrackFactory $trackFactory + * @param Filesystem $filesystem */ public function __construct( - \Magento\Shipping\Model\CarrierFactory $carrierFactory, - \Magento\Shipping\Model\Shipping\LabelsFactory $labelFactory, - \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, - \Magento\Sales\Model\Order\Shipment\TrackFactory $trackFactory, - \Magento\Framework\Filesystem $filesystem + protected readonly CarrierFactory $carrierFactory, + protected readonly LabelsFactory $labelFactory, + protected readonly ScopeConfigInterface $scopeConfig, + protected readonly TrackFactory $trackFactory, + protected readonly Filesystem $filesystem ) { - $this->carrierFactory = $carrierFactory; - $this->labelFactory = $labelFactory; - $this->scopeConfig = $scopeConfig; - $this->trackFactory = $trackFactory; - $this->filesystem = $filesystem; } /** - * @param \Magento\Sales\Model\Order\Shipment $shipment + * @param OrderShipment $shipment * @param RequestInterface $request * @return void - * @throws \Magento\Framework\Exception\LocalizedException + * @throws LocalizedException */ - public function create(\Magento\Sales\Model\Order\Shipment $shipment, RequestInterface $request) + public function create(OrderShipment $shipment, RequestInterface $request) { $order = $shipment->getOrder(); $carrier = $this->carrierFactory->create($order->getShippingMethod(true)->getCarrierCode()); if (!$carrier->isShippingLabelsAvailable()) { - throw new \Magento\Framework\Exception\LocalizedException(__('Shipping labels is not available.')); + throw new LocalizedException(__('Shipping labels is not available.')); } $shipment->setPackages($request->getParam('packages')); $response = $this->labelFactory->create()->requestToShipment($shipment); if ($response->hasErrors()) { - throw new \Magento\Framework\Exception\LocalizedException(__($response->getErrors())); + throw new LocalizedException(__($response->getErrors())); } if (!$response->hasInfo()) { - throw new \Magento\Framework\Exception\LocalizedException(__('Response info is not exist.')); + throw new LocalizedException(__('Response info is not exist.')); } $labelsContent = []; $trackingNumbers = []; @@ -95,7 +77,7 @@ public function create(\Magento\Sales\Model\Order\Shipment $shipment, RequestInt $carrierCode = $carrier->getCarrierCode(); $carrierTitle = $this->scopeConfig->getValue( 'carriers/' . $carrierCode . '/title', - \Magento\Store\Model\ScopeInterface::SCOPE_STORE, + ScopeInterface::SCOPE_STORE, $shipment->getStoreId() ); if (!empty($trackingNumbers)) { @@ -104,7 +86,7 @@ public function create(\Magento\Sales\Model\Order\Shipment $shipment, RequestInt } /** - * @param \Magento\Sales\Model\Order\Shipment $shipment + * @param OrderShipment $shipment * @param array $trackingNumbers * @param string $carrierCode * @param string $carrierTitle @@ -112,7 +94,7 @@ public function create(\Magento\Sales\Model\Order\Shipment $shipment, RequestInt * @return void */ private function addTrackingNumbersToShipment( - \Magento\Sales\Model\Order\Shipment $shipment, + OrderShipment $shipment, $trackingNumbers, $carrierCode, $carrierTitle @@ -135,14 +117,14 @@ private function addTrackingNumbersToShipment( * Combine array of labels as instance PDF * * @param array $labelsContent - * @return \Zend_Pdf + * @return Zend_Pdf */ public function combineLabelsPdf(array $labelsContent) { - $outputPdf = new \Zend_Pdf(); + $outputPdf = new Zend_Pdf(); foreach ($labelsContent as $content) { if (stripos($content, '%PDF-') !== false) { - $pdfLabel = \Zend_Pdf::parse($content); + $pdfLabel = Zend_Pdf::parse($content); foreach ($pdfLabel->pages as $page) { $outputPdf->pages[] = clone $page; } @@ -160,11 +142,11 @@ public function combineLabelsPdf(array $labelsContent) * Create \Zend_Pdf_Page instance with image from $imageString. Supports JPEG, PNG, GIF, WBMP, and GD2 formats. * * @param string $imageString - * @return \Zend_Pdf_Page|false + * @return Zend_Pdf_Page|false */ public function createPdfPageFromImageString($imageString) { - /** @var \Magento\Framework\Filesystem\Directory\Write $directory */ + /** @var DirectoryWrite $directory */ $directory = $this->filesystem->getDirectoryWrite( DirectoryList::TMP ); @@ -176,14 +158,14 @@ public function createPdfPageFromImageString($imageString) $xSize = imagesx($image); $ySize = imagesy($image); - $page = new \Zend_Pdf_Page($xSize, $ySize); + $page = new Zend_Pdf_Page($xSize, $ySize); imageinterlace($image, 0); $tmpFileName = $directory->getAbsolutePath( - 'shipping_labels_' . uniqid(\Magento\Framework\Math\Random::getRandomNumber()) . time() . '.png' + 'shipping_labels_' . uniqid(MathRandom::getRandomNumber()) . time() . '.png' ); imagepng($image, $tmpFileName); - $pdfImage = \Zend_Pdf_Image::imageWithPath($tmpFileName); + $pdfImage = Zend_Pdf_Image::imageWithPath($tmpFileName); $page->drawImage($pdfImage, 0, 0, $xSize, $ySize); $directory->delete($directory->getRelativePath($tmpFileName)); if (is_resource($image)) { diff --git a/app/code/Magento/Shipping/Model/Shipping/Labels.php b/app/code/Magento/Shipping/Model/Shipping/Labels.php index 08ce168567182..355feddf875ad 100644 --- a/app/code/Magento/Shipping/Model/Shipping/Labels.php +++ b/app/code/Magento/Shipping/Model/Shipping/Labels.php @@ -6,55 +6,67 @@ namespace Magento\Shipping\Model\Shipping; +use Magento\Backend\Model\Auth\Session as AuthSession; +use Magento\CatalogInventory\Api\StockRegistryInterface; +use Magento\Directory\Model\RegionFactory; +use Magento\Framework\App\Config\ScopeConfigInterface; use Magento\Framework\DataObject; use Magento\Framework\Exception\LocalizedException; +use Magento\Framework\Math\Division as MathDivision; +use Magento\Sales\Model\Order\Address as OrderAddress; use Magento\Sales\Model\Order\Shipment; use Magento\Sales\Model\Order\Address; +use Magento\Shipping\Model\CarrierFactory; +use Magento\Shipping\Model\Config as ShippingConfig; +use Magento\Shipping\Model\Rate\ResultFactory; use Magento\Shipping\Model\Shipment\Request; +use Magento\Shipping\Model\Shipment\RequestFactory; +use Magento\Shipping\Model\Shipping; use Magento\Store\Model\ScopeInterface; +use Magento\Store\Model\StoreManagerInterface; use Magento\User\Model\User; /** * Shipping labels model * @SuppressWarnings(PHPMD.CouplingBetweenObjects) */ -class Labels extends \Magento\Shipping\Model\Shipping +class Labels extends Shipping { /** - * @var \Magento\Backend\Model\Auth\Session + * @var AuthSession */ protected $_authSession; /** - * @var \Magento\Shipping\Model\Shipment\Request + * @var Request */ protected $_request; /** - * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig - * @param \Magento\Shipping\Model\Config $shippingConfig - * @param \Magento\Store\Model\StoreManagerInterface $storeManager - * @param \Magento\Shipping\Model\CarrierFactory $carrierFactory - * @param \Magento\Shipping\Model\Rate\ResultFactory $rateResultFactory - * @param \Magento\Shipping\Model\Shipment\RequestFactory $shipmentRequestFactory - * @param \Magento\Directory\Model\RegionFactory $regionFactory - * @param \Magento\Framework\Math\Division $mathDivision - * @param \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry - * @param \Magento\Backend\Model\Auth\Session $authSession - * @param \Magento\Shipping\Model\Shipment\Request $request + * @param ScopeConfigInterface $scopeConfig + * @param ShippingConfig $shippingConfig + * @param StoreManagerInterface $storeManager + * @param CarrierFactory $carrierFactory + * @param ResultFactory $rateResultFactory + * @param RequestFactory $shipmentRequestFactory + * @param RegionFactory $regionFactory + * @param MathDivision $mathDivision + * @param StockRegistryInterface $stockRegistry + * @param AuthSession $authSession + * @param Request $request * @SuppressWarnings(PHPMD.ExcessiveParameterList) */ public function __construct( - \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, - \Magento\Shipping\Model\Config $shippingConfig, - \Magento\Store\Model\StoreManagerInterface $storeManager, - \Magento\Shipping\Model\CarrierFactory $carrierFactory, - \Magento\Shipping\Model\Rate\ResultFactory $rateResultFactory, - \Magento\Shipping\Model\Shipment\RequestFactory $shipmentRequestFactory, - \Magento\Directory\Model\RegionFactory $regionFactory, - \Magento\Framework\Math\Division $mathDivision, - \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry, - \Magento\Backend\Model\Auth\Session $authSession, + ScopeConfigInterface $scopeConfig, + ShippingConfig $shippingConfig, + StoreManagerInterface $storeManager, + CarrierFactory $carrierFactory, + ResultFactory $rateResultFactory, + RequestFactory $shipmentRequestFactory, + RegionFactory $regionFactory, + MathDivision $mathDivision, + StockRegistryInterface $stockRegistry, + AuthSession $authSession, Request $request ) { $this->_authSession = $authSession; @@ -76,8 +88,8 @@ public function __construct( * Prepare and do request to shipment * * @param Shipment $orderShipment - * @return \Magento\Framework\DataObject - * @throws \Magento\Framework\Exception\LocalizedException + * @return DataObject + * @throws LocalizedException * @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.ExcessiveMethodLength) */ @@ -146,7 +158,7 @@ public function requestToShipment(Shipment $orderShipment) ); } - /** @var $request \Magento\Shipping\Model\Shipment\Request */ + /** @var Request $request */ $request = $this->_shipmentRequestFactory->create(); $request->setOrderShipment($orderShipment); $address = $order->getShippingAddress(); @@ -165,9 +177,9 @@ public function requestToShipment(Shipment $orderShipment) /** * Set shipper details into request - * @param \Magento\Shipping\Model\Shipment\Request $request - * @param \Magento\User\Model\User $storeAdmin - * @param \Magento\Framework\DataObject $store + * @param Request $request + * @param User $storeAdmin + * @param DataObject $store * @param $shipmentStoreId * @param $regionCode * @param $originStreet @@ -222,8 +234,8 @@ protected function setShipperDetails( /** * Set recipient details into request - * @param \Magento\Shipping\Model\Shipment\Request $request - * @param \Magento\Sales\Model\Order\Address $address + * @param Request $request + * @param OrderAddress $address * @return void */ protected function setRecipientDetails(Request $request, Address $address) diff --git a/app/code/Magento/Shipping/Model/Simplexml/Element.php b/app/code/Magento/Shipping/Model/Simplexml/Element.php index c72b988bc77d0..7286e07da2134 100644 --- a/app/code/Magento/Shipping/Model/Simplexml/Element.php +++ b/app/code/Magento/Shipping/Model/Simplexml/Element.php @@ -6,11 +6,13 @@ namespace Magento\Shipping\Model\Simplexml; +use Magento\Framework\Simplexml\Element as SimplexmlElement; + /** * Extends SimpleXML to add valuable functionality to \SimpleXMLElement class * */ -class Element extends \Magento\Framework\Simplexml\Element +class Element extends SimplexmlElement { /** * Adds an attribute to the SimpleXML element @@ -33,7 +35,7 @@ public function addAttribute($name, $value = null, $namespace = null) * @param string $name The name of the child element to add. * @param string $value If specified, the value of the child element. * @param string $namespace If specified, the namespace to which the child element belongs. - * @return \Magento\Shipping\Model\Simplexml\Element + * @return Element */ #[\ReturnTypeWillChange] public function addChild($name, $value = null, $namespace = null) diff --git a/app/code/Magento/Shipping/Model/Source/HandlingAction.php b/app/code/Magento/Shipping/Model/Source/HandlingAction.php index f56cce631b0ef..f715700dd5887 100644 --- a/app/code/Magento/Shipping/Model/Source/HandlingAction.php +++ b/app/code/Magento/Shipping/Model/Source/HandlingAction.php @@ -5,7 +5,10 @@ */ namespace Magento\Shipping\Model\Source; -class HandlingAction implements \Magento\Framework\Option\ArrayInterface +use Magento\Framework\Option\ArrayInterface; +use Magento\Shipping\Model\Carrier\AbstractCarrier; + +class HandlingAction implements ArrayInterface { /** * {@inheritdoc} @@ -14,11 +17,11 @@ public function toOptionArray() { return [ [ - 'value' => \Magento\Shipping\Model\Carrier\AbstractCarrier::HANDLING_ACTION_PERORDER, + 'value' => AbstractCarrier::HANDLING_ACTION_PERORDER, 'label' => __('Per Order'), ], [ - 'value' => \Magento\Shipping\Model\Carrier\AbstractCarrier::HANDLING_ACTION_PERPACKAGE, + 'value' => AbstractCarrier::HANDLING_ACTION_PERPACKAGE, 'label' => __('Per Package') ] ]; diff --git a/app/code/Magento/Shipping/Model/Source/HandlingType.php b/app/code/Magento/Shipping/Model/Source/HandlingType.php index 8d876338654fd..cac5bb0f22522 100644 --- a/app/code/Magento/Shipping/Model/Source/HandlingType.php +++ b/app/code/Magento/Shipping/Model/Source/HandlingType.php @@ -5,7 +5,10 @@ */ namespace Magento\Shipping\Model\Source; -class HandlingType implements \Magento\Framework\Option\ArrayInterface +use Magento\Framework\Option\ArrayInterface; +use Magento\Shipping\Model\Carrier\AbstractCarrier; + +class HandlingType implements ArrayInterface { /** * {@inheritdoc} @@ -14,11 +17,11 @@ public function toOptionArray() { return [ [ - 'value' => \Magento\Shipping\Model\Carrier\AbstractCarrier::HANDLING_TYPE_FIXED, + 'value' => AbstractCarrier::HANDLING_TYPE_FIXED, 'label' => __('Fixed'), ], [ - 'value' => \Magento\Shipping\Model\Carrier\AbstractCarrier::HANDLING_TYPE_PERCENT, + 'value' => AbstractCarrier::HANDLING_TYPE_PERCENT, 'label' => __('Percent') ] ]; diff --git a/app/code/Magento/Shipping/Model/Tracking/Result/AbstractResult.php b/app/code/Magento/Shipping/Model/Tracking/Result/AbstractResult.php index de773b6c0e4d0..2d59ff036eca3 100644 --- a/app/code/Magento/Shipping/Model/Tracking/Result/AbstractResult.php +++ b/app/code/Magento/Shipping/Model/Tracking/Result/AbstractResult.php @@ -5,6 +5,8 @@ */ namespace Magento\Shipping\Model\Tracking\Result; -class AbstractResult extends \Magento\Framework\DataObject +use Magento\Framework\DataObject; + +class AbstractResult extends DataObject { } diff --git a/app/code/Magento/Shipping/registration.php b/app/code/Magento/Shipping/registration.php index 9652f5a61a3bc..226998abc56e3 100644 --- a/app/code/Magento/Shipping/registration.php +++ b/app/code/Magento/Shipping/registration.php @@ -6,4 +6,8 @@ use Magento\Framework\Component\ComponentRegistrar; -ComponentRegistrar::register(ComponentRegistrar::MODULE, 'Magento_Shipping', __DIR__); +ComponentRegistrar::register( + ComponentRegistrar::MODULE, + 'Magento_Shipping', + __DIR__ +);