CatalogQuery.php — WooCommerce Square 2.2.5

woocommerce-square / vendor / square / connect / lib / Model / CatalogQuery.php

woocommerce-square / vendor / square / connect / lib / Model Last commit date

CatalogQuery.php

411 lines

1	<?php
2	/**
3	* NOTE: This class is auto generated by the swagger code generator program.
4	* https://github.com/swagger-api/swagger-codegen
5	* Do not edit the class manually.
6	*/
7
8	namespace SquareConnect\Model;
9
10	use \ArrayAccess;
11	/**
12	* CatalogQuery Class Doc Comment
13	*
14	* @category Class
15	* @package SquareConnect
16	* @author Square Inc.
17	* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License v2
18	* @link https://squareup.com/developers
19	*/
20	class CatalogQuery implements ArrayAccess
21	{
22	/**
23	* Array of property to type mappings. Used for (de)serialization
24	* @var string[]
25	*/
26	static $swaggerTypes = array(
27	'sorted_attribute_query' => '\SquareConnect\Model\CatalogQuerySortedAttribute',
28	'exact_query' => '\SquareConnect\Model\CatalogQueryExact',
29	'prefix_query' => '\SquareConnect\Model\CatalogQueryPrefix',
30	'range_query' => '\SquareConnect\Model\CatalogQueryRange',
31	'text_query' => '\SquareConnect\Model\CatalogQueryText',
32	'items_for_tax_query' => '\SquareConnect\Model\CatalogQueryItemsForTax',
33	'items_for_modifier_list_query' => '\SquareConnect\Model\CatalogQueryItemsForModifierList',
34	'items_for_item_options_query' => '\SquareConnect\Model\CatalogQueryItemsForItemOptions',
35	'item_variations_for_item_option_values_query' => '\SquareConnect\Model\CatalogQueryItemVariationsForItemOptionValues'
36	);
37
38	/**
39	* Array of attributes where the key is the local name, and the value is the original name
40	* @var string[]
41	*/
42	static $attributeMap = array(
43	'sorted_attribute_query' => 'sorted_attribute_query',
44	'exact_query' => 'exact_query',
45	'prefix_query' => 'prefix_query',
46	'range_query' => 'range_query',
47	'text_query' => 'text_query',
48	'items_for_tax_query' => 'items_for_tax_query',
49	'items_for_modifier_list_query' => 'items_for_modifier_list_query',
50	'items_for_item_options_query' => 'items_for_item_options_query',
51	'item_variations_for_item_option_values_query' => 'item_variations_for_item_option_values_query'
52	);
53
54	/**
55	* Array of attributes to setter functions (for deserialization of responses)
56	* @var string[]
57	*/
58	static $setters = array(
59	'sorted_attribute_query' => 'setSortedAttributeQuery',
60	'exact_query' => 'setExactQuery',
61	'prefix_query' => 'setPrefixQuery',
62	'range_query' => 'setRangeQuery',
63	'text_query' => 'setTextQuery',
64	'items_for_tax_query' => 'setItemsForTaxQuery',
65	'items_for_modifier_list_query' => 'setItemsForModifierListQuery',
66	'items_for_item_options_query' => 'setItemsForItemOptionsQuery',
67	'item_variations_for_item_option_values_query' => 'setItemVariationsForItemOptionValuesQuery'
68	);
69
70	/**
71	* Array of attributes to getter functions (for serialization of requests)
72	* @var string[]
73	*/
74	static $getters = array(
75	'sorted_attribute_query' => 'getSortedAttributeQuery',
76	'exact_query' => 'getExactQuery',
77	'prefix_query' => 'getPrefixQuery',
78	'range_query' => 'getRangeQuery',
79	'text_query' => 'getTextQuery',
80	'items_for_tax_query' => 'getItemsForTaxQuery',
81	'items_for_modifier_list_query' => 'getItemsForModifierListQuery',
82	'items_for_item_options_query' => 'getItemsForItemOptionsQuery',
83	'item_variations_for_item_option_values_query' => 'getItemVariationsForItemOptionValuesQuery'
84	);
85
86	/**
87	* $sorted_attribute_query A query that returns all objects, sorted by the given attribute.
88	* @var \SquareConnect\Model\CatalogQuerySortedAttribute
89	*/
90	protected $sorted_attribute_query;
91	/**
92	* $exact_query A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive value.
93	* @var \SquareConnect\Model\CatalogQueryExact
94	*/
95	protected $exact_query;
96	/**
97	* $prefix_query A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix.
98	* @var \SquareConnect\Model\CatalogQueryPrefix
99	*/
100	protected $prefix_query;
101	/**
102	* $range_query A query that returns only objects for which the given (integer-valued) attribute lies in the given range.
103	* @var \SquareConnect\Model\CatalogQueryRange
104	*/
105	protected $range_query;
106	/**
107	* $text_query A query that returns only objects whose searchable attributes contain all of the given keywords as prefixes. For example, if a [CatalogItem](#type-catalogitem) contains attributes `{\"name\": \"t-shirt\"}` and `{\"description\": \"Small, Purple\"}`, it will be matched by the query `{\"keywords\": [\"shirt\", \"sma\", \"purp\"]}`.
108	* @var \SquareConnect\Model\CatalogQueryText
109	*/
110	protected $text_query;
111	/**
112	* $items_for_tax_query A query that returns all [CatalogItem](#type-catalogitem)s that have any of the given [CatalogTax](#type-catalogtax)es enabled.
113	* @var \SquareConnect\Model\CatalogQueryItemsForTax
114	*/
115	protected $items_for_tax_query;
116	/**
117	* $items_for_modifier_list_query A query that returns all [CatalogItem](#type-catalogitem)s that have any of the given [CatalogModifierList](#type-catalogmodifierlist)s enabled.
118	* @var \SquareConnect\Model\CatalogQueryItemsForModifierList
119	*/
120	protected $items_for_modifier_list_query;
121	/**
122	* $items_for_item_options_query A query that returns all [CatalogItem](#type-catalogitem)s that have all of the given [CatalogItemOption](#type-catalogitemoption)s.
123	* @var \SquareConnect\Model\CatalogQueryItemsForItemOptions
124	*/
125	protected $items_for_item_options_query;
126	/**
127	* $item_variations_for_item_option_values_query A query that returns all [CatalogItemVariation](#type-catalogitemvariations)s that have all of the given [CatalogItemOption](#type-catalogitemoption) values.
128	* @var \SquareConnect\Model\CatalogQueryItemVariationsForItemOptionValues
129	*/
130	protected $item_variations_for_item_option_values_query;
131
132	/**
133	* Constructor
134	* @param mixed[] $data Associated array of property value initializing the model
135	*/
136	public function __construct(array $data = null)
137	{
138	if ($data != null) {
139	if (isset($data["sorted_attribute_query"])) {
140	$this->sorted_attribute_query = $data["sorted_attribute_query"];
141	} else {
142	$this->sorted_attribute_query = null;
143	}
144	if (isset($data["exact_query"])) {
145	$this->exact_query = $data["exact_query"];
146	} else {
147	$this->exact_query = null;
148	}
149	if (isset($data["prefix_query"])) {
150	$this->prefix_query = $data["prefix_query"];
151	} else {
152	$this->prefix_query = null;
153	}
154	if (isset($data["range_query"])) {
155	$this->range_query = $data["range_query"];
156	} else {
157	$this->range_query = null;
158	}
159	if (isset($data["text_query"])) {
160	$this->text_query = $data["text_query"];
161	} else {
162	$this->text_query = null;
163	}
164	if (isset($data["items_for_tax_query"])) {
165	$this->items_for_tax_query = $data["items_for_tax_query"];
166	} else {
167	$this->items_for_tax_query = null;
168	}
169	if (isset($data["items_for_modifier_list_query"])) {
170	$this->items_for_modifier_list_query = $data["items_for_modifier_list_query"];
171	} else {
172	$this->items_for_modifier_list_query = null;
173	}
174	if (isset($data["items_for_item_options_query"])) {
175	$this->items_for_item_options_query = $data["items_for_item_options_query"];
176	} else {
177	$this->items_for_item_options_query = null;
178	}
179	if (isset($data["item_variations_for_item_option_values_query"])) {
180	$this->item_variations_for_item_option_values_query = $data["item_variations_for_item_option_values_query"];
181	} else {
182	$this->item_variations_for_item_option_values_query = null;
183	}
184	}
185	}
186	/**
187	* Gets sorted_attribute_query
188	* @return \SquareConnect\Model\CatalogQuerySortedAttribute
189	*/
190	public function getSortedAttributeQuery()
191	{
192	return $this->sorted_attribute_query;
193	}
194
195	/**
196	* Sets sorted_attribute_query
197	* @param \SquareConnect\Model\CatalogQuerySortedAttribute $sorted_attribute_query A query that returns all objects, sorted by the given attribute.
198	* @return $this
199	*/
200	public function setSortedAttributeQuery($sorted_attribute_query)
201	{
202	$this->sorted_attribute_query = $sorted_attribute_query;
203	return $this;
204	}
205	/**
206	* Gets exact_query
207	* @return \SquareConnect\Model\CatalogQueryExact
208	*/
209	public function getExactQuery()
210	{
211	return $this->exact_query;
212	}
213
214	/**
215	* Sets exact_query
216	* @param \SquareConnect\Model\CatalogQueryExact $exact_query A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive value.
217	* @return $this
218	*/
219	public function setExactQuery($exact_query)
220	{
221	$this->exact_query = $exact_query;
222	return $this;
223	}
224	/**
225	* Gets prefix_query
226	* @return \SquareConnect\Model\CatalogQueryPrefix
227	*/
228	public function getPrefixQuery()
229	{
230	return $this->prefix_query;
231	}
232
233	/**
234	* Sets prefix_query
235	* @param \SquareConnect\Model\CatalogQueryPrefix $prefix_query A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix.
236	* @return $this
237	*/
238	public function setPrefixQuery($prefix_query)
239	{
240	$this->prefix_query = $prefix_query;
241	return $this;
242	}
243	/**
244	* Gets range_query
245	* @return \SquareConnect\Model\CatalogQueryRange
246	*/
247	public function getRangeQuery()
248	{
249	return $this->range_query;
250	}
251
252	/**
253	* Sets range_query
254	* @param \SquareConnect\Model\CatalogQueryRange $range_query A query that returns only objects for which the given (integer-valued) attribute lies in the given range.
255	* @return $this
256	*/
257	public function setRangeQuery($range_query)
258	{
259	$this->range_query = $range_query;
260	return $this;
261	}
262	/**
263	* Gets text_query
264	* @return \SquareConnect\Model\CatalogQueryText
265	*/
266	public function getTextQuery()
267	{
268	return $this->text_query;
269	}
270
271	/**
272	* Sets text_query
273	* @param \SquareConnect\Model\CatalogQueryText $text_query A query that returns only objects whose searchable attributes contain all of the given keywords as prefixes. For example, if a [CatalogItem](#type-catalogitem) contains attributes `{\"name\": \"t-shirt\"}` and `{\"description\": \"Small, Purple\"}`, it will be matched by the query `{\"keywords\": [\"shirt\", \"sma\", \"purp\"]}`.
274	* @return $this
275	*/
276	public function setTextQuery($text_query)
277	{
278	$this->text_query = $text_query;
279	return $this;
280	}
281	/**
282	* Gets items_for_tax_query
283	* @return \SquareConnect\Model\CatalogQueryItemsForTax
284	*/
285	public function getItemsForTaxQuery()
286	{
287	return $this->items_for_tax_query;
288	}
289
290	/**
291	* Sets items_for_tax_query
292	* @param \SquareConnect\Model\CatalogQueryItemsForTax $items_for_tax_query A query that returns all [CatalogItem](#type-catalogitem)s that have any of the given [CatalogTax](#type-catalogtax)es enabled.
293	* @return $this
294	*/
295	public function setItemsForTaxQuery($items_for_tax_query)
296	{
297	$this->items_for_tax_query = $items_for_tax_query;
298	return $this;
299	}
300	/**
301	* Gets items_for_modifier_list_query
302	* @return \SquareConnect\Model\CatalogQueryItemsForModifierList
303	*/
304	public function getItemsForModifierListQuery()
305	{
306	return $this->items_for_modifier_list_query;
307	}
308
309	/**
310	* Sets items_for_modifier_list_query
311	* @param \SquareConnect\Model\CatalogQueryItemsForModifierList $items_for_modifier_list_query A query that returns all [CatalogItem](#type-catalogitem)s that have any of the given [CatalogModifierList](#type-catalogmodifierlist)s enabled.
312	* @return $this
313	*/
314	public function setItemsForModifierListQuery($items_for_modifier_list_query)
315	{
316	$this->items_for_modifier_list_query = $items_for_modifier_list_query;
317	return $this;
318	}
319	/**
320	* Gets items_for_item_options_query
321	* @return \SquareConnect\Model\CatalogQueryItemsForItemOptions
322	*/
323	public function getItemsForItemOptionsQuery()
324	{
325	return $this->items_for_item_options_query;
326	}
327
328	/**
329	* Sets items_for_item_options_query
330	* @param \SquareConnect\Model\CatalogQueryItemsForItemOptions $items_for_item_options_query A query that returns all [CatalogItem](#type-catalogitem)s that have all of the given [CatalogItemOption](#type-catalogitemoption)s.
331	* @return $this
332	*/
333	public function setItemsForItemOptionsQuery($items_for_item_options_query)
334	{
335	$this->items_for_item_options_query = $items_for_item_options_query;
336	return $this;
337	}
338	/**
339	* Gets item_variations_for_item_option_values_query
340	* @return \SquareConnect\Model\CatalogQueryItemVariationsForItemOptionValues
341	*/
342	public function getItemVariationsForItemOptionValuesQuery()
343	{
344	return $this->item_variations_for_item_option_values_query;
345	}
346
347	/**
348	* Sets item_variations_for_item_option_values_query
349	* @param \SquareConnect\Model\CatalogQueryItemVariationsForItemOptionValues $item_variations_for_item_option_values_query A query that returns all [CatalogItemVariation](#type-catalogitemvariations)s that have all of the given [CatalogItemOption](#type-catalogitemoption) values.
350	* @return $this
351	*/
352	public function setItemVariationsForItemOptionValuesQuery($item_variations_for_item_option_values_query)
353	{
354	$this->item_variations_for_item_option_values_query = $item_variations_for_item_option_values_query;
355	return $this;
356	}
357	/**
358	* Returns true if offset exists. False otherwise.
359	* @param integer $offset Offset
360	* @return boolean
361	*/
362	public function offsetExists($offset)
363	{
364	return isset($this->$offset);
365	}
366
367	/**
368	* Gets offset.
369	* @param integer $offset Offset
370	* @return mixed
371	*/
372	public function offsetGet($offset)
373	{
374	return $this->$offset;
375	}
376
377	/**
378	* Sets value based on offset.
379	* @param integer $offset Offset
380	* @param mixed $value Value to be set
381	* @return void
382	*/
383	public function offsetSet($offset, $value)
384	{
385	$this->$offset = $value;
386	}
387
388	/**
389	* Unsets offset.
390	* @param integer $offset Offset
391	* @return void
392	*/
393	public function offsetUnset($offset)
394	{
395	unset($this->$offset);
396	}
397
398	/**
399	* Gets the string presentation of the object
400	* @return string
401	*/
402	public function __toString()
403	{
404	if (defined('JSON_PRETTY_PRINT')) {
405	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT);
406	} else {
407	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this));
408	}
409	}
410	}
411