SearchCriteriaBuilder.php 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Framework\Api;
  7. use Magento\Framework\Api\Search\FilterGroupBuilder;
  8. /**
  9. * Builder for SearchCriteria Service Data Object
  10. */
  11. class SearchCriteriaBuilder extends AbstractSimpleObjectBuilder
  12. {
  13. /**
  14. * @var FilterGroupBuilder
  15. */
  16. protected $_filterGroupBuilder;
  17. /**
  18. * @var \Magento\Framework\Api\FilterBuilder
  19. */
  20. protected $filterBuilder;
  21. /**
  22. * @param ObjectFactory $objectFactory
  23. * @param FilterGroupBuilder $filterGroupBuilder
  24. * @param FilterBuilder $filterBuilder
  25. */
  26. public function __construct(
  27. ObjectFactory $objectFactory,
  28. FilterGroupBuilder $filterGroupBuilder,
  29. FilterBuilder $filterBuilder
  30. ) {
  31. parent::__construct(
  32. $objectFactory
  33. );
  34. $this->_filterGroupBuilder = $filterGroupBuilder;
  35. $this->filterBuilder = $filterBuilder;
  36. }
  37. /**
  38. * Builds the SearchCriteria Data Object
  39. *
  40. * @return SearchCriteria
  41. */
  42. public function create()
  43. {
  44. //Initialize with empty array if not set
  45. if (empty($this->data[SearchCriteria::FILTER_GROUPS])) {
  46. $this->_set(SearchCriteria::FILTER_GROUPS, []);
  47. }
  48. return parent::create();
  49. }
  50. /**
  51. * Create a filter group based on the filter array provided and add to the filter groups
  52. *
  53. * @param \Magento\Framework\Api\Filter[] $filter
  54. * @return $this
  55. */
  56. public function addFilters(array $filter)
  57. {
  58. $this->data[SearchCriteria::FILTER_GROUPS][] = $this->_filterGroupBuilder->setFilters($filter)->create();
  59. return $this;
  60. }
  61. /**
  62. * @param string $field
  63. * @param mixed $value
  64. * @param string $conditionType
  65. * @return $this
  66. */
  67. public function addFilter($field, $value, $conditionType = 'eq')
  68. {
  69. $this->addFilters([
  70. $this->filterBuilder->setField($field)
  71. ->setValue($value)
  72. ->setConditionType($conditionType)
  73. ->create()
  74. ]);
  75. return $this;
  76. }
  77. /**
  78. * Set filter groups
  79. *
  80. * @param \Magento\Framework\Api\Search\FilterGroup[] $filterGroups
  81. * @return $this
  82. */
  83. public function setFilterGroups(array $filterGroups)
  84. {
  85. return $this->_set(SearchCriteria::FILTER_GROUPS, $filterGroups);
  86. }
  87. /**
  88. * Add sort order
  89. *
  90. * @param SortOrder $sortOrder
  91. * @return $this
  92. */
  93. public function addSortOrder($sortOrder)
  94. {
  95. if (!isset($this->data[SearchCriteria::SORT_ORDERS])) {
  96. $this->data[SearchCriteria::SORT_ORDERS] = [];
  97. }
  98. $this->data[SearchCriteria::SORT_ORDERS][] = $sortOrder;
  99. return $this;
  100. }
  101. /**
  102. * Set sort orders
  103. *
  104. * @param SortOrder[] $sortOrders
  105. * @return $this
  106. */
  107. public function setSortOrders(array $sortOrders)
  108. {
  109. return $this->_set(SearchCriteria::SORT_ORDERS, $sortOrders);
  110. }
  111. /**
  112. * Set page size
  113. *
  114. * @param int $pageSize
  115. * @return $this
  116. */
  117. public function setPageSize($pageSize)
  118. {
  119. return $this->_set(SearchCriteria::PAGE_SIZE, $pageSize);
  120. }
  121. /**
  122. * Set current page
  123. *
  124. * @param int $currentPage
  125. * @return $this
  126. */
  127. public function setCurrentPage($currentPage)
  128. {
  129. return $this->_set(SearchCriteria::CURRENT_PAGE, $currentPage);
  130. }
  131. }