CraigslistProvider - Code Metrics - jobapis/jobs-craigslist - Measure and Improve Code Quality continuously with Scrutinizer

CraigslistProvider A
last analyzed 2017-04-06 01:46 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	6
c	1
b	0
f	0
lcom	1
cbo	3
dl	0
loc	60
ccs	20
cts	20
cp	1
rs	10

4 Methods

Rating	Name	Size	Complexity
A	createJobObject()	16	3
A	getDefaultResponseFields()	8	1
A	getFormat()	4	1
A	getListingsPath()	4	1

<?php namespace JobApis\Jobs\Client\Providers;

use JobApis\Jobs\Client\Job;

class CraigslistProvider extends AbstractProvider
{
    /**
     * Returns the standardized job object
     *
     * @param array $payload
     *
     * @return \JobApis\Jobs\Client\Job
     */
    public function createJobObject($payload)
    {
        $job = new Job([
            'title' => $payload['title'],
            'name' => $payload['title'],
            'description' => $payload['description'],
            'url' => $payload['link'],
        ]);

        // Set a location if it was set in the query
        if ($this->query && $this->query->get('location')) {
            $job->setLocation($this->query->get('location'));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        return $job;
    }

    /**
     * Job response object default keys that should be set
     *
     * @return  array
     */
    public function getDefaultResponseFields()
    {
        return [
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());
}
            'title',
            'link',
            'description',
        ];
    }

    /**
     * Get format
     *
     * @return  string Currently only 'json' and 'xml' supported
     */
    public function getFormat()
    {
        return 'xml';
    }

    /**
     * Get listings path
     *
     * @return  string
     */
    public function getListingsPath()
    {
        return 'item';
    }
}


1		<?php namespace JobApis\Jobs\Client\Providers;
2
3		use JobApis\Jobs\Client\Job;
4
5		class CraigslistProvider extends AbstractProvider
6		{
7		/**
8		* Returns the standardized job object
9		*
10		* @param array $payload
11		*
12		* @return \JobApis\Jobs\Client\Job
13		*/
14	6	public function createJobObject($payload)
15		{
16	6	$job = new Job([
17	6	'title' => $payload['title'],
18	6	'name' => $payload['title'],
19	6	'description' => $payload['description'],
20	6	'url' => $payload['link'],
21	6	]);
22
23		// Set a location if it was set in the query
24	6	if ($this->query && $this->query->get('location')) {
25	4	$job->setLocation($this->query->get('location'));
		0 ignored issues – show Documentation introduced 2017-01-12 21:19 UTC by Report Bug Copy Issue Report `$this->query->get('location')` is of type `object<JobApis\Jobs\Client\Queries\AbstractQuery>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
26	4	}
27
28	6	return $job;
29		}
30
31		/**
32		* Job response object default keys that should be set
33		*
34		* @return array
35		*/
36	4	public function getDefaultResponseFields()
37		{
38		return [
		0 ignored issues – show Bug Best Practice introduced 2017-01-12 21:19 UTC by Report Bug Copy Issue Report The return type of `return array('title', 'link', 'description');` (`string[]`) is incompatible with the return type declared by the abstract method `JobApis\Jobs\Client\Prov...etDefaultResponseFields` of type `string`. 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...
39	4	'title',
40	4	'link',
41	4	'description',
42	4	];
43		}
44
45		/**
46		* Get format
47		*
48		* @return string Currently only 'json' and 'xml' supported
49		*/
50	4	public function getFormat()
51		{
52	4	return 'xml';
53		}
54
55		/**
56		* Get listings path
57		*
58		* @return string
59		*/
60	4	public function getListingsPath()
61		{
62	4	return 'item';
63		}
64		}
65

jobapis / jobs-craigslist

CraigslistProvider A last analyzed 2017-04-06 01:46 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Duplication Side-by-Side

Filter issues like

CraigslistProvider A
last analyzed 2017-04-06 01:46 UTC