| Current Path : /home/rtorresani/www/vendor/magento/module-sales/Model/Order/ |
| Current File : //home/rtorresani/www/vendor/magento/module-sales/Model/Order/CreditmemoRepository.php |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Model\Order;
use Magento\Framework\Api\SearchCriteria\CollectionProcessorInterface;
use Magento\Framework\Exception\CouldNotDeleteException;
use Magento\Framework\Exception\CouldNotSaveException;
use Magento\Framework\Exception\InputException;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Sales\Api\Data\CreditmemoSearchResultInterfaceFactory as SearchResultFactory;
use Magento\Sales\Model\ResourceModel\Metadata;
/**
* Repository class for @see \Magento\Sales\Api\Data\CreditmemoInterface
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class CreditmemoRepository implements \Magento\Sales\Api\CreditmemoRepositoryInterface
{
/**
* @var Metadata
*/
protected $metadata;
/**
* @var SearchResultFactory
*/
protected $searchResultFactory = null;
/**
* \Magento\Sales\Api\Data\CreditmemoInterface[]
*
* @var array
*/
protected $registry = [];
/**
* @var \Magento\Framework\Api\SearchCriteria\CollectionProcessorInterface
*/
private $collectionProcessor;
/**
* CreditmemoRepository constructor.
* @param Metadata $metadata
* @param SearchResultFactory $searchResultFactory
* @param CollectionProcessorInterface|null $collectionProcessor
*/
public function __construct(
Metadata $metadata,
SearchResultFactory $searchResultFactory,
CollectionProcessorInterface $collectionProcessor = null
) {
$this->metadata = $metadata;
$this->searchResultFactory = $searchResultFactory;
$this->collectionProcessor = $collectionProcessor ?: $this->getCollectionProcessor();
}
/**
* Loads a specified credit memo.
*
* @param int $id The credit memo ID.
* @return \Magento\Sales\Api\Data\CreditmemoInterface Credit memo interface.
* @throws InputException
* @throws NoSuchEntityException
*/
public function get($id)
{
if (!$id) {
throw new InputException(__('An ID is needed. Set the ID and try again.'));
}
if (!isset($this->registry[$id])) {
/** @var \Magento\Sales\Api\Data\CreditmemoInterface $entity */
$entity = $this->metadata->getNewInstance()->load($id);
if (!$entity->getEntityId()) {
throw new NoSuchEntityException(
__("The entity that was requested doesn't exist. Verify the entity and try again.")
);
}
$this->registry[$id] = $entity;
}
return $this->registry[$id];
}
/**
* Create credit memo instance
*
* @return \Magento\Sales\Api\Data\CreditmemoInterface
*/
public function create()
{
return $this->metadata->getNewInstance();
}
/**
* Lists credit memos that match specified search criteria.
*
* @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria The search criteria.
* @return \Magento\Sales\Api\Data\CreditmemoSearchResultInterface Credit memo search result interface.
*/
public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria)
{
/** @var \Magento\Sales\Model\ResourceModel\Order\Creditmemo\Collection $searchResult */
$searchResult = $this->searchResultFactory->create();
$this->collectionProcessor->process($searchCriteria, $searchResult);
$searchResult->setSearchCriteria($searchCriteria);
return $searchResult;
}
/**
* Deletes a specified credit memo.
*
* @param \Magento\Sales\Api\Data\CreditmemoInterface $entity The credit memo.
* @return bool
* @throws CouldNotDeleteException
*/
public function delete(\Magento\Sales\Api\Data\CreditmemoInterface $entity)
{
try {
$this->metadata->getMapper()->delete($entity);
unset($this->registry[$entity->getEntityId()]);
} catch (\Exception $e) {
throw new CouldNotDeleteException(__("The credit memo couldn't be deleted."), $e);
}
return true;
}
/**
* Performs persist operations for a specified credit memo.
*
* @param \Magento\Sales\Api\Data\CreditmemoInterface $entity The credit memo.
* @return \Magento\Sales\Api\Data\CreditmemoInterface Credit memo interface.
* @throws CouldNotSaveException
*/
public function save(\Magento\Sales\Api\Data\CreditmemoInterface $entity)
{
try {
$this->metadata->getMapper()->save($entity);
$this->registry[$entity->getEntityId()] = $entity;
} catch (LocalizedException $e) {
throw new CouldNotSaveException(__($e->getMessage()), $e);
} catch (\Exception $e) {
throw new CouldNotSaveException(__("The credit memo couldn't be saved."), $e);
}
return $this->registry[$entity->getEntityId()];
}
/**
* Retrieve collection processor
*
* @deprecated 101.0.0
* @return CollectionProcessorInterface
*/
private function getCollectionProcessor()
{
if (!$this->collectionProcessor) {
$this->collectionProcessor = \Magento\Framework\App\ObjectManager::getInstance()->get(
\Magento\Framework\Api\SearchCriteria\CollectionProcessorInterface::class
);
}
return $this->collectionProcessor;
}
}