JobinventoryProvider::createJobObject() - Code Metrics - jobapis/jobs-jobinventory - Measure and Improve Code Quality continuously with Scrutinizer

JobinventoryProvider::createJobObject() B
last analyzed 2016-10-29 19:14 UTC

↳ Parent: JobinventoryProvider

Complexity

Conditions	5
Paths	4

Size

Total Lines	23
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	5

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	23
ccs	15
cts	15
cp	1
rs	8.5906
cc	5
eloc	12
nc	4
nop	1
crap	5

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

use JobApis\Jobs\Client\Job;

class JobinventoryProvider 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'],
        ]);

        $job->setDatePostedAsString($payload['pubDate']);

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

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

// Instead of
acceptsInteger($x);

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

        // Set a company if it was set in the query
        if ($this->query && $this->query->get('company')) {
            $job->setCompany($this->query->get('company'));
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',
            'pubDate',
        ];
    }

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

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


1		<?php namespace JobApis\Jobs\Client\Providers;
2
3		use JobApis\Jobs\Client\Job;
4
5		class JobinventoryProvider extends AbstractProvider
6		{
7		/**
8		* Returns the standardized job object
9		*
10		* @param array $payload
11		*
12		* @return \JobApis\Jobs\Client\Job
13		*/
14	8	public function createJobObject($payload)
15		{
16	8	$job = new Job([
17	8	'title' => $payload['title'],
18	8	'name' => $payload['title'],
19	8	'description' => $payload['description'],
20	8	'url' => $payload['link'],
21	8	]);
22
23	8	$job->setDatePostedAsString($payload['pubDate']);
24
25		// Set a location if it was set in the query
26	8	if ($this->query && $this->query->get('l')) {
27	4	$job->setLocation($this->query->get('l'));
		0 ignored issues – show Documentation introduced 2016-10-29 19:13 UTC by Report Bug Copy Issue Report `$this->query->get('l')` 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...
28	4	}
29
30		// Set a company if it was set in the query
31	8	if ($this->query && $this->query->get('company')) {
32	2	$job->setCompany($this->query->get('company'));
		0 ignored issues – show Documentation introduced 2016-10-29 19:13 UTC by Report Bug Copy Issue Report `$this->query->get('company')` 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...
33	2	}
34
35	8	return $job;
36		}
37
38		/**
39		* Job response object default keys that should be set
40		*
41		* @return array
42		*/
43	4	public function getDefaultResponseFields()
44		{
45		return [
		0 ignored issues – show Bug Best Practice introduced 2016-10-29 19:13 UTC by Report Bug Copy Issue Report The return type of `return array('title', 'l...scription', 'pubDate');` (`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...
46	4	'title',
47	4	'link',
48	4	'description',
49	4	'pubDate',
50	4	];
51		}
52
53		/**
54		* Get format
55		*
56		* @return string Currently only 'json' and 'xml' supported
57		*/
58	4	public function getFormat()
59		{
60	4	return 'xml';
61		}
62
63		/**
64		* Get listings path
65		*
66		* @return string
67		*/
68	4	public function getListingsPath()
69		{
70	4	return 'channel.item';
71		}
72		}
73

jobapis / jobs-jobinventory

JobinventoryProvider::createJobObject() B last analyzed 2016-10-29 19:14 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

JobinventoryProvider::createJobObject() B
last analyzed 2016-10-29 19:14 UTC