1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55:
56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559: 560: 561: 562: 563: 564: 565: 566: 567: 568: 569: 570: 571: 572: 573: 574: 575: 576: 577: 578: 579: 580: 581: 582: 583: 584: 585: 586: 587: 588: 589: 590: 591: 592: 593: 594: 595:
<?php
namespace Affilinet\ProductData\Requests;
use Affilinet\ProductData\Exceptions\AffilinetProductWebserviceException;
use Affilinet\ProductData\Requests\Helper\QueryInterface;
use Affilinet\ProductData\Requests\Traits\ImageTrait;
use Affilinet\ProductData\Requests\Traits\LogoTrait;
use Affilinet\ProductData\Requests\Traits\PaginationTrait;
use Affilinet\ProductData\Responses\ProductsResponse;
use Affilinet\ProductData\Responses\ProductsResponseInterface;
use Affilinet\ProductData\Responses\ResponseElements\CategoryInterface;
use Affilinet\ProductData\Responses\ResponseElements\Product;
use Affilinet\ProductData\Responses\ResponseElements\ShopInterface;
use \GuzzleHttp\Psr7\Request;
class ProductsRequest extends AbstractRequest implements ProductsRequestInterface
{
use ImageTrait, LogoTrait, PaginationTrait;
const ENDPOINT = 'https://product-api.affili.net/V3/productservice.svc/JSON/SearchProducts';
const ENDPOINT_ALTERNATE = 'https://product-api.affili.net/V3/productservice.svc/JSON/GetProducts';
const SORT_BY_RELEVANCE = 'Score';
const SORT_BY_PRICE = 'Price';
const SORT_BY_PRODUCT_NAME = 'ProductName';
const SORT_BY_LAST_PROGRAM_LIST_UPDATE = 'LastImported';
private $useAlternateEndpoint = false;
public function findOne($productId)
{
$this->useAlternateEndpoint = true;
$this->queryParams['ProductIds'] = $productId;
$this->addAllProductImages();
$this->addAllShopLogos();
$response = $this->send();
$products = $response->getProducts();
if (isset($products[0])) {
return $products[0];
}
return null;
}
public function send()
{
if (
!isset($this->queryParams['FQ']) &&
!isset($this->queryParams['CategoryIds']) &&
!isset($this->queryParams['Query']) &&
!isset($this->queryParams['ProductIds'])
) {
throw new AffilinetProductWebserviceException('FilterQuery, Category or Query must be set in request.');
}
$psr7Request = $this->getPsr7Request();
$psr7Response = $this->getAffilinetClient()->getHttpClient()->send($psr7Request);
$searchProductsResponse = new ProductsResponse($psr7Response);
return $searchProductsResponse;
}
public function getPsr7Request()
{
return new Request('GET', $this->getEndpoint() . '?' . $this->serializeWithCredentials());
}
public function getEndpoint()
{
return $this->useAlternateEndpoint ? self::ENDPOINT_ALTERNATE : self::ENDPOINT;
}
public function find(array $productIds)
{
$this->useAlternateEndpoint = true;
if (count($productIds) > 50) {
throw new \OverflowException('You can only add up to 50 productIds to one GetProductsRequest');
}
$this->queryParams['ProductIds'] = implode(',', $productIds);
$this->addAllProductImages()
->addAllShopLogos();
return $this->send();
}
public function excludeShopIds(array $shopIDs)
{
if (isset($this->queryParams['ShopIdMode']) && $this->queryParams['ShopIdMode'] === 'Include') {
throw new AffilinetProductWebserviceException('excludeShopIds() can not be combined with onlyFromShopIds() in one ProductsRequest');
}
$this->queryParams['ShopIds'] = $this->getShopIdCSV($shopIDs);
$this->queryParams['ShopIdMode'] = 'Exclude';
return $this;
}
private function getShopIdCSV(array $shopIDs)
{
if (empty($shopIDs)) {
throw new \InvalidArgumentException('Parameter $shopIDs has to be an array and must not be empty');
}
foreach ($shopIDs as $key => $id) {
if (!is_numeric($id) && $id !== 0) {
throw new \InvalidArgumentException('The value "' . $id . '" is not a valid shopId, shopIds have to be integer. "');
}
$shopIDs[$key] = trim($id);
}
if (count($shopIDs) > 500) {
$this->affilinetClient->getLog()->warning('Some shopIds have been ignored: You can include or exclude only a maximum of 500 shops.');
}
return implode(',', $shopIDs);
}
public function onlyFromShop(ShopInterface $shop)
{
$this->onlyFromShopIds([$shop->getId()]);
return $this;
}
public function onlyFromShopIds(array $shopIDs)
{
if (isset($this->queryParams['ShopIdMode']) && $this->queryParams['ShopIdMode'] === 'Exclude') {
throw new AffilinetProductWebserviceException('onlyFromShopIds() can not be combined with excludeShopIds() in one ProductsRequest');
}
$this->queryParams['ShopIds'] = $this->getShopIdCSV($shopIDs);
$this->queryParams['ShopIdMode'] = 'Include';
return $this;
}
public function onlyFromShops(array $shops)
{
$ids = [];
foreach ($shops as $shop) {
$ids[] = $shop->getId();
}
$this->onlyFromShopIds($ids);
return $this;
}
public function onlyFromShopCategory(CategoryInterface $category)
{
$this->onlyFromCategories([$category->getId()], false, false);
return $this;
}
public function onlyFromCategories(array $categoryIds, $excludeSubCategories = false, $useAffilinetCategories = true)
{
$this->queryParams['CategoryIds'] = $this->getCategoryIdCSV($categoryIds);
$this->queryParams['ExcludeSubCategories'] = ($excludeSubCategories) ? 'true' : 'false';
$this->queryParams['UseAffilinetCategories'] = ($useAffilinetCategories) ? 'true' : 'false';
return $this;
}
private function getCategoryIdCSV(array $categoryIds)
{
if (empty($categoryIds)) {
throw new \InvalidArgumentException('$categoryIds has to be an array and must not be empty');
}
foreach ($categoryIds as $key => $id) {
if ($id != intval($id) || intval($id) === 0) {
throw new \InvalidArgumentException('The value "' . $id . '" is not a valid categoryId, categoryId have to be integer values greater than 0. "');
}
$categoryIds[$key] = trim($id);
}
if (count($categoryIds) > 100) {
throw new \OverflowException('Too many categories. You can filter to only a maximum of 100 categoryIds');
}
return implode(',', $categoryIds);
}
public function onlyFromShopCategories(array $categories)
{
$ids = [];
foreach ($categories as $category) {
$ids[] = $category->getId();
}
$this->onlyFromCategories($ids, false, false);
return $this;
}
public function onlyWithImage($withImageOnly = true)
{
$this->addProductImage();
$this->queryParams['WithImageOnly'] = ($withImageOnly) ? 'true' : 'false';
return $this;
}
public function sort($sortBy = 'Score', $descending = true)
{
switch ($sortBy) {
case self::SORT_BY_RELEVANCE :
case self::SORT_BY_PRICE :
case self::SORT_BY_PRODUCT_NAME :
case self::SORT_BY_LAST_PROGRAM_LIST_UPDATE :
break;
default:
throw new \InvalidArgumentException('Invalid argument $sortBy with value of "' . $sortBy . '"". Use one of ' .
self::SORT_BY_RELEVANCE . ', ' .
self::SORT_BY_PRICE . ', ' .
self::SORT_BY_PRODUCT_NAME . ' or ' .
self::SORT_BY_LAST_PROGRAM_LIST_UPDATE . '! Think about using the class constants in ' . __CLASS__ . '::SORT_BY_(...)');
}
$this->queryParams['SortBy'] = $sortBy;
$this->queryParams['SortOrder'] = ($descending) ? 'descending' : 'ascending';
return $this;
}
public function minPrice($price)
{
$this->queryParams['MinimumPrice'] = $this->sanitizePrice($price);
return $this;
}
private function sanitizePrice($price)
{
if (is_float($price)) {
$floatPrice = $price;
} elseif (is_int($price)) {
$floatPrice = (float) $price;
} elseif (is_string($price)) {
if (!is_numeric($price) || mb_strpos($price, ',') !== false) {
throw new \InvalidArgumentException('Parameter $price must be numeric. Do not use thousand separators. Use a point (.) as decimal separator. Example "10.00"');
}
$floatPrice = (float) $price;
} else {
throw new \InvalidArgumentException('Parameter $price must be numeric. Do not use thousand separators. Use a point (.) as decimal separator. Example "10.00"');
}
return number_format((float) $floatPrice, 2, '.', '');
}
public function maxPrice($price)
{
$this->queryParams['MaximumPrice'] = $this->sanitizePrice($price);
return $this;
}
private function addFacet($facetName, $facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT)
{
if (!isset($this->queryParams['FacetFields'])) {
$facetFields = [];
} else {
$facetFields = explode(',', $this->queryParams['FacetFields']);
}
if (!in_array($facetName, $facetFields)) {
$facetFields[] = $facetName;
if (count($facetFields) > 4) {
throw new \OverflowException('You can only add up to 4 facets to one ProductsRequest');
}
$this->queryParams['FacetFields'] = implode(',', $facetFields);
}
$this->queryParams['FacetValueLimit'] = $facetValueLimit;
return $this;
}
public function addFacetArticleNumber($facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT)
{
$this->addFacet('ArticleNumber', $facetValueLimit);
return $this;
}
public function addFacetBrand($facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT)
{
$this->addFacet('Brand', $facetValueLimit);
return $this;
}
public function addFacetDistributor($facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT)
{
$this->addFacet('Distributor', $facetValueLimit);
return $this;
}
public function addFacetEAN($facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT)
{
$this->addFacet('EAN', $facetValueLimit);
return $this;
}
public function addFacetManufacturer($facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT)
{
$this->addFacet('Manufacturer', $facetValueLimit);
return $this;
}
public function addFacetProgramId($facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT)
{
$this->getAffilinetClient()->getLog()->addDebug('Method addFacetProgramId is deprecated');
$this->addFacet('ProgramId', $facetValueLimit);
return $this;
}
public function addFacetShopId($facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT)
{
$this->addFacet('ShopId', $facetValueLimit);
return $this;
}
public function addFacetShopName($facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT)
{
$this->getAffilinetClient()->getLog()->addDebug('Method addFacetShopName is deprecated');
$this->addFacet('ShopName', $facetValueLimit);
return $this;
}
public function addFacetAffilinetCategoryId($facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT)
{
$this->addFacet('AffilinetCategoryId', $facetValueLimit);
return $this;
}
public function addFacetAffilinetCategoryPath($facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT)
{
$this->addFacet('AffilinetCategoryPathFacet', $facetValueLimit);
return $this;
}
public function addFacetShopCategoryId($facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT)
{
$this->addFacet('ShopCategoryId', $facetValueLimit);
return $this;
}
public function addFacetShopCategoryPath($facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT)
{
$this->addFacet('ShopCategoryPathFacet', $facetValueLimit);
return $this;
}
public function addRawQuery($query)
{
$this->queryParams['Query'] = $query;
return $this;
}
public function query(QueryInterface $query)
{
$this->queryParams['Query'] = $query->getQuery() ;
return $this;
}
public function addFilterQuery($name, $value)
{
if (!isset($this->queryParams['FQ'])) {
$this->queryParams['FQ'] = $name . ':' . $value;
} else {
$existingFilterQuery = explode(',', $this->queryParams['FQ']);
foreach ($existingFilterQuery as $oneFilterQuery) {
$oneFilterQueryArray = explode(':', $oneFilterQuery);
if ($oneFilterQueryArray[0] === $name) {
$this->affilinetClient->getLog()->addWarning('You tried to add the FilterQuery' . $name .' twice. The value "' . $value . '" has been ignored.');
return $this;
}
}
$this->queryParams['FQ'] .= ',' . $name . ':' . $value;
}
return $this;
}
}