Rename \Magento\Framework\Api\SearchCriteriaBuilder::addFilter() to addFilters()

Purpose
==

Make method name more descriptive and easier to understand.

Background
==

Having a method called `addFilter()` which take an array of `Filter` instances caused
many doubletakes and facepalms during the m2 dev training.
It seems as if the method name originated from the old collection `addFieldToFilter`
from collections in Magento 1, where the condition type was set as a key in the passed
argument array (e.g. `addFieldToFilter('name', ['eq' => $filter])`).
In fact, some integration tests even set such expectations on the searchCriteriaBuilder,
for example *app/code/Magento/Sales/Test/Unit/Model/Service/CreditmemoServiceTest.php*.

However, this must be a bug because the array keys in the argument array are ignored,
and the code only happened to work because the repositories in question default to
using the 'eq' operator when applying the filter groups to the collection if no condition
type is set on the filter instance.

Reasons for this PR
==

Make the method name more intuitive.
Naming definitely could still be improved, but at least it no longer is that misleading.
Maybe using `addFilterGroupWithFilters()` would be even more descriptive, but I chose the
smaller change, since it probably is "good enough".

Remove wrong examples of method usage from tests, so they don't serve as wrong
documentation.

Author: Vinai

app/code/Magento/Backend/Model/Search/Customer.php

@@ -96,7 +96,7 @@ public function load()
                 ->setValue($this->getQuery() . '%')
                 ->create();
         }
-        $this->searchCriteriaBuilder->addFilter($filters);
+        $this->searchCriteriaBuilder->addFilters($filters);
         $searchCriteria = $this->searchCriteriaBuilder->create();
         $searchResults = $this->customerRepository->getList($searchCriteria);
 

app/code/Magento/Catalog/Model/Category/AttributeRepository.php

@@ -73,7 +73,7 @@ public function getCustomAttributesMetadata($dataObjectClassName = null)
         $defaultAttributeSetId = $this->eavConfig
             ->getEntityType(\Magento\Catalog\Api\Data\CategoryAttributeInterface::ENTITY_TYPE_CODE)
             ->getDefaultAttributeSetId();
-        $searchCriteria = $this->searchCriteriaBuilder->addFilter(
+        $searchCriteria = $this->searchCriteriaBuilder->addFilters(
             [
                 $this->filterBuilder
                     ->setField('attribute_set_id')

app/code/Magento/Catalog/Model/Product/Attribute/Repository.php

@@ -212,7 +212,7 @@ public function getCustomAttributesMetadata($dataObjectClassName = null)
         $defaultAttributeSetId = $this->eavConfig
             ->getEntityType(\Magento\Catalog\Api\Data\ProductAttributeInterface::ENTITY_TYPE_CODE)
             ->getDefaultAttributeSetId();
-        $searchCriteria = $this->searchCriteriaBuilder->addFilter(
+        $searchCriteria = $this->searchCriteriaBuilder->addFilters(
             [
                 $this->filterBuilder
                     ->setField('attribute_set_id')

app/code/Magento/Catalog/Model/Product/Attribute/SetRepository.php

@@ -62,7 +62,7 @@ public function save(\Magento\Eav\Api\Data\AttributeSetInterface $attributeSet)
      */
     public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria)
     {
-        $this->searchCriteriaBuilder->addFilter(
+        $this->searchCriteriaBuilder->addFilters(
             [
                 $this->filterBuilder
                     ->setField('entity_type_code')

app/code/Magento/Catalog/Model/ProductRepository.php

@@ -652,7 +652,7 @@ public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCr
         $defaultAttributeSetId = $this->eavConfig
             ->getEntityType(\Magento\Catalog\Api\Data\ProductAttributeInterface::ENTITY_TYPE_CODE)
             ->getDefaultAttributeSetId();
-        $extendedSearchCriteria = $this->searchCriteriaBuilder->addFilter(
+        $extendedSearchCriteria = $this->searchCriteriaBuilder->addFilters(
             [
                 $this->filterBuilder
                     ->setField('attribute_set_id')

app/code/Magento/Catalog/Test/Unit/Model/Category/AttributeRepositoryTest.php

@@ -114,7 +114,7 @@ public function testGetCustomAttributesMetadata()
             3
         )->willReturnSelf();
         $this->filterBuilderMock->expects($this->once())->method('create')->willReturn($filterMock);
-        $this->searchBuilderMock->expects($this->once())->method('addFilter')->with([$filterMock])->willReturnSelf();
+        $this->searchBuilderMock->expects($this->once())->method('addFilters')->with([$filterMock])->willReturnSelf();
         $searchCriteriaMock = $this->getMock('Magento\Framework\Api\SearchCriteria', [], [], '', false);
         $this->searchBuilderMock->expects($this->once())->method('create')->willReturn($searchCriteriaMock);
         $itemMock = $this->getMock('Magento\Framework\Object', [], [], '', false);

app/code/Magento/Catalog/Test/Unit/Model/Product/Attribute/RepositoryTest.php

@@ -180,7 +180,7 @@ public function testGetCustomAttributesMetadata()
             ->willReturnSelf();
         $this->filterBuilderMock->expects($this->once())->method('create')->willReturn($filterMock);
         $this->searchCriteriaBuilderMock->expects($this->once())
-            ->method('addFilter')
+            ->method('addFilters')
             ->with([$filterMock])
             ->willReturnSelf();
         $searchCriteriaMock = $this->getMock('Magento\Framework\Api\SearchCriteria', [], [], '', false);

app/code/Magento/Catalog/Test/Unit/Model/Product/Attribute/SetRepositoryTest.php

@@ -181,7 +181,7 @@ public function testGetList()
         $this->filterBuilderMock->expects($this->once())->method('create')->willReturn($filterMock);
 
         $this->searchCriteriaBuilderMock->expects($this->once())
-            ->method('addFilter')
+            ->method('addFilters')
             ->with([$filterMock])
             ->willReturnSelf();
         $this->searchCriteriaBuilderMock->expects($this->once())

app/code/Magento/Catalog/Test/Unit/Model/ProductRepositoryTest.php

@@ -573,7 +573,7 @@ public function testGetList()
         $this->filterBuilderMock->expects($this->once())->method('setValue')
             ->with(4)
             ->willReturn($this->filterBuilderMock);
-        $this->searchCriteriaBuilderMock->expects($this->once())->method('addFilter')->with([$filterMock])
+        $this->searchCriteriaBuilderMock->expects($this->once())->method('addFilters')->with([$filterMock])
             ->willReturn($searchCriteriaBuilderMock);
         $searchCriteriaBuilderMock->expects($this->once())->method('create')->willReturn($extendedSearchCriteriaMock);
         $this->metadataServiceMock->expects($this->once())->method('getList')->with($extendedSearchCriteriaMock)

app/code/Magento/Customer/Model/GroupManagement.php

@@ -154,8 +154,8 @@ public function getLoggedInGroups()
             ->setValue(self::CUST_GROUP_ALL)
             ->create();
         $searchCriteria = $this->searchCriteriaBuilder
-            ->addFilter($notLoggedInFilter)
-            ->addFilter($groupAll)
+            ->addFilters($notLoggedInFilter)
+            ->addFilters($groupAll)
             ->create();
         return $this->groupRepository->getList($searchCriteria)->getItems();
     }

app/code/Magento/Customer/Test/Unit/Model/Resource/Group/Grid/ServiceCollectionTest.php

@@ -88,7 +88,7 @@ public function testGetSearchCriteriaImplicitEq()
             ->setCurrentPage(1)
             ->setPageSize(false)
             ->addSortOrder($sortOrder)
-            ->addFilter(
+            ->addFilters(
                 [$this->filterBuilder->setField('name')->setConditionType('eq')->setValue('Magento')->create()]
             )->create();
 
@@ -119,7 +119,7 @@ public function testGetSearchCriteriaOneField()
             ->setCurrentPage(1)
             ->setPageSize(0)
             ->addSortOrder($sortOrder)
-            ->addFilter([$filter])
+            ->addFilters([$filter])
             ->create();
 
         // Verifies that the search criteria Data Object created by the serviceCollection matches expected
@@ -150,7 +150,7 @@ public function testGetSearchCriteriaOr()
             ->setCurrentPage(1)
             ->setPageSize(0)
             ->addSortOrder($sortOrder)
-            ->addFilter(
+            ->addFilters(
                 [
                     $this->filterBuilder->setField($fieldA)->setConditionType('eq')->setValue($value)->create(),
                     $this->filterBuilder->setField($fieldB)->setConditionType('eq')->setValue($value)->create(),
@@ -186,13 +186,13 @@ public function testGetSearchCriteriaAnd()
             ->setCurrentPage(1)
             ->setPageSize(0)
             ->addSortOrder($sortOrder)
-            ->addFilter(
+            ->addFilters(
                 [
                     $this->filterBuilder->setField($fieldA)->setConditionType('gt')
                         ->setValue($value)->create(),
                 ]
             )
-            ->addFilter(
+            ->addFilters(
                 [
                     $this->filterBuilder->setField($fieldB)->setConditionType('gt')
                         ->setValue($value)->create(),

app/code/Magento/Multishipping/Block/Checkout/Address/Select.php

@@ -101,7 +101,7 @@ public function getAddress()
                     ->setConditionType('eq')
                     ->create();
                 $addresses = (array)($this->addressRepository->getList(
-                    $this->searchCriteriaBuilder->addFilter([$filter])->create()
+                    $this->searchCriteriaBuilder->addFilters([$filter])->create()
                 )->getItems());
             } catch (NoSuchEntityException $e) {
                 return [];

app/code/Magento/Multishipping/Controller/Checkout/Address/ShippingSaved.php

@@ -61,7 +61,7 @@ public function execute()
         $filter = $this->filterBuilder->setField('parent_id')->setValue($this->_getCheckout()->getCustomer()->getId())
             ->setConditionType('eq')->create();
         $addresses = (array)($this->addressRepository->getList(
-            $this->searchCriteriaBuilder->addFilter([$filter])->create()
+            $this->searchCriteriaBuilder->addFilters([$filter])->create()
         )->getItems());
 
         /**

app/code/Magento/Multishipping/Model/Checkout/Type/Multishipping.php

@@ -878,7 +878,7 @@ private function getDefaultAddressByDataKey($key, $defaultAddressIdFromCustomer)
                     ->setConditionType('eq')
                     ->create();
                 $addresses = (array)($this->addressRepository->getList(
-                    $this->searchCriteriaBuilder->addFilter([$filter])->create()
+                    $this->searchCriteriaBuilder->addFilters([$filter])->create()
                 )->getItems());
                 if ($addresses) {
                     $address = reset($addresses);

app/code/Magento/Multishipping/Test/Unit/Block/Checkout/Address/SelectTest.php

@@ -130,7 +130,7 @@ public function testGetAddress()
         $this->filterBuilderMock->expects($this->once())->method('create')->willReturn($this->filterMock);
         $this->searchCriteriaBuilderMock
             ->expects($this->once())
-            ->method('addFilter')
+            ->method('addFilters')
             ->with([$this->filterMock])
             ->willReturnSelf();
         $this->searchCriteriaBuilderMock
@@ -176,7 +176,7 @@ public function testGetAddressWhenItNotExistInCustomer()
         $this->filterBuilderMock->expects($this->once())->method('create')->willReturn($this->filterMock);
         $this->searchCriteriaBuilderMock
             ->expects($this->once())
-            ->method('addFilter')
+            ->method('addFilters')
             ->with([$this->filterMock])
             ->willReturnSelf();
         $this->searchCriteriaBuilderMock

app/code/Magento/Multishipping/Test/Unit/Controller/Checkout/Address/ShippingSavedTest.php

@@ -138,7 +138,7 @@ private function mockCustomerAddressRepository($customerId, array $addresses)
         $this->filterBuilderMock->expects($this->once())->method('create')->willReturn($filterMock);
 
         $searchCriteriaMock = $this->getMock('Magento\Framework\Api\SearchCriteria', [], [], '', false);
-        $this->criteriaBuilderMock->expects($this->once())->method('addFilter')->with([$filterMock])->willReturnSelf();
+        $this->criteriaBuilderMock->expects($this->once())->method('addFilters')->with([$filterMock])->willReturnSelf();
         $this->criteriaBuilderMock->expects($this->once())->method('create')->willReturn($searchCriteriaMock);
 
         $searchResultMock = $this->getMock('Magento\Customer\Api\Data\AddressSearchResultsInterface');

app/code/Magento/Multishipping/Test/Unit/Model/Checkout/Type/MultishippingTest.php

@@ -149,7 +149,7 @@ public function testSetShippingItemsInformation()
         $this->filterBuilderMock->expects($this->atLeastOnce())->method('create')->willReturnSelf();
 
         $searchCriteriaMock = $this->getMock('\Magento\Framework\Api\SearchCriteria', [], [], '', false);
-        $this->searchCriteriaBuilderMock->expects($this->atLeastOnce())->method('addFilter')->willReturnSelf();
+        $this->searchCriteriaBuilderMock->expects($this->atLeastOnce())->method('addFilters')->willReturnSelf();
         $this->searchCriteriaBuilderMock->expects($this->atLeastOnce())->method('create')
             ->willReturn($searchCriteriaMock);
 

app/code/Magento/Quote/Model/Quote.php

@@ -268,7 +268,7 @@ class Quote extends AbstractExtensibleModel implements \Magento\Quote\Api\Data\C
      *
      * @var \Magento\Framework\Api\SearchCriteriaBuilder
      */
-    protected $criteriaBuilder;
+    protected $searchCriteriaBuilder;
 
     /**
      * Filter builder
@@ -421,7 +421,7 @@ public function __construct(
         $this->_quotePaymentCollectionFactory = $quotePaymentCollectionFactory;
         $this->_objectCopyService = $objectCopyService;
         $this->addressRepository = $addressRepository;
-        $this->criteriaBuilder = $criteriaBuilder;
+        $this->searchCriteriaBuilder = $criteriaBuilder;
         $this->filterBuilder = $filterBuilder;
         $this->stockRegistry = $stockRegistry;
         $this->itemProcessor = $itemProcessor;

app/code/Magento/Sales/Block/Adminhtml/Order/Create/Form/Address.php

@@ -61,7 +61,7 @@ class Address extends \Magento\Sales\Block\Adminhtml\Order\Create\Form\AbstractF
      *
      * @var \Magento\Framework\Api\SearchCriteriaBuilder
      */
-    protected $criteriaBuilder;
+    protected $searchCriteriaBuilder;
 
     /**
      * Filter builder
@@ -121,7 +121,7 @@ public function __construct(
         $this->_customerFormFactory = $customerFormFactory;
         $this->_addressHelper = $addressHelper;
         $this->addressService = $addressService;
-        $this->criteriaBuilder = $criteriaBuilder;
+        $this->searchCriteriaBuilder = $criteriaBuilder;
         $this->filterBuilder = $filterBuilder;
         $this->addressMapper = $addressMapper;
         parent::__construct(
@@ -159,8 +159,8 @@ public function getAddressCollection()
                 ->setValue($this->getCustomerId())
                 ->setConditionType('eq')
                 ->create();
-            $this->criteriaBuilder->addFilter([$filter]);
-            $criteria = $this->criteriaBuilder->create();
+            $this->searchCriteriaBuilder->addFilters([$filter]);
+            $criteria = $this->searchCriteriaBuilder->create();
             $result = $this->addressService->getList($criteria);
             return $result->getItems();
         }

app/code/Magento/Sales/Model/Order/Payment/TransactionRepository.php

@@ -81,7 +81,7 @@ public function get($id)
         }
         if (!isset($this->registry[$id])) {
             $filter = $this->filterBuilder->setField('transaction_id')->setValue($id)->setConditionType('eq')->create();
-            $this->searchCriteriaBuilder->addFilter([$filter]);
+            $this->searchCriteriaBuilder->addFilters([$filter]);
             $this->find($this->searchCriteriaBuilder->create());
 
             if (!isset($this->registry[$id])) {

app/code/Magento/Sales/Model/Service/CreditmemoService.php

@@ -75,8 +75,8 @@ public function cancel($id)
      */
     public function getCommentsList($id)
     {
-        $this->searchCriteriaBuilder->addFilter(
-            ['eq' => $this->filterBuilder->setField('parent_id')->setValue($id)->create()]
+        $this->searchCriteriaBuilder->addFilters(
+            [$this->filterBuilder->setField('parent_id')->setValue($id)->setConditionType('eq')->create()]
         );
         $criteria = $this->searchCriteriaBuilder->create();
         return $this->creditmemoCommentRepository->getList($criteria);

app/code/Magento/Sales/Model/Service/InvoiceService.php

@@ -88,8 +88,8 @@ public function setCapture($id)
      */
     public function getCommentsList($id)
     {
-        $this->criteriaBuilder->addFilter(
-            ['eq' => $this->filterBuilder->setField('parent_id')->setValue($id)->create()]
+        $this->criteriaBuilder->addFilters(
+            [$this->filterBuilder->setField('parent_id')->setValue($id)->setConditionType('eq')->create()]
         );
         $criteria = $this->criteriaBuilder->create();
         return $this->commentRepository->getList($criteria);

app/code/Magento/Sales/Model/Service/OrderService.php

@@ -89,8 +89,8 @@ public function cancel($id)
      */
     public function getCommentsList($id)
     {
-        $this->criteriaBuilder->addFilter(
-            ['eq' => $this->filterBuilder->setField('parent_id')->setValue($id)->create()]
+        $this->criteriaBuilder->addFilters(
+            [$this->filterBuilder->setField('parent_id')->setValue($id)->setConditionType('eq')->create()]
         );
         $criteria = $this->criteriaBuilder->create();
         return $this->historyRepository->getList($criteria);

app/code/Magento/Sales/Model/Service/ShipmentService.php

@@ -88,8 +88,8 @@ public function getLabel($id)
      */
     public function getCommentsList($id)
     {
-        $this->criteriaBuilder->addFilter(
-            ['eq' => $this->filterBuilder->setField('parent_id')->setValue($id)->create()]
+        $this->criteriaBuilder->addFilters(
+            [$this->filterBuilder->setField('parent_id')->setValue($id)->setConditionType('eq')->create()]
         );
         $criteria = $this->criteriaBuilder->create();
         return $this->commentRepository->getList($criteria);

app/code/Magento/Sales/Test/Unit/Model/Order/Payment/TransactionRepositoryTest.php

@@ -112,7 +112,7 @@ public function testGet($id, array $collectionIds, $conditionType)
             ->method('getFilterGroups')
             ->willReturn([$filterGroup]);
         $this->searchCriteriaBuilder->expects($this->once())
-            ->method('addFilter')
+            ->method('addFilters')
             ->with([$filter]);
         $this->searchCriteriaBuilder->expects($this->once())
             ->method('create')

app/code/Magento/Sales/Test/Unit/Model/Service/CreditmemoServiceTest.php

@@ -63,14 +63,14 @@ protected function setUp()
         );
         $this->searchCriteriaBuilderMock = $this->getMock(
             'Magento\Framework\Api\SearchCriteriaBuilder',
-            ['create', 'addFilter'],
+            ['create', 'addFilters'],
             [],
             '',
             false
         );
         $this->filterBuilderMock = $this->getMock(
             'Magento\Framework\Api\FilterBuilder',
-            ['setField', 'setValue', 'create'],
+            ['setField', 'setValue', 'setConditionType', 'create'],
             [],
             '',
             false
@@ -150,12 +150,16 @@ public function testGetCommentsList()
             ->method('setValue')
             ->with($id)
             ->will($this->returnSelf());
+        $this->filterBuilderMock->expects($this->once())
+            ->method('setConditionType')
+            ->with('eq')
+            ->will($this->returnSelf());
         $this->filterBuilderMock->expects($this->once())
             ->method('create')
             ->will($this->returnValue($filterMock));
         $this->searchCriteriaBuilderMock->expects($this->once())
-            ->method('addFilter')
-            ->with(['eq' => $filterMock]);
+            ->method('addFilters')
+            ->with([$filterMock]);
         $this->searchCriteriaBuilderMock->expects($this->once())
             ->method('create')
             ->will($this->returnValue($searchCriteriaMock));