Helper - Code Metrics - Inspection of "Helper almost 100% coverage" - radowoj/yaah - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 57713c...d5a8e5 )

by Radosław

created 2017-03-31 13:25 UTC

Helper A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

87.04%

Importance

Changes

Metric	Value
wmc	15
lcom	1
cbo	4
dl	0
loc	159
ccs	47
cts	54
cp	0.8704
rs	10
c	0
b	0
f	0

9 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	getFieldsByCategory()	20	2
A	newAuction()	14	3
A	finishAuction()	4	1
A	finishAuctions()	12	1
A	changeQuantity()	7	1
A	getAuctionByItemId()	11	2
A	__call()	8	2
A	getSiteJournalDeals()	11	2

<?php

namespace Radowoj\Yaah;

use Radowoj\Yaah\Constants\SellFormOpts;
use Radowoj\Yaah\Journal\Deal;

class Helper
{
    protected $client = null;

    public function __construct(Client $client)
    {
        $this->client = $client;
    }

    /**
     * Get simplified fields list for given category
     * @param  integer $idCategory id of category in question
     * @return array of fields metadata
     */
    public function getFieldsByCategory($idCategory)
    {
        $data = $this->client->doGetSellFormFieldsForCategory(['categoryId' => $idCategory]);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        if (!isset($data->sellFormFieldsForCategory->sellFormFieldsList->item)) {
            throw new Exception('Invalid WebAPI response: ' . print_r($data, 1));
        }

        $items = $data->sellFormFieldsForCategory->sellFormFieldsList->item;

        return array_map(function ($item) {
            return [
                'fid' => $item->sellFormId,
                'title' => $item->sellFormTitle,
                'required' => ($item->sellFormOpt == SellFormOpts::SELL_FORM_OPT_REQUIRED),
                'options' => $item->sellFormOptsValues,
                'optionsDesc' => $item->sellFormDesc,
            ];
        }, $items);
    }

    /**
     * Create new auction
     *
     * @throws Exception on failure
     *
     * @param  Auction $auction Auction to create
     * @param integer $localId - local item id, required by WebAPI
     * @return integer id of created auction
     */
    public function newAuction(AuctionInterface $auction, $localId)
    {
        $auctionArray = $auction->toApiRepresentation();
        $auctionArray['localId'] = $localId;

        $resultNewAuction = $this->client->doNewAuctionExt($auctionArray);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $resultVerify = $this->client->doVerifyItem(['localId' => $localId]);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        if (!is_object($resultVerify) || !isset($resultVerify->itemId)) {
            throw new Exception("Auction has not been created: " . print_r($resultVerify, 1));
        }

        return $resultVerify->itemId;
    }


    /**
     * Finish a single auction
     * @param  integer $auctionId itemId of auction to finish
     * @param  integer $cancelAllBids whether to cancel all bids
     * @param  string  $finishCancelReason reason
     * @return array
     */
    public function finishAuction($auctionId, $cancelAllBids = 0, $finishCancelReason = '')
    {
        return $this->finishAuctions((array)($auctionId), $cancelAllBids, $finishCancelReason);
    }


    /**
     * Finish a single auction
     * @param  array $auctionIds itemIds of auctions to finish
     * @param  integer $cancelAllBids whether to cancel all bids
     * @param  string  $finishCancelReason reason
     * @return array
     */
    public function finishAuctions(array $auctionIds, $cancelAllBids = 0, $finishCancelReason = '')
    {
        $finishItemsList = array_map(function ($auctionId) use ($cancelAllBids, $finishCancelReason) {
            return [
                'finishItemId' => $auctionId,
                'finishCancelAllBids' => $cancelAllBids,
                'finishCancelReason' => $finishCancelReason,
            ];
        }, $auctionIds);

        return $this->client->doFinishItems(['finishItemsList' => $finishItemsList]);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Change quantity of items available in auction
     * @param  integer $auctionId   itemId of auction to change quantity
     * @param  integer $newQuantity new quantity to set
     * @return array
     */
    public function changeQuantity($auctionId, $newQuantity)
    {
        return $this->client->doChangeQuantityItem([
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            'itemId' => $auctionId,
            'newItemQuantity' => $newQuantity
        ]);
    }


    /**
     * Return site journal deals
     * @param  integer $journalStart start point (dealEventId)
     * @return array
     */
    public function getSiteJournalDeals($journalStart = 0)
    {
        $response = $this->client->doGetSiteJournalDeals(['journalStart' => $journalStart]);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        if (isset($response->siteJournalDeals->item)) {
            return array_map(function($deal){
                return new Deal($deal);
            }, $response->siteJournalDeals->item);
        }

        throw new Exception("Unable to get site journal deals: " . print_r($response, 1));
    }


    /**
     * @param  integer $itemId id of auction to get
     * @return Auction | null
     */
    public function getAuctionByItemId($itemId)
    {
        $response =  $this->client->doGetItemFields(['itemId' => $itemId]);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        if (isset($response->itemFields->item)) {
            $auction = new Auction();
            $auction->fromApiRepresentation($response->itemFields->item);
            return $auction;
        }

        return null;
    }


    /**
     * Directly call WebAPI method (prefixed by "do")
     * @param  string $name method name
     * @param  [type] $args method arguments

     * @return [type]       [description]

     */
    public function __call($name, $args)
    {
        if (strpos($name, 'do') !== 0) {
            throw new Exception("Method {$name} is not implemented in " . get_class($this));
        }

        return call_user_func_array([$this->client, $name], $args);
    }

}


1		<?php
2
3		namespace Radowoj\Yaah;
4
5		use Radowoj\Yaah\Constants\SellFormOpts;
6		use Radowoj\Yaah\Journal\Deal;
7
8		class Helper
9		{
10		protected $client = null;
11
12	21	public function __construct(Client $client)
13		{
14	21	$this->client = $client;
15	21	}
16
17		/**
18		* Get simplified fields list for given category
19		* @param integer $idCategory id of category in question
20		* @return array of fields metadata
21		*/
22	2	public function getFieldsByCategory($idCategory)
23		{
24	2	$data = $this->client->doGetSellFormFieldsForCategory(['categoryId' => $idCategory]);
		0 ignored issues – show Documentation Bug introduced 2017-03-15 21:34 UTC by Report Bug Copy Issue Report The method `doGetSellFormFieldsForCategory` does not exist on `object<Radowoj\Yaah\Client>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
25
26	2	if (!isset($data->sellFormFieldsForCategory->sellFormFieldsList->item)) {
27	1	throw new Exception('Invalid WebAPI response: ' . print_r($data, 1));
28		}
29
30	1	$items = $data->sellFormFieldsForCategory->sellFormFieldsList->item;
31
32		return array_map(function ($item) {
33		return [
34	1	'fid' => $item->sellFormId,
35	1	'title' => $item->sellFormTitle,
36	1	'required' => ($item->sellFormOpt == SellFormOpts::SELL_FORM_OPT_REQUIRED),
37	1	'options' => $item->sellFormOptsValues,
38	1	'optionsDesc' => $item->sellFormDesc,
39	1	];
40	1	}, $items);
41		}
42
43		/**
44		* Create new auction
45		*
46		* @throws Exception on failure
47		*
48		* @param Auction $auction Auction to create
49		* @param integer $localId - local item id, required by WebAPI
50		* @return integer id of created auction
51		*/
52	2	public function newAuction(AuctionInterface $auction, $localId)
53		{
54	2	$auctionArray = $auction->toApiRepresentation();
55	2	$auctionArray['localId'] = $localId;
56
57	2	$resultNewAuction = $this->client->doNewAuctionExt($auctionArray);
		0 ignored issues – show Documentation Bug introduced 2017-03-15 21:34 UTC by Report Bug Copy Issue Report The method `doNewAuctionExt` does not exist on `object<Radowoj\Yaah\Client>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history... Unused Code introduced 2017-03-02 19:47 UTC by Report Bug Copy Issue Report `$resultNewAuction` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
58	2	$resultVerify = $this->client->doVerifyItem(['localId' => $localId]);
		0 ignored issues – show Documentation Bug introduced 2017-03-15 21:34 UTC by Report Bug Copy Issue Report The method `doVerifyItem` does not exist on `object<Radowoj\Yaah\Client>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
59
60	2	if (!is_object($resultVerify) \|\| !isset($resultVerify->itemId)) {
61	1	throw new Exception("Auction has not been created: " . print_r($resultVerify, 1));
62		}
63
64	1	return $resultVerify->itemId;
65		}
66
67
68		/**
69		* Finish a single auction
70		* @param integer $auctionId itemId of auction to finish
71		* @param integer $cancelAllBids whether to cancel all bids
72		* @param string $finishCancelReason reason
73		* @return array
74		*/
75	4	public function finishAuction($auctionId, $cancelAllBids = 0, $finishCancelReason = '')
76		{
77	4	return $this->finishAuctions((array)($auctionId), $cancelAllBids, $finishCancelReason);
78		}
79
80
81		/**
82		* Finish a single auction
83		* @param array $auctionIds itemIds of auctions to finish
84		* @param integer $cancelAllBids whether to cancel all bids
85		* @param string $finishCancelReason reason
86		* @return array
87		*/
88	8	public function finishAuctions(array $auctionIds, $cancelAllBids = 0, $finishCancelReason = '')
89		{
90		$finishItemsList = array_map(function ($auctionId) use ($cancelAllBids, $finishCancelReason) {
91		return [
92	8	'finishItemId' => $auctionId,
93	8	'finishCancelAllBids' => $cancelAllBids,
94	8	'finishCancelReason' => $finishCancelReason,
95	8	];
96	8	}, $auctionIds);
97
98	8	return $this->client->doFinishItems(['finishItemsList' => $finishItemsList]);
		0 ignored issues – show Documentation Bug introduced 2017-03-15 21:34 UTC by Report Bug Copy Issue Report The method `doFinishItems` does not exist on `object<Radowoj\Yaah\Client>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
99		}
100
101		/**
102		* Change quantity of items available in auction
103		* @param integer $auctionId itemId of auction to change quantity
104		* @param integer $newQuantity new quantity to set
105		* @return array
106		*/
107	1	public function changeQuantity($auctionId, $newQuantity)
108		{
109	1	return $this->client->doChangeQuantityItem([
		0 ignored issues – show Documentation Bug introduced 2017-03-15 21:34 UTC by Report Bug Copy Issue Report The method `doChangeQuantityItem` does not exist on `object<Radowoj\Yaah\Client>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
110	1	'itemId' => $auctionId,
111		'newItemQuantity' => $newQuantity
112	1	]);
113		}
114
115
116		/**
117		* Return site journal deals
118		* @param integer $journalStart start point (dealEventId)
119		* @return array
120		*/
121	3	public function getSiteJournalDeals($journalStart = 0)
122		{
123	3	$response = $this->client->doGetSiteJournalDeals(['journalStart' => $journalStart]);
		0 ignored issues – show Documentation Bug introduced 2017-03-15 21:34 UTC by Report Bug Copy Issue Report The method `doGetSiteJournalDeals` does not exist on `object<Radowoj\Yaah\Client>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
124	3	if (isset($response->siteJournalDeals->item)) {
125	2	return array_map(function($deal){
126	2	return new Deal($deal);
127	2	}, $response->siteJournalDeals->item);
128		}
129
130	1	throw new Exception("Unable to get site journal deals: " . print_r($response, 1));
131		}
132
133
134		/**
135		* @param integer $itemId id of auction to get
136		* @return Auction \| null
137		*/
138		public function getAuctionByItemId($itemId)
139		{
140		$response = $this->client->doGetItemFields(['itemId' => $itemId]);
		0 ignored issues – show Documentation Bug introduced 2017-03-15 21:34 UTC by Report Bug Copy Issue Report The method `doGetItemFields` does not exist on `object<Radowoj\Yaah\Client>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
141		if (isset($response->itemFields->item)) {
142		$auction = new Auction();
143		$auction->fromApiRepresentation($response->itemFields->item);
144		return $auction;
145		}
146
147		return null;
148		}
149
150
151		/**
152		* Directly call WebAPI method (prefixed by "do")
153		* @param string $name method name
154		* @param [type] $args method arguments
		0 ignored issues – show Documentation introduced 2017-03-15 21:34 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
155		* @return [type] [description]
		0 ignored issues – show Documentation introduced 2017-03-15 21:34 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
156		*/
157	3	public function __call($name, $args)
158		{
159	3	if (strpos($name, 'do') !== 0) {
160	1	throw new Exception("Method {$name} is not implemented in " . get_class($this));
161		}
162
163	2	return call_user_func_array([$this->client, $name], $args);
164		}
165
166		}
167

radowoj / yaah

Push — master ( 57713c...d5a8e5 )

Helper A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

9 Methods

Duplication Side-by-Side

Filter issues like