Merge pull request #61 from keithbrink/analysis-QMQ223

Apply fixes from StyleCI

Author: keithbrink

src/AmazonCore.php

@@ -39,11 +39,12 @@ class AmazonFeed extends AmazonFeedsCore
      * The parameters are passed to the parent constructor, which are
      * in turn passed to the AmazonCore constructor. See it for more information
      * on these parameters and common methods.
-     * @param string $s <p>Name for the store you want to use.</p>
-     * @param bool $mock [optional] <p>This is a flag for enabling Mock Mode.
-     * This defaults to <b>FALSE</b>.</p>
-     * @param array|string $m [optional] <p>The files (or file) to use in Mock Mode.</p>
-     * @param string $config [optional] <p>An alternate config file to set. Used for testing.</p>
+     *
+     * @param  string  $s  <p>Name for the store you want to use.</p>
+     * @param  bool  $mock  [optional] <p>This is a flag for enabling Mock Mode.
+     *                      This defaults to <b>FALSE</b>.</p>
+     * @param  array|string  $m  [optional] <p>The files (or file) to use in Mock Mode.</p>
+     * @param  string  $config  [optional] <p>An alternate config file to set. Used for testing.</p>
      */
     public function __construct($s, $mock = false, $m = null, $config = null)
     {
@@ -67,8 +68,8 @@ public function __construct($s, $mock = false, $m = null, $config = null)
      * Thie method sets the feed's contents from direct input.
      * This parameter is required in order to submit a feed to Amazon.
      *
-     * @param string $s <p>The contents to put in the file.</p>
-     * It can be relative or absolute.</p>
+     * @param  string  $s  <p>The contents to put in the file.</p>
+     *                     It can be relative or absolute.</p>
      * @return bool <b>FALSE</b> if improper input
      */
     public function setFeedContent($s)
@@ -87,8 +88,8 @@ public function setFeedContent($s)
      * This method loads the contents of a file to send as the feed. This
      * parameter is required in order to submit a feed to Amazon.
      *
-     * @param string $url <p>The path to a file you want to use.
-     *                    It can be relative or absolute.</p>
+     * @param  string  $url  <p>The path to a file you want to use.
+     *                       It can be relative or absolute.</p>
      */
     public function loadFeedFile($path)
     {
@@ -110,8 +111,8 @@ public function loadFeedFile($path)
      * Amazon how the Feed should be processsed.
      * This parameter is required in order to submit a feed to Amazon.
      *
-     * @param string $s <p>A value from the list of valid Feed Types.
-     * See the comment inside the function for the complete list.</p>
+     * @param  string  $s  <p>A value from the list of valid Feed Types.
+     *                     See the comment inside the function for the complete list.</p>
      * @return bool <b>FALSE</b> if improper input
      */
     public function setFeedType($s)
@@ -169,7 +170,7 @@ public function setFeedType($s)
      * to sell in. If this is not set, Amazon will only use the first Marketplace
      * you are registered for.
      *
-     * @param array|string $s <p>A list of Marketplace IDs, or a single ID string.</p>
+     * @param  array|string  $s  <p>A list of Marketplace IDs, or a single ID string.</p>
      * @return bool <b>FALSE</b> if improper input
      */
     public function setMarketplaceIds($s)
@@ -215,8 +216,9 @@ public function resetMarketplaceIds()
      * This method sets whether or not the tab delimited feed you provide should
      * completely replace old data. Use this parameter only in exceptional cases.
      * If this is not set, Amazon assumes it to be false.
-     * @param bool|string $s [optional] <p>The value "true" or "false", either as
-     * a boolean or a string. It defaults to "true".</p>
+     *
+     * @param  bool|string  $s  [optional] <p>The value "true" or "false", either as
+     *                          a boolean or a string. It defaults to "true".</p>
      * @return bool <b>FALSE</b> if improper input
      */
     public function setPurge($s = 'true')
@@ -246,6 +248,7 @@ public function setPurge($s = 'true')
      * the feed's contents and feed type are required. The request will not be
      * sent if either of these are not set. Amazon will send a response back,
      * which can be retrieved using <i>getResponse</i>.
+     *
      * @return bool <b>FALSE</b> if something goes wrong
      */
     public function submitFeed()
@@ -293,7 +296,7 @@ public function submitFeed()
      *
      * This is what reads the response XML and converts it into an array.
      *
-     * @param SimpleXMLObject $xml <p>The XML response from Amazon.</p>
+     * @param  SimpleXMLObject  $xml  <p>The XML response from Amazon.</p>
      * @return bool <b>FALSE</b> if no XML data is found
      */
     protected function parseXML($xml)
@@ -333,8 +336,8 @@ protected function genHeader()
      * is different than the ones used by other objects due to Amazon sending
      * 100 Continue responses in addition to the usual response.
      *
-     * @param array $r <p>The HTTP response array. Expects the array to have
-     * the fields <i>code</i>, <i>body</i>, and <i>error</i>.</p>
+     * @param  array  $r  <p>The HTTP response array. Expects the array to have
+     *                    the fields <i>code</i>, <i>body</i>, and <i>error</i>.</p>
      * @return bool <b>TRUE</b> if the status is 200 OK, <b>FALSE</b> otherwise.
      */
     protected function checkResponse($r)

src/AmazonFeed.php

@@ -45,11 +45,12 @@ class AmazonFeedList extends AmazonFeedsCore implements Iterator
      * The parameters are passed to the parent constructor, which are
      * in turn passed to the AmazonCore constructor. See it for more information
      * on these parameters and common methods.
-     * @param string $s <p>Name for the store you want to use.</p>
-     * @param bool $mock [optional] <p>This is a flag for enabling Mock Mode.
-     * This defaults to <b>FALSE</b>.</p>
-     * @param array|string $m [optional] <p>The files (or file) to use in Mock Mode.</p>
-     * @param string $config [optional] <p>An alternate config file to set. Used for testing.</p>
+     *
+     * @param  string  $s  <p>Name for the store you want to use.</p>
+     * @param  bool  $mock  [optional] <p>This is a flag for enabling Mock Mode.
+     *                      This defaults to <b>FALSE</b>.</p>
+     * @param  array|string  $m  [optional] <p>The files (or file) to use in Mock Mode.</p>
+     * @param  string  $config  [optional] <p>An alternate config file to set. Used for testing.</p>
      */
     public function __construct($s, $mock = false, $m = null, $config = null)
     {
@@ -66,6 +67,7 @@ public function __construct($s, $mock = false, $m = null, $config = null)
 
     /**
      * Returns whether or not a token is available.
+     *
      * @return bool
      */
     public function hasToken()
@@ -80,7 +82,8 @@ public function hasToken()
      * the necessary operations to retrieve the rest of the list using tokens. If
      * this option is off, the object will only ever retrieve the first section of
      * the list.
-     * @param bool $b [optional] <p>Defaults to <b>TRUE</b></p>
+     *
+     * @param  bool  $b  [optional] <p>Defaults to <b>TRUE</b></p>
      * @return bool <b>FALSE</b> if improper input
      */
     public function setUseToken($b = true)
@@ -99,7 +102,7 @@ public function setUseToken($b = true)
      * Setting this parameter tells Amazon to only return Feed Submissions that match
      * the IDs in the list. If this parameter is set, all other parameters will be ignored.
      *
-     * @param array|string $s <p>A list of Feed Submission IDs, or a single ID string.</p>
+     * @param  array|string  $s  <p>A list of Feed Submission IDs, or a single ID string.</p>
      * @return bool <b>FALSE</b> if improper input
      */
     public function setFeedIds($s)
@@ -142,7 +145,7 @@ public function resetFeedIds()
      * the types in the list. If this parameter is not set, Amazon will return
      * Feed Submissions of any type.
      *
-     * @param array|string $s <p>A list of Feed Types, or a single type string.</p>
+     * @param  array|string  $s  <p>A list of Feed Types, or a single type string.</p>
      * @return bool <b>FALSE</b> if improper input
      */
     public function setFeedTypes($s)
@@ -185,8 +188,8 @@ public function resetFeedTypes()
      * the statuses in the list. If this parameter is not set, Amazon will return
      * Feed Submissions with any status.
      *
-     * @param array|string $s <p>A list of Feed Statuses, or a single status string.<br />
-     * Valid values are "_SUBMITTED_", "_IN_PROGRESS_", "_CANCELLED_", and "_DONE_".</p>
+     * @param  array|string  $s  <p>A list of Feed Statuses, or a single status string.<br />
+     *                           Valid values are "_SUBMITTED_", "_IN_PROGRESS_", "_CANCELLED_", and "_DONE_".</p>
      * @return bool <b>FALSE</b> if improper input
      */
     public function setFeedStatuses($s)
@@ -227,7 +230,7 @@ public function resetFeedStatuses()
      * This method sets the maximum number of Feed Submissions for Amazon to return.
      * If this parameter is not set, Amazon will only send ten.
      *
-     * @param array|string $s <p>Positive integer from 1 to 100.</p>
+     * @param  array|string  $s  <p>Positive integer from 1 to 100.</p>
      * @return bool <b>FALSE</b> if improper input
      */
     public function setMaxCount($s)
@@ -248,8 +251,8 @@ public function setMaxCount($s)
      * only return Feed Submissions that were submitted within the past 180 days.
      * The parameters are passed through <i>strtotime</i>, so values such as "-1 hour" are fine.
      *
-     * @param string $s [optional] <p>A time string for the earliest time.</p>
-     * @param string $e [optional] <p>A time string for the latest time.</p>
+     * @param  string  $s  [optional] <p>A time string for the earliest time.</p>
+     * @param  string  $e  [optional] <p>A time string for the latest time.</p>
      */
     public function setTimeLimits($s = null, $e = null)
     {
@@ -282,6 +285,7 @@ public function resetTimeLimits()
      * the list back as a response, which can be retrieved using <i>getFeedList</i>.
      * Other methods are available for fetching specific values from the list.
      * This operation can potentially involve tokens.
+     *
      * @param bool <p>When set to <b>FALSE</b>, the function will not recurse, defaults to <b>TRUE</b></p>
      * @return bool <b>FALSE</b> if something goes wrong
      */
@@ -363,7 +367,7 @@ protected function prepareToken()
      *
      * This is what reads the response XML and converts it into an array.
      *
-     * @param SimpleXMLObject $xml <p>The XML response from Amazon.</p>
+     * @param  SimpleXMLObject  $xml  <p>The XML response from Amazon.</p>
      * @return bool <b>FALSE</b> if no XML data is found
      */
     protected function parseXML($xml)
@@ -395,6 +399,7 @@ protected function parseXML($xml)
      *
      * Submits a <i>GetFeedSubmissionCount</i> request to Amazon. Amazon will send
      * the number back as a response, which can be retrieved using <i>getCount</i>.
+     *
      * @return bool <b>FALSE</b> if something goes wrong
      */
     public function countFeeds()
@@ -453,6 +458,7 @@ protected function prepareCount()
      * as a response the list of feeds that were cancelled, along with the count
      * of the number of affected feeds. This data can be retrieved using the same
      * methods as with <i>fetchFeedSubmissions</i> and <i>countFeeds</i>.
+     *
      * @return bool <b>FALSE</b> if something goes wrong
      */
     public function cancelFeeds()
@@ -508,7 +514,7 @@ protected function prepareCancel()
      *
      * This method will return <b>FALSE</b> if the list has not yet been filled.
      *
-     * @param int $i [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
+     * @param  int  $i  [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
      * @return string|bool single value, or <b>FALSE</b> if Non-numeric index
      */
     public function getFeedId($i = 0)
@@ -525,7 +531,7 @@ public function getFeedId($i = 0)
      *
      * This method will return <b>FALSE</b> if the list has not yet been filled.
      *
-     * @param int $i [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
+     * @param  int  $i  [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
      * @return string|bool single value, or <b>FALSE</b> if Non-numeric index
      */
     public function getFeedType($i = 0)
@@ -543,7 +549,7 @@ public function getFeedType($i = 0)
      * This method will return <b>FALSE</b> if the list has not yet been filled.
      * The time will be in the ISO8601 date format.
      *
-     * @param int $i [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
+     * @param  int  $i  [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
      * @return string|bool single value, or <b>FALSE</b> if Non-numeric index
      */
     public function getDateSubmitted($i = 0)
@@ -561,7 +567,7 @@ public function getDateSubmitted($i = 0)
      * This method will return <b>FALSE</b> if the list has not yet been filled.
      * See <i>setFeedStatuses</i> for a list of possible values.
      *
-     * @param int $i [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
+     * @param  int  $i  [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
      * @return string|bool single value, or <b>FALSE</b> if Non-numeric index
      */
     public function getFeedStatus($i = 0)
@@ -585,7 +591,7 @@ public function getFeedStatus($i = 0)
      * <li><b>FeedProcessingStatus</b> - see <i>setFeedStatuses</i> for a list of possible values</li>
      * </ul>
      *
-     * @param int $i [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
+     * @param  int  $i  [optional] <p>List index to retrieve the value from. Defaults to 0.</p>
      * @return array|bool array of values, or <b>FALSE</b> if Non-numeric index
      */
     public function getFeedInfo($i = 0)
@@ -601,6 +607,7 @@ public function getFeedInfo($i = 0)
      * Returns the full list.
      *
      * This method will return <b>FALSE</b> if the list has not yet been filled.
+     *
      * @return array|bool multi-dimensional array, or <b>FALSE</b> if list not filled yet
      */
     public function getFeedList()
@@ -616,6 +623,7 @@ public function getFeedList()
      * Returns the feed count from either countFeeds or cancelFeeds.
      *
      * This method will return <b>FALSE</b> if the count has not been set yet.
+     *
      * @return number|bool number, or <b>FALSE</b> if count not set yet
      */
     public function getFeedCount()
@@ -629,6 +637,7 @@ public function getFeedCount()
 
     /**
      * Iterator function.
+     *
      * @return type
      */
     public function current()
@@ -646,6 +655,7 @@ public function rewind()
 
     /**
      * Iterator function.
+     *
      * @return type
      */
     public function key()
@@ -663,6 +673,7 @@ public function next()
 
     /**
      * Iterator function.
+     *
      * @return type
      */
     public function valid()

src/AmazonFeedList.php

@@ -40,12 +40,13 @@ class AmazonFeedResult extends AmazonFeedsCore
      * on these parameters and common methods.
      * Please note that an extra parameter comes before the usual Mock Mode parameters,
      * so be careful when setting up the object.
-     * @param string $s <p>Name for the store you want to use.</p>
-     * @param string $id [optional] <p>The Feed Submission ID to set for the object.</p>
-     * @param bool $mock [optional] <p>This is a flag for enabling Mock Mode.
-     * This defaults to <b>FALSE</b>.</p>
-     * @param array|string $m [optional] <p>The files (or file) to use in Mock Mode.</p>
-     * @param string $config [optional] <p>An alternate config file to set. Used for testing.</p>
+     *
+     * @param  string  $s  <p>Name for the store you want to use.</p>
+     * @param  string  $id  [optional] <p>The Feed Submission ID to set for the object.</p>
+     * @param  bool  $mock  [optional] <p>This is a flag for enabling Mock Mode.
+     *                      This defaults to <b>FALSE</b>.</p>
+     * @param  array|string  $m  [optional] <p>The files (or file) to use in Mock Mode.</p>
+     * @param  string  $config  [optional] <p>An alternate config file to set. Used for testing.</p>
      */
     public function __construct($s, $id = null, $mock = false, $m = null, $config = null)
     {
@@ -72,7 +73,8 @@ public function __construct($s, $id = null, $mock = false, $m = null, $config =
      *
      * This method sets the feed submission ID to be sent in the next request. This
      * parameter is required in order to retrieve a feed from Amazon.
-     * @param string|int $n <p>Must be numeric</p>
+     *
+     * @param  string|int  $n  <p>Must be numeric</p>
      * @return bool <b>FALSE</b> if improper input
      */
     public function setFeedId($n)
@@ -90,6 +92,7 @@ public function setFeedId($n)
      * Submits a <i>GetFeedSubmissionResult</i> request to Amazon. In order to
      * do this, a feed submission ID is required. Amazon will send back the raw results
      * of the feed as a response, which can be saved to a file using <i>saveFeed</i>.
+     *
      * @return bool <b>FALSE</b> if something goes wrong
      */
     public function fetchFeedResult()
@@ -122,7 +125,7 @@ public function fetchFeedResult()
      *
      * This method will record in the log whether or not the save was successful.
      *
-     * @param string $path <p>path for the file to save the feed data in</p>
+     * @param  string  $path  <p>path for the file to save the feed data in</p>
      * @return bool <b>FALSE</b> if something goes wrong
      */
     public function saveFeed($path)
@@ -148,6 +151,7 @@ public function saveFeed($path)
      * Returns the entire raw report data.
      *
      * This is useful for handling the report with an external file management system.
+     *
      * @return string|bool The raw report data as a string, or <b>FALSE</b> if there is no data
      */
     public function getRawFeed()

src/AmazonFeedResult.php

@@ -35,11 +35,11 @@ abstract class AmazonFeedsCore extends AmazonCore
      * in turn passed to the AmazonCore constructor. See it for more information
      * on these parameters and common methods.
      *
-     * @param string       $s      <p>Name for the store you want to use.</p>
-     * @param bool         $mock   [optional] <p>This is a flag for enabling Mock Mode.
-     *                             This defaults to <b>FALSE</b>.</p>
-     * @param array|string $m      [optional] <p>The files (or file) to use in Mock Mode.</p>
-     * @param string       $config [optional] <p>An alternate config file to set. Used for testing.</p>
+     * @param  string  $s  <p>Name for the store you want to use.</p>
+     * @param  bool  $mock  [optional] <p>This is a flag for enabling Mock Mode.
+     *                      This defaults to <b>FALSE</b>.</p>
+     * @param  array|string  $m  [optional] <p>The files (or file) to use in Mock Mode.</p>
+     * @param  string  $config  [optional] <p>An alternate config file to set. Used for testing.</p>
      */
     public function __construct($s, $mock = false, $m = null, $config = null)
     {