MAGETWO-94347: Implement handling of large number of addresses on storefront Address book

Author: le0n4eg

app/code/Magento/Customer/Block/Address/Book.php

@@ -7,9 +7,7 @@
 
 use Magento\Customer\Api\AddressRepositoryInterface;
 use Magento\Customer\Model\Address\Mapper;
-use Magento\Framework\App\ObjectManager;
-use Magento\Directory\Model\CountryFactory;
-use Magento\Customer\Model\ResourceModel\Address\CollectionFactory as AddressCollectionFactory;
+use Magento\Customer\Block\Address\Grid as AddressesGrid;
 
 /**
  * Customer address book block
@@ -25,6 +23,11 @@ class Book extends \Magento\Framework\View\Element\Template
      */
     protected $currentCustomer;
 
+    /**
+     * @var \Magento\Customer\Api\CustomerRepositoryInterface
+     */
+    protected $customerRepository;
+
     /**
      * @var AddressRepositoryInterface
      */
@@ -41,32 +44,20 @@ class Book extends \Magento\Framework\View\Element\Template
     protected $addressMapper;
 
     /**
-     * @var \Magento\Customer\Model\ResourceModel\Address\CollectionFactory
-     */
-    private $addressCollectionFactory;
-
-    /**
-     * @var \Magento\Customer\Model\ResourceModel\Address\Collection
+     * @var AddressesGrid
      */
-    private $addressCollection;
-
-    /**
-     * @var CountryFactory
-     */
-    private $countryFactory;
+    private $addressesGrid;
 
     /**
      * @param \Magento\Framework\View\Element\Template\Context $context
-     * @param \Magento\Customer\Api\CustomerRepositoryInterface $customerRepository
+     * @param CustomerRepositoryInterface|null $customerRepository
      * @param AddressRepositoryInterface $addressRepository
      * @param \Magento\Customer\Helper\Session\CurrentCustomer $currentCustomer
      * @param \Magento\Customer\Model\Address\Config $addressConfig
      * @param Mapper $addressMapper
      * @param array $data
-     * @param AddressCollectionFactory|null $addressCollectionFactory
-     * @param CountryFactory|null $countryFactory
+     * @param AddressesGrid|null $addressesGrid
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
      */
     public function __construct(
         \Magento\Framework\View\Element\Template\Context $context,
@@ -76,42 +67,37 @@ public function __construct(
         \Magento\Customer\Model\Address\Config $addressConfig,
         Mapper $addressMapper,
         array $data = [],
-        AddressCollectionFactory $addressCollectionFactory = null,
-        CountryFactory $countryFactory = null
+        Grid $addressesGrid = null
     ) {
         $this->currentCustomer = $currentCustomer;
         $this->addressRepository = $addressRepository;
         $this->_addressConfig = $addressConfig;
         $this->addressMapper = $addressMapper;
-        $this->addressCollectionFactory = $addressCollectionFactory ?: ObjectManager::getInstance()
-            ->get(AddressCollectionFactory::class);
-        $this->countryFactory = $countryFactory ?: ObjectManager::getInstance()->get(CountryFactory::class);
-
+        $this->addressesGrid = $addressesGrid ?: \Magento\Framework\App\ObjectManager::getInstance()
+            ->get(AddressesGrid::class);
         parent::__construct($context, $data);
     }
 
     /**
      * Prepare the Address Book section layout
      *
      * @return $this
-     * @throws \Magento\Framework\Exception\LocalizedException
      */
     protected function _prepareLayout()
     {
         $this->pageConfig->getTitle()->set(__('Address Book'));
-        parent::_prepareLayout();
-        $this->preparePager();
-        return $this;
+        return parent::_prepareLayout();
     }
 
     /**
      * Generate and return "New Address" URL
      *
      * @return string
+     * @deprecated not used in this block (new block for additional addresses: \Magento\Customer\Block\Address\Grid
      */
     public function getAddAddressUrl()
     {
-        return $this->getUrl('customer/address/new', ['_secure' => true]);
+        return $this->addressesGrid->getAddAddressUrl();
     }
 
     /**
@@ -131,22 +117,25 @@ public function getBackUrl()
      * Generate and return "Delete" URL
      *
      * @return string
+     * @deprecated not used in this block (new block for additional addresses: \Magento\Customer\Block\Address\Grid
      */
     public function getDeleteUrl()
     {
-        return $this->getUrl('customer/address/delete');
+        return $this->addressesGrid->getDeleteUrl();
     }
 
     /**
      * Generate and return "Edit Address" URL.
+     *
      * Address ID passed in parameters
      *
      * @param int $addressId
      * @return string
+     * @deprecated not used in this block (new block for additional addresses: \Magento\Customer\Block\Address\Grid
      */
     public function getAddressEditUrl($addressId)
     {
-        return $this->getUrl('customer/address/edit', ['_secure' => true, 'id' => $addressId]);
+        return $this->addressesGrid->getAddressEditUrl($addressId);
     }
 
     /**
@@ -162,33 +151,23 @@ public function hasPrimaryAddress()
 
     /**
      * Get current additional customer addresses
+     *
      * Will return array of address interfaces if customer have additional addresses and false in other case.
      *
      * @return \Magento\Customer\Api\Data\AddressInterface[]|bool
      * @throws \Magento\Framework\Exception\LocalizedException
+     * @deprecated not used in this block (new block for additional addresses: \Magento\Customer\Block\Address\Grid
      */
     public function getAdditionalAddresses()
     {
-        try {
-            $addresses = $this->getAddressCollection();
-        } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
-            return false;
-        }
-        $primaryAddressIds = [$this->getDefaultBilling(), $this->getDefaultShipping()];
-        foreach ($addresses as $address) {
-            if (!in_array($address->getId(), $primaryAddressIds)) {
-                $additional[] = $address->getDataModel();
-            }
-        }
-        return empty($additional) ? false : $additional;
+        return $this->addressesGrid->getAdditionalAddresses();
     }
 
     /**
      * Render an address as HTML and return the result
      *
      * @param \Magento\Customer\Api\Data\AddressInterface $address
      * @return string
-     * @deprecated Not used anymore as addresses are showed as a grid
      */
     public function getAddressHtml(\Magento\Customer\Api\Data\AddressInterface $address = null)
     {
@@ -202,48 +181,28 @@ public function getAddressHtml(\Magento\Customer\Api\Data\AddressInterface $addr
 
     /**
      * Get current customer
+     *
      * Check if customer is stored in current object and return it
      * or get customer by current customer ID through repository
      *
-     * @return \Magento\Customer\Api\Data\CustomerInterface
+     * @return \Magento\Customer\Api\Data\CustomerInterface|null
      */
     public function getCustomer()
     {
-        $customer = $this->getData('customer');
-        if ($customer === null) {
-            $customer = $this->currentCustomer->getCustomer();
-            $this->setData('customer', $customer);
-        }
-        return $customer;
+        return $this->addressesGrid->getCustomer();
     }
 
     /**
-     * Get default billing address
-     * Return address string if address found and null if not
-     *
-     * @return string
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @return int|null
      */
     public function getDefaultBilling()
     {
         $customer = $this->getCustomer();
-
-        return $customer->getDefaultBilling();
-    }
-
-
-    /**
-     * Get default shipping address
-     * Return address string if address found and null of not
-     *
-     * @return string
-     * @throws \Magento\Framework\Exception\LocalizedException
-     */
-    public function getDefaultShipping()
-    {
-        $customer = $this->getCustomer();
-
-        return $customer->getDefaultShipping();
+        if ($customer === null) {
+            return null;
+        } else {
+            return $customer->getDefaultBilling();
+        }
     }
 
     /**
@@ -263,77 +222,15 @@ public function getAddressById($addressId)
     }
 
     /**
-     * Get one string street address from "two fields" array or just returns string if it was passed in parameters
-     *
-     * @param string|array $street
-     * @return string
+     * @return int|null
      */
-    public function getStreetAddress($street)
-    {
-        if (is_array($street)) {
-            $street = implode(', ', $street);
-        }
-        return $street;
-    }
-
-    /**
-     * Get pager section HTML code
-     *
-     * @return string
-     */
-    public function getPagerHtml()
-    {
-        return $this->getChildHtml('pager');
-    }
-
-    /**
-     * Get country name by $countryId
-     * Using \Magento\Directory\Model\Country to get country name by $countryId
-     *
-     * @param string $countryId
-     * @return string
-     */
-    public function getCountryById($countryId)
-    {
-        /** @var \Magento\Directory\Model\Country $country */
-        $country = $this->countryFactory->create();
-        return $country->loadByCode($countryId)->getName();
-    }
-
-    /**
-     * Get pager layout
-     *
-     * @return void
-     * @throws \Magento\Framework\Exception\LocalizedException
-     */
-    private function preparePager()
-    {
-        $addressCollection = $this->getAddressCollection();
-        if (null !== $addressCollection) {
-            $pager = $this->getLayout()->createBlock(
-                \Magento\Theme\Block\Html\Pager::class,
-                'customer.addresses.pager'
-            )->setCollection($addressCollection);
-            $this->setChild('pager', $pager);
-        }
-    }
-
-    /**
-     * Get customer addresses collection.
-     * Filters collection by customer id
-     *
-     * @return \Magento\Customer\Model\ResourceModel\Address\Collection
-     */
-    private function getAddressCollection()
+    public function getDefaultShipping()
     {
-        if (null === $this->addressCollection) {
-            /** @var \Magento\Customer\Model\ResourceModel\Address\Collection $collection */
-            $collection = $this->addressCollectionFactory->create();
-            $collection->setOrder('entity_id', 'desc')
-                ->setCustomerFilter([$this->getCustomer()->getId()]);
-            $this->addressCollection = $collection;
+        $customer = $this->getCustomer();
+        if ($customer === null) {
+            return null;
+        } else {
+            return $customer->getDefaultShipping();
         }
-        return $this->addressCollection;
     }
-
 }