{"id":16335,"date":"2018-07-24T14:20:06","date_gmt":"2018-07-24T12:20:06","guid":{"rendered":"https:\/\/belvg.com\/blog\/?p=16335"},"modified":"2021-02-18T13:58:07","modified_gmt":"2021-02-18T11:58:07","slug":"how-to-use-data-related-classes-repositories-and-data-api-in-magento-2","status":"publish","type":"post","link":"https:\/\/belvg.com\/blog\/how-to-use-data-related-classes-repositories-and-data-api-in-magento-2.html","title":{"rendered":"How to Use Data-related Classes, Repositories and Data API in Magento 2"},"content":{"rendered":"\n

This is Part 1 of the series of articles dedicated to using data-related classes, repositories and data API in Magento 2. Today we will touch upon two questions: obtaining an object or set of objects from the database using a repository and configuring and creating a SearchCriteria instance using the builder.<\/span><\/p>\n

<\/p>\n

Obtaining an object or set of objects from the database using a repository<\/span><\/strong><\/h2>\n

To work with collections in Magento 2, you can use a repository that implements the same repository pattern. The Repository pattern allows working with collections as entities, regardless of their storage location (storage or caching are implementation details). The pattern itself is located between the Domain and the Service Level.<\/p>\n

In Magento 2, there are usually 5 basic functions of the repository: save, getById, getList, delete, deleteById. But each Repository implementation in Magento has its own interface and these functions are not always implemented in it. For example, in Magento\\Quote\\Api\\GuestCartTotalRepositoryInterface<\/em>, only the get($cartId)<\/strong> method is implemented. Therefore, it is better to pay attention to the implementation of a particular Repository class.<\/p>\n

Let’s take a look at the Repository using the example of \\Magento\\Catalog\\Api\\ProductRepositoryInterface<\/em> and its implementation \\Magento\\Catalog\\Model\\ProductRepository.<\/em><\/p>\n

<?php\r\nnamespace Magento\\Catalog\\Api;\r\ninterface ProductRepositoryInterface\r\n{\r\n   public function save(\\Magento\\Catalog\\Api\\Data\\ProductInterface $product, $saveOptions = false);\r\n   public function get($sku, $editMode = false, $storeId = null, $forceReload = false);\r\n   public function getById($productId, $editMode = false, $storeId = null, $forceReload = false);\r\n   public function delete(\\Magento\\Catalog\\Api\\Data\\ProductInterface $product);\r\n   public function deleteById($sku);\r\n   public function getList(\\Magento\\Framework\\Api\\SearchCriteriaInterface $searchCriteria);\r\n}<\/pre>\n
Here all 5 basic functions for working with Repository are implemented. Meanwhile, the main class when working with a product is \\Magento\\Catalog\\Api\\Data\\ProductInterface<\/em>, which allows you to save all products inherited from this class, regardless of their type.<\/p>\n
Let’s look at the implementation of the getById<\/strong> method:<\/p>\n
<?php\r\n…\r\nprotected $productRepository;\r\npublic function __construct(\r\n…\r\n\\Magento\\Catalog\\Api\\ProductRepositoryInterface $productRepository)\r\n{\r\n$this->productRepository = $productRepository;\r\n}\r\n...\r\npublic function someMethod() {\r\n$product = $this->productRepository->getById(1);\r\nreturn $product->getSku();\r\n}\r\n…\r\n...\r\npublic function someDeleteMethod() {\r\n$this->productRepository->deleteById(1);\r\n}\r\n…<\/pre>\n
Here we implement the work with ProductRepository<\/em>, extracting the object with id 1 and returning its SKU. Similarly, the deleteById<\/strong> method will be implemented. In the constructor, as you can see, we create \\Magento\\Catalog\\Api\\ProductRepositoryInterface<\/em>, and not \\Magento\\Catalog\\Model\\ProductRepository<\/em> itself. These dependencies are described in the di.xml<\/strong> file. For example, for the current class, the dependency is described in vendor\/magento\/module-catalog\/etc\/di.xml<\/em> and looks like this:<\/p>\n
<preference for=\"Magento\\Catalog\\Api\\ProductRepositoryInterface\" type=\"Magento\\Catalog\\Model\\ProductRepository\" \/>\r\nHere is the implementation of the save method:\r\n...\r\npublic function someMethod() {\r\n$product = $this->productRepository->getById(1);\r\n$product->setSku(‘test-sku-1’);\r\n$this->productRepository->save($product);\r\n}\r\n…\r\n...\r\npublic function someDeleteMethod() {\r\n$product = $this->productRepository->getById(1);\r\n$this->productRepository->delete($product);\r\n}\r\n…<\/pre>\n
Here we have changed the SKU of the product and saved it using the save repository method. The delete<\/strong> method works similarly (but with the opposite result).<\/p>\n
Configuring and creating a SearchCriteria instance using the builder<\/span><\/strong><\/h2>\n
The getList<\/strong> method, in this context, is implemented using SearchCriteriaInterface<\/em>. This interface implements the conditions for queries (for example, in MySQL this is where<\/strong> in the query). All conditions are divided into Filter<\/strong> and FilterGroup<\/strong>.<\/p>\n
\"Filter<\/a><\/p>\n
We implement the abovementioned conditions using SearchCriteria:<\/p>\n
public function someMethod() {\r\n$filter = $this->objectManager->create('Magento\\Framework\\Api\\Filter');\r\n$filter->setField(‘sku’);\r\n$filter->setValue(‘test-%’);\r\n$filter->setConditionType(‘like’);\r\n$filter2 = $this->objectManager->create('Magento\\Framework\\Api\\Filter');\r\n$filter2->setField(‘sku’);\r\n$filter2->setValue(‘%-product’);\r\n$filter2->setConditionType(‘like’);\r\n$filterGroup = $this->objectManager->create('Magento\\Framework\\Api\\Search\\FilterGroup');\r\n$filterGroup>setFilters([$filter, $filter2]);\r\n$filter3 = $this->objectManager->create('Magento\\Framework\\Api\\Filter');\r\n$filter3->setField(‘price’);\r\n$filter3->setValue(‘100’);\r\n$filter3->setConditionType(‘eq’);\r\n$filterGroup2 = $this->objectManager->create('Magento\\Framework\\Api\\Search\\FilterGroup');\r\n$filterGroup2>setFilters([$filter3]);\r\n$searchCriteria- = $this->objectManager->create('Magento\\Framework\\Api\\SearchCriteriaInterface');\r\n$searchCriteria->setFilterGroups([$filterGroup, $filterGroup2]);\r\n$result = $this->productRepository>getList($searchCriteria-);\r\nreturn $result->getItems();\r\n}<\/pre>\n
This example returns an array of objects inherited from \\Magento\\Catalog\\Api\\Data\\ProductInterface.<\/em><\/span><\/p>\n
This is the end of part 1 of the series dedicated to data-related classes, repositories and data API in Magento 2. The other parts are coming up soon, stay tuned.<\/p>\n\n","protected":false},"excerpt":{"rendered":"Data-related Classes, Repositories and Data API in Magento 2: Part 1","protected":false},"author":82,"featured_media":16340,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"image","meta":{"_acf_changed":false,"footnotes":""},"categories":[491,389],"tags":[],"class_list":["post-16335","post","type-post","status-publish","format-image","has-post-thumbnail","hentry","category-magento-2","category-magento2-development","post_format-post-format-image"],"acf":[],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t