Search::getSort() - Code Metrics - Inspection of "Merge pull request #137 from hareku/feature/addSor..." - Exeu/apai-io - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b77b04...ca0d9b )

by Jan

created 2017-02-09 07:32 UTC

Search::getSort() A

↳ Parent: Search

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php
/*
 * Copyright 2016 Jan Eichhorn <[email protected]>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace ApaiIO\Operations;

/**
 * A item search operation
 *
 * @see    http://docs.aws.amazon.com/AWSECommerceService/2011-08-01/DG/ItemSearch.html
 * @author Jan Eichhorn <[email protected]>
 *
 * @method Search setMerchantId(string $merchantId)
 */
class Search extends AbstractOperation
{
    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return 'ItemSearch';
    }

    /**
     * Return the amazon category
     *
     * @return string
     */
    public function getCategory()
    {
        return $this->getSingleOperationParameter('SearchIndex');
    }

    /**
     * Sets the amazon category
     *
     * @param string $category
     *
     * @return \ApaiIO\Operations\Search
     */
    public function setCategory($category)
    {
        $this->parameters['SearchIndex'] = $category;

        return $this;
    }

    /**
     * Returns the keywords
     *
     * @return string
     */
    public function getKeywords()
    {
        return $this->getSingleOperationParameter('Keywords');
    }

    /**
     * Sets the keywords
     *
     * @param string $keywords
     *
     * @return \ApaiIO\Operations\Search
     */
    public function setKeywords($keywords)
    {
        $this->parameters['Keywords'] = $keywords;

        return $this;
    }

    /**
     * Returns the sort
     *
     * @return string
     */
    public function getSort()
    {
        return $this->getSingleOperationParameter('Sort');
    }

    /**
     * Sets the sort
     *
     * @param string $sort
     *
     * @return \ApaiIO\Operations\Search
     */
    public function setSort($sort)
    {
        $this->parameters['Sort'] = $sort;

        return $this;
    }

    /**
     * Return the resultpage
     *
     * @return integer
     */
    public function getPage()
    {
        return $this->getSingleOperationParameter('ItemPage');
    }

    /**
     * Sets the resultpage to a specified value
     * Allows to browse resultsets which have more than one page
     *
     * @param integer $page
     *
     * @return \ApaiIO\Operations\Search
     */
    public function setPage($page)
    {
        if (false === is_numeric($page) || $page < 1 || $page > 10) {
            throw new \InvalidArgumentException(sprintf('%s is an invalid page value. It has to be numeric, positive and between 1 and 10',
                    $page));
        }

        $this->parameters['ItemPage'] = $page;

        return $this;
    }

    /**
     * Return the minimum price as integer so 8.99$ will be returned as 899
     *
     * @return integer
     */
    public function getMinimumPrice()
    {
        return $this->getSingleOperationParameter('MinimumPrice');
    }

    /**
     * Sets the minimum price to a specified value for the search
     * Currency will be given by the site you are querying: EUR for IT, USD for COM
     * Price should be given as integer. 8.99$ USD becomes 899
     *
     * @param integer $price
     *
     * @return \ApaiIO\Operations\Search
     */
    public function setMinimumPrice($price)
    {
        $this->validatePrice($price);
        $this->parameters['MinimumPrice'] = $price;

        return $this;
    }

    /**
     * Returns the maximum price as integer so 8.99$ will be returned as 899
     * @return mixed
     */
    public function getMaximumPrice()
    {
        return $this->getSingleOperationParameter('MaximumPrice');
    }

    /**
     * Sets the maximum price to a specified value for the search
     * Currency will be given by the site you are querying: EUR for IT, USD for COM
     * Price should be given as integer. 8.99$ USD becomes 899
     *
     * @param integer $price
     *
     * @return \ApaiIO\Operations\Search
     */
    public function setMaximumPrice($price)
    {
        $this->validatePrice($price);
        $this->parameters['MaximumPrice'] = $price;

        return $this;
    }

    /**
     * Returns the condition of the items to return. New | Used | Collectible | Refurbished | All
     *
     * @return string
     */
    public function getCondition()
    {
        return $this->getSingleOperationParameter('Condition');
    }

    /**
     * Sets the condition of the items to return: New | Used | Collectible | Refurbished | All
     *
     * Defaults to New.
     *
     * @param string $condition
     *
     * @return \ApaiIO\Operations\Search
     */
    public function setCondition($condition)
    {
        $this->parameters['Condition'] = $condition;

        return $this;
    }

    /**
     * Returns the availability.
     *
     * @return string
     */
    public function getAvailability()
    {
        return $this->getSingleOperationParameter('Availability');
    }

    /**
     * Sets the availability. Don't use method if you want the default Amazon behaviour.
     * Only valid value = Available
     *
     * @param string $availability
     * @see http://docs.aws.amazon.com/AWSECommerceService/latest/DG/CHAP_ReturningPriceAndAvailabilityInformation-itemsearch.html
     *
     * @return \ApaiIO\Operations\Search
     */
    public function setAvailability($availability)
    {
        $this->parameters['Availability'] = $availability;

        return $this;
    }

    /**
     * Returns the browseNodeId
     *
     * @return integer
     */
    public function getBrowseNode()
    {
        return $this->getSingleOperationParameter('BrowseNode');
    }

    /**
     * Sets the browseNodeId
     *
     * @param integer $browseNodeId
     *
     * @return \ApaiIO\Operations\Search
     */
    public function setBrowseNode($browseNodeId)
    {
        $this->parameters['BrowseNode'] = $browseNodeId;

        return $this;
    }

    /**
     * Validates the given price.
     *
     * @param integer $price
     */
    protected function validatePrice($price)
    {
        if (false === is_numeric($price) || $price < 1) {
            throw new \InvalidArgumentException(sprintf('%s is an invalid price value. It has to be numeric and >= than 1',
                    $price));
        }
    }
}


1			<?php
2			/*
3			* Copyright 2016 Jan Eichhorn <[email protected]>
4			*
5			* Licensed under the Apache License, Version 2.0 (the "License");
6			* you may not use this file except in compliance with the License.
7			* You may obtain a copy of the License at
8			*
9			* http://www.apache.org/licenses/LICENSE-2.0
10			*
11			* Unless required by applicable law or agreed to in writing, software
12			* distributed under the License is distributed on an "AS IS" BASIS,
13			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14			* See the License for the specific language governing permissions and
15			* limitations under the License.
16			*/
17
18			namespace ApaiIO\Operations;
19
20			/**
21			* A item search operation
22			*
23			* @see http://docs.aws.amazon.com/AWSECommerceService/2011-08-01/DG/ItemSearch.html
24			* @author Jan Eichhorn <[email protected]>
25			*
26			* @method Search setMerchantId(string $merchantId)
27			*/
28			class Search extends AbstractOperation
29			{
30			/**
31			* {@inheritdoc}
32			*/
33			public function getName()
34			{
35			return 'ItemSearch';
36			}
37
38			/**
39			* Return the amazon category
40			*
41			* @return string
42			*/
43			public function getCategory()
44			{
45			return $this->getSingleOperationParameter('SearchIndex');
46			}
47
48			/**
49			* Sets the amazon category
50			*
51			* @param string $category
52			*
53			* @return \ApaiIO\Operations\Search
54			*/
55			public function setCategory($category)
56			{
57			$this->parameters['SearchIndex'] = $category;
58
59			return $this;
60			}
61
62			/**
63			* Returns the keywords
64			*
65			* @return string
66			*/
67			public function getKeywords()
68			{
69			return $this->getSingleOperationParameter('Keywords');
70			}
71
72			/**
73			* Sets the keywords
74			*
75			* @param string $keywords
76			*
77			* @return \ApaiIO\Operations\Search
78			*/
79			public function setKeywords($keywords)
80			{
81			$this->parameters['Keywords'] = $keywords;
82
83			return $this;
84			}
85
86			/**
87			* Returns the sort
88			*
89			* @return string
90			*/
91			public function getSort()
92			{
93			return $this->getSingleOperationParameter('Sort');
94			}
95
96			/**
97			* Sets the sort
98			*
99			* @param string $sort
100			*
101			* @return \ApaiIO\Operations\Search
102			*/
103			public function setSort($sort)
104			{
105			$this->parameters['Sort'] = $sort;
106
107			return $this;
108			}
109
110			/**
111			* Return the resultpage
112			*
113			* @return integer
114			*/
115			public function getPage()
116			{
117			return $this->getSingleOperationParameter('ItemPage');
118			}
119
120			/**
121			* Sets the resultpage to a specified value
122			* Allows to browse resultsets which have more than one page
123			*
124			* @param integer $page
125			*
126			* @return \ApaiIO\Operations\Search
127			*/
128			public function setPage($page)
129			{
130			if (false === is_numeric($page) \|\| $page < 1 \|\| $page > 10) {
131			throw new \InvalidArgumentException(sprintf('%s is an invalid page value. It has to be numeric, positive and between 1 and 10',
132			$page));
133			}
134
135			$this->parameters['ItemPage'] = $page;
136
137			return $this;
138			}
139
140			/**
141			* Return the minimum price as integer so 8.99$ will be returned as 899
142			*
143			* @return integer
144			*/
145			public function getMinimumPrice()
146			{
147			return $this->getSingleOperationParameter('MinimumPrice');
148			}
149
150			/**
151			* Sets the minimum price to a specified value for the search
152			* Currency will be given by the site you are querying: EUR for IT, USD for COM
153			* Price should be given as integer. 8.99$ USD becomes 899
154			*
155			* @param integer $price
156			*
157			* @return \ApaiIO\Operations\Search
158			*/
159			public function setMinimumPrice($price)
160			{
161			$this->validatePrice($price);
162			$this->parameters['MinimumPrice'] = $price;
163
164			return $this;
165			}
166
167			/**
168			* Returns the maximum price as integer so 8.99$ will be returned as 899
169			* @return mixed
170			*/
171			public function getMaximumPrice()
172			{
173			return $this->getSingleOperationParameter('MaximumPrice');
174			}
175
176			/**
177			* Sets the maximum price to a specified value for the search
178			* Currency will be given by the site you are querying: EUR for IT, USD for COM
179			* Price should be given as integer. 8.99$ USD becomes 899
180			*
181			* @param integer $price
182			*
183			* @return \ApaiIO\Operations\Search
184			*/
185			public function setMaximumPrice($price)
186			{
187			$this->validatePrice($price);
188			$this->parameters['MaximumPrice'] = $price;
189
190			return $this;
191			}
192
193			/**
194			* Returns the condition of the items to return. New \| Used \| Collectible \| Refurbished \| All
195			*
196			* @return string
197			*/
198			public function getCondition()
199			{
200			return $this->getSingleOperationParameter('Condition');
201			}
202
203			/**
204			* Sets the condition of the items to return: New \| Used \| Collectible \| Refurbished \| All
205			*
206			* Defaults to New.
207			*
208			* @param string $condition
209			*
210			* @return \ApaiIO\Operations\Search
211			*/
212			public function setCondition($condition)
213			{
214			$this->parameters['Condition'] = $condition;
215
216			return $this;
217			}
218
219			/**
220			* Returns the availability.
221			*
222			* @return string
223			*/
224			public function getAvailability()
225			{
226			return $this->getSingleOperationParameter('Availability');
227			}
228
229			/**
230			* Sets the availability. Don't use method if you want the default Amazon behaviour.
231			* Only valid value = Available
232			*
233			* @param string $availability
234			* @see http://docs.aws.amazon.com/AWSECommerceService/latest/DG/CHAP_ReturningPriceAndAvailabilityInformation-itemsearch.html
235			*
236			* @return \ApaiIO\Operations\Search
237			*/
238			public function setAvailability($availability)
239			{
240			$this->parameters['Availability'] = $availability;
241
242			return $this;
243			}
244
245			/**
246			* Returns the browseNodeId
247			*
248			* @return integer
249			*/
250			public function getBrowseNode()
251			{
252			return $this->getSingleOperationParameter('BrowseNode');
253			}
254
255			/**
256			* Sets the browseNodeId
257			*
258			* @param integer $browseNodeId
259			*
260			* @return \ApaiIO\Operations\Search
261			*/
262			public function setBrowseNode($browseNodeId)
263			{
264			$this->parameters['BrowseNode'] = $browseNodeId;
265
266			return $this;
267			}
268
269			/**
270			* Validates the given price.
271			*
272			* @param integer $price
273			*/
274			protected function validatePrice($price)
275			{
276			if (false === is_numeric($price) \|\| $price < 1) {
277			throw new \InvalidArgumentException(sprintf('%s is an invalid price value. It has to be numeric and >= than 1',
278			$price));
279			}
280			}
281			}
282

Exeu / apai-io

GitHub Access Token became invalid

Push — master ( b77b04...ca0d9b )

Search::getSort() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like