PaginatedKnpLabsRepoFacade - Code Metrics - Inspection of "Core structures" - devboard/github-api-facade - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#8)

by Miro

created 2016-02-21 16:17 UTC

PaginatedKnpLabsRepoFacade A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	239
Duplicated Lines	20.08 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	4
Bugs	0	Features	1

Metric	Value
wmc	20
c	4
b	0
f	1
lcom	1
cbo	3
dl	48
loc	239
rs	10

17 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	fetchDetails()	0	8	1
A	fetchBranch()	0	9	1
A	fetchAllBranches()	0	10	2
A	fetchAllBranchNames()	9	9	1
A	fetchAllTagNames()	9	9	1
A	fetchCommit()	0	9	1
A	fetchCommitStatus()	0	9	1
A	fetchCommitStatuses()	0	9	1
A	fetchAllPullRequests()	10	10	1
A	fetchAllMilestones()	10	10	1
A	fetchAllIssues()	0	12	3
A	fetchAllIssuesAndPullRequests()	10	10	1
A	getRepoApi()	0	4	1
A	getIssueApi()	0	4	1
A	getMilestonesApi()	0	4	1
A	getPullRequestApi()	0	4	1

How to fix Duplicated Code

<?php
namespace DevBoardLib\GithubApiFacade\Repo;

use DevBoardLib\GithubCore\Repo\GithubRepo;
use Github\Client;
use Github\ResultPager;

/**
 * Class PaginatedKnpLabsRepoFacade.
 */
class PaginatedKnpLabsRepoFacade implements RepoFacade
{
    private $client;
    private $githubRepo;

    private $paginator;

    /**
     * PaginatedKnpLabsRepoFacade constructor.
     *
     * @param $client
     * @param $githubRepo
     */
    public function __construct(Client $client, GithubRepo $githubRepo)
    {
        $this->client     = $client;
        $this->githubRepo = $githubRepo;

        $this->paginator = new ResultPager($this->client);
    }

    /**
     * Fetches GithubRepo details.
     *
     * @return array
     */
    public function fetchDetails()
    {
        return $this->getRepoApi()
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->show(
                $this->githubRepo->getOwner(),

                $this->githubRepo->getName()

            );
    }

    /**
     * Fetches GithubBranch details.
     *
     * @param $branchName
     *
     * @return array
     */
    public function fetchBranch($branchName)
    {
        return $this->getRepoApi()
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->branches(
                $this->githubRepo->getOwner(),
                $this->githubRepo->getName(),
                $branchName
            );
    }

    /**
     * @return array
     */
    public function fetchAllBranches()
    {
        $results = [];

        foreach ($this->fetchAllBranchNames() as $branchData) {
            $results[] = $this->fetchBranch($branchData['name']);
        }

        return $results;
    }

    /**
     * @return array
     */
    public function fetchAllBranchNames()

    {
        $parameters = [
            $this->githubRepo->getOwner(),
            $this->githubRepo->getName(),
        ];

        return $this->paginator->fetchAll($this->getRepoApi(), 'branches', $parameters);
    }

    /**
     * @return array
     */
    public function fetchAllTagNames()

    {
        $parameters = [
            $this->githubRepo->getOwner(),
            $this->githubRepo->getName(),
        ];

        return $this->paginator->fetchAll($this->getRepoApi(), 'tags', $parameters);
    }

    /**
     * Fetches GithubCommit details.
     *
     * @param $commitSha
     *
     * @return array
     */
    public function fetchCommit($commitSha)
    {
        return $this->getRepoApi()->commits()
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->show(
                $this->githubRepo->getOwner(),
                $this->githubRepo->getName(),
                $commitSha
            );
    }

    /**
     * Fetches GithubCommit status.
     *
     * @param $commitSha
     *
     * @return array
     */
    public function fetchCommitStatus($commitSha)
    {
        return $this->getRepoApi()->statuses()
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->combined(
                $this->githubRepo->getOwner(),
                $this->githubRepo->getName(),
                $commitSha
            );
    }

    /**
     * Fetches list of GithubCommit statuses.
     *
     * @param $commitSha
     *
     * @return array
     */
    public function fetchCommitStatuses($commitSha)
    {
        return $this->getRepoApi()->statuses()
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->show(
                $this->githubRepo->getOwner(),
                $this->githubRepo->getName(),
                $commitSha
            );
    }

    /**
     * @return array
     */
    public function fetchAllPullRequests()

    {
        $parameters = [
            $this->githubRepo->getOwner(),
            $this->githubRepo->getName(),
            ['state' => 'all'],
        ];

        return $this->paginator->fetchAll($this->getPullRequestApi(), 'all', $parameters);
    }

    /**
     * @return array
     */
    public function fetchAllMilestones()

    {
        $parameters = [
            $this->githubRepo->getOwner(),
            $this->githubRepo->getName(),
            ['state' => 'all'],
        ];

        return $this->paginator->fetchAll($this->getMilestonesApi(), 'all', $parameters);
    }

    /**
     * Returns all issues.
     *
     * IMPORTANT:
     * - GitHub API v3 returns both issues and pullRequests together so filtering needs to be done
     * - Pull requests have 'pull_request' key.
     *
     * @return array
     */
    public function fetchAllIssues()
    {
        $results = [];

        foreach ($this->fetchAllIssuesAndPullRequests() as $result) {
            if (!array_key_exists('pull_request', $result)) {
                $results[] = $result;
            }
        }

        return $results;
    }

    /**
     * @return array
     */
    public function fetchAllIssuesAndPullRequests()

    {
        $parameters = [
            $this->githubRepo->getOwner(),
            $this->githubRepo->getName(),
            ['state' => 'all'],
        ];

        return $this->paginator->fetchAll($this->getIssueApi(), 'all', $parameters);
    }

    /**
     * @return \Github\Api\ApiInterface
     */
    private function getRepoApi()
    {
        return $this->client->api('repository');
    }

    /**
     * @return \Github\Api\ApiInterface
     */
    private function getIssueApi()
    {
        return $this->client->api('issues');
    }

    /**
     * @return \Github\Api\Issue\Milestones
     */
    private function getMilestonesApi()
    {
        return $this->getIssueApi()->milestones();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    /**
     * @return \Github\Api\PullRequest
     */
    private function getPullRequestApi()
    {
        return $this->client->api('pull_requests');
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


Pull Request — master (#8)

PaginatedKnpLabsRepoFacade A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

17 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1		<?php
2		namespace DevBoardLib\GithubApiFacade\Repo;
3
4		use DevBoardLib\GithubCore\Repo\GithubRepo;
5		use Github\Client;
6		use Github\ResultPager;
7
8		/**
9		* Class PaginatedKnpLabsRepoFacade.
10		*/
11		class PaginatedKnpLabsRepoFacade implements RepoFacade
12		{
13		private $client;
14		private $githubRepo;
15
16		private $paginator;
17
18		/**
19		* PaginatedKnpLabsRepoFacade constructor.
20		*
21		* @param $client
22		* @param $githubRepo
23		*/
24		public function __construct(Client $client, GithubRepo $githubRepo)
25		{
26		$this->client = $client;
27		$this->githubRepo = $githubRepo;
28
29		$this->paginator = new ResultPager($this->client);
30		}
31
32		/**
33		* Fetches GithubRepo details.
34		*
35		* @return array
36		*/
37		public function fetchDetails()
38		{
39		return $this->getRepoApi()
		0 ignored issues – show Bug introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The call to `show()` misses a required argument `$id`. This check looks for function calls that miss required arguments. Loading history... Bug introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The method `show` does only exist in `Github\Api\Authorization...epo and Github\Api\User`, but not in `Github\Api\Deployment an...t and Github\Api\Search`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
40		->show(
41		$this->githubRepo->getOwner(),
		0 ignored issues – show Unused Code introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The call to `CurrentUser::show()` has too many arguments starting with `$this->githubRepo->getOwner()`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
42		$this->githubRepo->getName()
		0 ignored issues – show Unused Code introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The call to `Gists::show()` has too many arguments starting with `$this->githubRepo->getName()`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history... Unused Code introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The call to `Organization::show()` has too many arguments starting with `$this->githubRepo->getName()`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history... Unused Code introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The call to `Teams::show()` has too many arguments starting with `$this->githubRepo->getName()`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history... Unused Code introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The call to `Authorizations::show()` has too many arguments starting with `$this->githubRepo->getName()`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history... Unused Code introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The call to `User::show()` has too many arguments starting with `$this->githubRepo->getName()`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
43		);
44		}
45
46		/**
47		* Fetches GithubBranch details.
48		*
49		* @param $branchName
50		*
51		* @return array
52		*/
53		public function fetchBranch($branchName)
54		{
55		return $this->getRepoApi()
		0 ignored issues – show Bug introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The method `branches` does only exist in `Github\Api\Repo`, but not in `Github\Api\Authorization...rch and Github\Api\User`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
56		->branches(
57		$this->githubRepo->getOwner(),
58		$this->githubRepo->getName(),
59		$branchName
60		);
61		}
62
63		/**
64		* @return array
65		*/
66		public function fetchAllBranches()
67		{
68		$results = [];
69
70		foreach ($this->fetchAllBranchNames() as $branchData) {
71		$results[] = $this->fetchBranch($branchData['name']);
72		}
73
74		return $results;
75		}
76
77		/**
78		* @return array
79		*/
80	View Code Duplication	public function fetchAllBranchNames()
		0 ignored issues – show Duplication introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
81		{
82		$parameters = [
83		$this->githubRepo->getOwner(),
84		$this->githubRepo->getName(),
85		];
86
87		return $this->paginator->fetchAll($this->getRepoApi(), 'branches', $parameters);
88		}
89
90		/**
91		* @return array
92		*/
93	View Code Duplication	public function fetchAllTagNames()
		0 ignored issues – show Duplication introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
94		{
95		$parameters = [
96		$this->githubRepo->getOwner(),
97		$this->githubRepo->getName(),
98		];
99
100		return $this->paginator->fetchAll($this->getRepoApi(), 'tags', $parameters);
101		}
102
103		/**
104		* Fetches GithubCommit details.
105		*
106		* @param $commitSha
107		*
108		* @return array
109		*/
110		public function fetchCommit($commitSha)
111		{
112		return $this->getRepoApi()->commits()
		0 ignored issues – show Bug introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The call to `commits()` misses a required argument `$id`. This check looks for function calls that miss required arguments. Loading history... Bug introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The call to `commits()` misses some required arguments starting with `$username`. Loading history... Bug introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The method `commits` does only exist in `Github\Api\Gists and Git...est and Github\Api\Repo`, but not in `Github\Api\Authorization...rch and Github\Api\User`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
113		->show(
114		$this->githubRepo->getOwner(),
115		$this->githubRepo->getName(),
116		$commitSha
117		);
118		}
119
120		/**
121		* Fetches GithubCommit status.
122		*
123		* @param $commitSha
124		*
125		* @return array
126		*/
127		public function fetchCommitStatus($commitSha)
128		{
129		return $this->getRepoApi()->statuses()
		0 ignored issues – show Bug introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The method `statuses` does only exist in `Github\Api\Repo`, but not in `Github\Api\Authorization...rch and Github\Api\User`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
130		->combined(
131		$this->githubRepo->getOwner(),
132		$this->githubRepo->getName(),
133		$commitSha
134		);
135		}
136
137		/**
138		* Fetches list of GithubCommit statuses.
139		*
140		* @param $commitSha
141		*
142		* @return array
143		*/
144		public function fetchCommitStatuses($commitSha)
145		{
146		return $this->getRepoApi()->statuses()
		0 ignored issues – show Bug introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The method `statuses` does only exist in `Github\Api\Repo`, but not in `Github\Api\Authorization...rch and Github\Api\User`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
147		->show(
148		$this->githubRepo->getOwner(),
149		$this->githubRepo->getName(),
150		$commitSha
151		);
152		}
153
154		/**
155		* @return array
156		*/
157	View Code Duplication	public function fetchAllPullRequests()
		0 ignored issues – show Duplication introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
158		{
159		$parameters = [
160		$this->githubRepo->getOwner(),
161		$this->githubRepo->getName(),
162		['state' => 'all'],
163		];
164
165		return $this->paginator->fetchAll($this->getPullRequestApi(), 'all', $parameters);
166		}
167
168		/**
169		* @return array
170		*/
171	View Code Duplication	public function fetchAllMilestones()
		0 ignored issues – show Duplication introduced 2016-02-11 15:41 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
172		{
173		$parameters = [
174		$this->githubRepo->getOwner(),
175		$this->githubRepo->getName(),
176		['state' => 'all'],
177		];
178
179		return $this->paginator->fetchAll($this->getMilestonesApi(), 'all', $parameters);
180		}
181
182		/**
183		* Returns all issues.
184		*
185		* IMPORTANT:
186		* - GitHub API v3 returns both issues and pullRequests together so filtering needs to be done
187		* - Pull requests have 'pull_request' key.
188		*
189		* @return array
190		*/
191		public function fetchAllIssues()
192		{
193		$results = [];
194
195		foreach ($this->fetchAllIssuesAndPullRequests() as $result) {
196		if (!array_key_exists('pull_request', $result)) {
197		$results[] = $result;
198		}
199		}
200
201		return $results;
202		}
203
204		/**
205		* @return array
206		*/
207	View Code Duplication	public function fetchAllIssuesAndPullRequests()
		0 ignored issues – show Duplication introduced 2016-02-13 16:46 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
208		{
209		$parameters = [
210		$this->githubRepo->getOwner(),
211		$this->githubRepo->getName(),
212		['state' => 'all'],
213		];
214
215		return $this->paginator->fetchAll($this->getIssueApi(), 'all', $parameters);
216		}
217
218		/**
219		* @return \Github\Api\ApiInterface
220		*/
221		private function getRepoApi()
222		{
223		return $this->client->api('repository');
224		}
225
226		/**
227		* @return \Github\Api\ApiInterface
228		*/
229		private function getIssueApi()
230		{
231		return $this->client->api('issues');
232		}
233
234		/**
235		* @return \Github\Api\Issue\Milestones
236		*/
237		private function getMilestonesApi()
238		{
239		return $this->getIssueApi()->milestones();
		0 ignored issues – show Bug introduced 2016-02-11 15:41 UTC by Report Bug Copy Issue Report The call to `milestones()` misses some required arguments starting with `$username`. Loading history... Bug introduced 2016-02-11 15:41 UTC by Report Bug Copy Issue Report The method `milestones` does only exist in `Github\Api\Issue and Github\Api\Repo`, but not in `Github\Api\Authorization...rch and Github\Api\User`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
240		}
241
242		/**
243		* @return \Github\Api\PullRequest
244		*/
245		private function getPullRequestApi()
246		{
247		return $this->client->api('pull_requests');
		0 ignored issues – show Bug Best Practice introduced 2016-02-21 16:20 UTC by Report Bug Copy Issue Report The return type of `return $this->client->api('pull_requests');` (`Github\Api\CurrentUser\|G...pi\Meta\|Github\Api\User`) is incompatible with the return type documented by `DevBoardLib\GithubApiFac...cade::getPullRequestApi` of type `Github\Api\PullRequest`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
248		}
249		}
250

devboard / github-api-facade

Pull Request — master (#8)

PaginatedKnpLabsRepoFacade A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

17 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like