Mfrhtyj

I built Magento 2 Module which has a model and Service contracts/API.

During this implementation, I have followed vinai Kopp article and also magento2 module Magento_Quote.

On this MagentoQuoteModelQuoteRepository, i have found two classes

MagentoFrameworkApiExtensionAttributeJoinProcessorInterface;

MagentoFrameworkApiSearchCriteriaCollectionProcessorInterface;

And found that during the implementation of getList() this two classes used

   this->collectionProcessor->process($searchCriteria, $this->quoteCollection);

  $this->extensionAttributesJoinProcessor->process($this->quoteCollection)

MY repository class

<?php

namespace DevamitberaProductSuggestionModel;



use DevamitberaProductSuggestionApiDataProductSuggestionInterface;

use MagentoFrameworkApiSearchCriteriaInterface;

use MagentoFrameworkApiSearchCriteriaCollectionProcessorInterface;

use MagentoFrameworkApiExtensionAttributeJoinProcessorInterface;

use DevamitberaProductSuggestionApiProductSuggestionRepositoryInterface;

use DevamitberaProductSuggestionModelProductSuggestionFactory;

use DevamitberaProductSuggestionModelResourceModelProductSuggestion as ProductSuggestionResource;

use DevamitberaProductSuggestionModelResourceModelProductSuggestionCollectionFactory as ProductSuggestionCollectionFactory ;

use MagentoFrameworkExceptionNotFoundException;

use MagentoFrameworkExceptionCouldNotSaveException;

use DevamitberaProductSuggestionApiDataProductSuggestionSearchResultInterfaceFactory;





/**

 * Repository class 

 */



class ProductSuggestionRepository  implements ProductSuggestionRepositoryInterface 

{



    /**

     * @var MagentoFrameworkApiExtensionAttributeJoinProcessorInterface

     */

    protected $extensionAttributesJoinProcessor;



    /**

     * @var MagentoFrameworkApiSearchCriteriaCollectionProcessorInterface

     */

    protected $collectionProcessor;



    /**

     * @var DevamitberaProductSuggestionApiDataProductSuggestionSearchResultInterfaceFactory

     */

    protected $productSuggestionSearchResultFactory;



    /**

     * @var DevamitberaProductSuggestionModelProductSuggestionFactory

     */

    protected $productSuggestionFactory;



    /**

     * @var DevamitberaProductSuggestionModelResourceModelProductSuggestion

     */

    protected $productSuggestionResource;



    /**

     * @var DevamitberaProductSuggestionModelResourceModelProductSuggestionCollectionFactory

     */

    protected $collectionFactory;



    public function __construct(

        ProductSuggestionFactory $productSuggestionFactory,

        ProductSuggestionResource $productSuggestionResource,

        ProductSuggestionCollectionFactory $CollectionFactory,

        ProductSuggestionSearchResultInterfaceFactory $productSuggestionSearchResultFactory,

        CollectionProcessorInterface  $collectionProcessor,

        JoinProcessorInterface  $extensionAttributesJoinProcessor    

    ) 

    {



        $this->collectionFactory = $CollectionFactory;

        $this->productSuggestionResource = $productSuggestionResource;

        $this->productSuggestionFactory = $productSuggestionFactory;



        $this->productSuggestionSearchResultFactory = $productSuggestionSearchResultFactory;

        $this->collectionProcessor = $collectionProcessor ?: MagentoFrameworkAppObjectManager::getInstance()

            ->get(MagentoFrameworkApiSearchCriteriaCollectionProcessor::class);;

        $this->extensionAttributesJoinProcessor = $extensionAttributesJoinProcessor;

    }

     /**

     * {@inheritdoc}

     */

    public function delete(ProductSuggestionInterface $productSuggestion){

        $this->productSuggestionResource->delete($productSuggestion);

    }

    /**

     * {@inheritdoc}

     */

    public function getById($id){



        $productSuggestion = $this->productSuggestionFactory->create();

        $this->productSuggestionResource->load($productSuggestion, $id);

        if(!$productSuggestion->getId()){

            throw new NotFoundException(__('unable to find the record'));

        }

        return $productSuggestion;

    }

    /**

     * {@inheritdoc}

     */

    public function getList(SearchCriteriaInterface $searchCriteria){



        $collection = $this->collectionFactory->create();



        $searchData = $this->productSuggestionSearchResultFactory->create();

        $searchData->setSearchCriteria($searchCriteria);



        $this->collectionProcessor->process($searchCriteria, $collection);

        // $this->extensionAttributesJoinProcessor->process($collection ,null)

        $this->extensionAttributesJoinProcessor->process($collection);



        $searchData->setItems($this->quoteCollection->getItems());

        $searchData->setTotalCount($this->quoteCollection->getSize());

        return $searchData;        

    }

    /**

     * {@inheritdoc}

     */

    public function save(ProductSuggestionInterface $productSuggestion){

        try{

          $this->productSuggestionResource->save($productSuggestion);  

        } catch (Exception $exception) {

            throw  new CouldNotSaveException(__($exception->getMessage()));

        }



        return $productSuggestion;

    }



}

Now, i want to know,

• why do this two classes use?


• Do I need this classes when I will implement Service contracts/API ?

As I know
Yes, for Service contracts/API you have to use this both classes.

why do this two classes use?

It will useful in api for retrieve data, CollectionProcessorInterface class is used for retrieving data with where condition $searchCriteria and JoinProcessorInterface is used for retrieving custom_attribute_fields on api call time.

Do I need this classes when I will implement Service contracts/API ?

MagentoFrameworkApiSearchCriteriaCollectionProcessorInterface

This class is used for get listing with seach criteria in your api(like where condition).

MagentoFrameworkApiExtensionAttributeJoinProcessorInterface

This class is retrieve custom_checkout_field on api select, which is defined in extension_attributes.xml