Your IP : 216.73.216.97
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\AdobeStockClient\Model;
use AdobeStock\Api\Core\Constants;
use AdobeStock\Api\Exception\StockApi;
use AdobeStock\Api\Models\SearchParameters;
use AdobeStock\Api\Models\StockFile;
use AdobeStock\Api\Request\License as LicenseRequest;
use AdobeStock\Api\Request\LicenseFactory as LicenseRequestFactory;
use AdobeStock\Api\Request\SearchFiles as SearchFilesRequest;
use AdobeStock\Api\Response\License;
use Magento\AdobeStockClientApi\Api\ClientInterface;
use Magento\AdobeStockClientApi\Api\Data\LicenseConfirmationInterface;
use Magento\AdobeStockClientApi\Api\Data\LicenseConfirmationInterfaceFactory;
use Magento\AdobeStockClientApi\Api\Data\UserQuotaInterface;
use Magento\AdobeStockClientApi\Api\Data\UserQuotaInterfaceFactory;
use Magento\Framework\Api\Search\SearchCriteriaInterface;
use Magento\Framework\Api\Search\SearchResultFactory;
use Magento\Framework\Api\Search\SearchResultInterface;
use Magento\Framework\Exception\IntegrationException;
use Magento\Framework\Locale\ResolverInterface as LocaleResolver;
use Psr\Log\LoggerInterface;
/**
* Client for communication to Adobe Stock API
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
class Client implements ClientInterface
{
/**
* @var SearchResultFactory
*/
private $searchResultFactory;
/**
* @var StockFileToDocument
*/
private $stockFileToDocument;
/**
* @var SearchParameterProviderInterface
*/
private $searchParametersProvider;
/**
* @var LocaleResolver
*/
private $localeResolver;
/**
* @var ConnectionWrapperFactory
*/
private $connectionFactory;
/**
* @var LicenseRequestFactory
*/
private $licenseRequestFactory;
/**
* @var LoggerInterface
*/
private $logger;
/**
* @var UserQuotaInterfaceFactory
*/
private $userQuotaFactory;
/**
* @var LicenseConfirmationInterfaceFactory
*/
private $licenseConfirmationFactory;
/**
* @var array
*/
private $searchResultFields;
/**
* @param ConnectionWrapperFactory $connectionFactory
* @param SearchResultFactory $searchResultFactory
* @param SearchParameterProviderInterface $searchParametersProvider
* @param LocaleResolver $localeResolver
* @param LicenseRequestFactory $licenseRequestFactory
* @param LoggerInterface $logger
* @param UserQuotaInterfaceFactory $userQuotaFactory
* @param StockFileToDocument $stockFileToDocument
* @param LicenseConfirmationInterfaceFactory $licenseConfirmationFactory
* @param array $searchResultFields
*/
public function __construct(
ConnectionWrapperFactory $connectionFactory,
SearchResultFactory $searchResultFactory,
SearchParameterProviderInterface $searchParametersProvider,
LocaleResolver $localeResolver,
LicenseRequestFactory $licenseRequestFactory,
LoggerInterface $logger,
UserQuotaInterfaceFactory $userQuotaFactory,
StockFileToDocument $stockFileToDocument,
LicenseConfirmationInterfaceFactory $licenseConfirmationFactory,
array $searchResultFields
) {
$this->connectionFactory = $connectionFactory;
$this->searchResultFactory = $searchResultFactory;
$this->searchParametersProvider = $searchParametersProvider;
$this->localeResolver = $localeResolver;
$this->licenseRequestFactory = $licenseRequestFactory;
$this->logger = $logger;
$this->userQuotaFactory = $userQuotaFactory;
$this->stockFileToDocument = $stockFileToDocument;
$this->licenseConfirmationFactory = $licenseConfirmationFactory;
$this->searchResultFields = $searchResultFields;
}
/**
* @inheritdoc
*/
public function search(SearchCriteriaInterface $searchCriteria): SearchResultInterface
{
$items = [];
$totalCount = 0;
$connection = $this->getConnection();
try {
$connection->searchFilesInitialize($this->getSearchRequest($searchCriteria));
$response = $connection->getNextResponse();
/** @var StockFile $file */
foreach ($response->getFiles() as $file) {
$items[] = $this->stockFileToDocument->convert($file);
}
$totalCount = $response->getNbResults();
} catch (IntegrationException $exception) {
$this->logger->critical($exception->getMessage());
}
$searchResult = $this->searchResultFactory->create();
$searchResult->setSearchCriteria($searchCriteria);
$searchResult->setItems($items);
$searchResult->setTotalCount($totalCount);
return $searchResult;
}
/**
* Generates license request
*
* @param int $contentId
* @return LicenseRequest
* @throws StockApi
*/
private function getLicenseRequest(int $contentId): LicenseRequest
{
$licenseRequest = $this->licenseRequestFactory->create();
$licenseRequest->setContentId($contentId)
->setLocale($this->localeResolver->getLocale())
->setLicenseState('STANDARD');
return $licenseRequest;
}
/**
* Get license information for the asset
*
* @param int $contentId
* @return License
* @throws IntegrationException
* @throws StockApi
*/
private function getLicenseInfo(int $contentId): License
{
return $this->getConnection()->getMemberProfile($this->getLicenseRequest($contentId));
}
/**
* @inheritdoc
*/
public function getQuota(): UserQuotaInterface
{
$quota = $this->getLicenseInfo(0)->getEntitlement()->getFullEntitlementQuota();
$userQuota = $this->userQuotaFactory->create();
$userQuota->setImages((int) $quota->standard_credits_quota);
$userQuota->setCredits((int) $quota->premium_credits_quota);
return $userQuota;
}
/**
* @inheritdoc
*/
public function getLicenseConfirmation(int $contentId): LicenseConfirmationInterface
{
$purchaseOptions = $this->getLicenseInfo($contentId)->getPurchaseOptions();
$message = $purchaseOptions->getMessage();
$canPurchase = $purchaseOptions->getPurchaseState() === 'possible';
$userQuota = $this->licenseConfirmationFactory->create();
$userQuota->setMessage($message);
$userQuota->setCanLicense($canPurchase);
return $userQuota;
}
/**
* @inheritdoc
*/
public function licenseImage(int $contentId): void
{
$this->getConnection()->getContentLicense($this->getLicenseRequest($contentId));
}
/**
* @inheritdoc
*/
public function getImageDownloadUrl(int $contentId): string
{
return $this->getConnection()->downloadAssetUrl($this->getLicenseRequest($contentId));
}
/**
* Create and return search request based on search criteria
*
* @param SearchCriteriaInterface $searchCriteria
* @return SearchFilesRequest
* @throws StockApi
*/
private function getSearchRequest(SearchCriteriaInterface $searchCriteria): SearchFilesRequest
{
$searchRequest = new SearchFilesRequest();
$searchRequest->setLocale($this->localeResolver->getLocale());
$searchRequest->setSearchParams(
$this->searchParametersProvider->apply($searchCriteria, new SearchParameters())
);
$searchRequest->setResultColumns($this->getResultColumns());
return $searchRequest;
}
/**
* Retrieve array of columns to be requested
*
* @return array
*/
private function getResultColumns(): array
{
$resultsColumns = Constants::getResultColumns();
$resultColumnArray = [];
foreach ($this->searchResultFields as $field) {
if (!isset($resultsColumns[$field])) {
$message = __('Cannot retrieve the field %1. It\'s not available in Adobe Stock SDK', $field);
$this->logger->critical($message);
}
$resultColumnArray[] = $resultsColumns[$field];
}
return $resultColumnArray;
}
/**
* Initialize connection to the Adobe Stock service.
*/
private function getConnection(): ConnectionWrapper
{
return $this->connectionFactory->create();
}
/**
* @inheritdoc
*/
public function testConnection(string $apiKey): bool
{
return $this->getConnection()->testApiKey($apiKey);
}
}