CareercastProvider::getDefaultResponseFields() - Code Metrics - Inspection of "Adding method to set validthrough as object" - jobapis/jobs-careercast - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f95505...a1ea25 )

by Karl

created 2016-10-07 00:00 UTC

CareercastProvider::getDefaultResponseFields() A

↳ Parent: CareercastProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines	17
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	17
ccs	14
cts	14
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	14
nc	1
nop	0
crap	1

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

use JobApis\Jobs\Client\Job;

class CareercastProvider extends AbstractProvider
{
    /**
     * Returns the standardized job object
     *
     * @param array $payload
     *
     * @return \JobApis\Jobs\Client\Job
     */
    public function createJobObject($payload)
    {
        $job = new Job([
            'description' => $payload['Description'],
            'title' => $payload['JobTitle'],
            'name' => $payload['JobTitle'],
            'url' => $payload['Url'],
            'sourceId' => $payload['Id'],
            'qualifications' => $payload['Requirements'],
            'maximumSalaray' => $payload['SalaryMax'],
            'minimumSalaray' => $payload['SalaryMin'],
            'baseSalaray' => $payload['SalaryMin'],
        ]);
        $job->setDatePostedAsString($payload['PostDate']);
        $job = $this->setValidThroughAsString($payload['ExpireDate'], $job);
        $job = $this->setCategory($payload, $job);
        $job = $this->setCompany($payload, $job);
        return $this->setLocation($payload, $job);
    }

    /**
     * Job response object default keys that should be set
     *
     * @return  string
     */
    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());
}
            'Description',
            'JobTitle',
            'Url',
            'Id',
            'PostDate',
            'ExpireDate',
            'Requirements',
            'SalaryMax',
            'SalaryMin',
            'SalaryMin',
            'CategoryDisplay',
            'WorkStatusDisplay',
        ];
    }

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

    /**
     * Parses the category and work type and attaches it to the job
     *
     * @param $payload array
     * @param $job \JobApis\Jobs\Client\Job
     *
     * @return \JobApis\Jobs\Client\Job
     */
    protected function setCategory($payload, $job)
    {
        if (isset($payload['CategoryDisplay']) && is_array($payload['CategoryDisplay'])) {
            $job->setOccupationalCategory(implode(', ', $payload['CategoryDisplay']));
        }
        if (isset($payload['CategoryDisplay']) && is_array($payload['WorkStatusDisplay'])) {
            $job->setEmploymentType(implode(', ', $payload['WorkStatusDisplay']));
        }
        return $job;
    }

    /**
     * Parses the company name and attaches it to the job
     *
     * @param $payload array
     * @param $job \JobApis\Jobs\Client\Job
     *
     * @return \JobApis\Jobs\Client\Job
     */
    protected function setCompany($payload, $job)
    {
        if (isset($payload['Company'])) {
            $job->setCompany($payload['Company']);
        }
        return $job;
    }

    /**
     * Parses the location and attaches it to the job
     *
     * @param $payload array
     * @param $job \JobApis\Jobs\Client\Job
     *
     * @return \JobApis\Jobs\Client\Job
     */
    protected function setLocation($payload, $job)
    {
        if (isset($payload['FormattedCityState'])) {
            $job->setLocation($payload['FormattedCityState']);
        }
        if (isset($payload['State'])) {
            $job->setState($payload['State']);
        }
        if (isset($payload['Country'])) {
            $job->setCountry($payload['Country']);
        }
        if (isset($payload['City'])) {
            $job->setCity($payload['City']);
        }
        if (isset($payload['Longitude'])) {
            $job->setLongitude($payload['Longitude']);
        }
        if (isset($payload['Latitude'])) {
            $job->setLatitude($payload['Latitude']);
        }
        if (isset($payload['Zip'])) {
            $job->setPostalCode($payload['Zip']);
        }
        return $job;
    }

    /**
     * Sets validThrough.
     *
     * @param string $validThrough
     * @param $job \JobApis\Jobs\Client\Job
     *
     * @return $job

     */
    protected function setValidThroughAsString($validThrough, $job)
    {
        if (strtotime($validThrough) !== false) {
            $job->validThrough = new \DateTime($validThrough);
        }

        return $job;
    }
}


1		<?php namespace JobApis\Jobs\Client\Providers;
2
3		use JobApis\Jobs\Client\Job;
4
5		class CareercastProvider extends AbstractProvider
6		{
7		/**
8		* Returns the standardized job object
9		*
10		* @param array $payload
11		*
12		* @return \JobApis\Jobs\Client\Job
13		*/
14	4	public function createJobObject($payload)
15		{
16	4	$job = new Job([
17	4	'description' => $payload['Description'],
18	4	'title' => $payload['JobTitle'],
19	4	'name' => $payload['JobTitle'],
20	4	'url' => $payload['Url'],
21	4	'sourceId' => $payload['Id'],
22	4	'qualifications' => $payload['Requirements'],
23	4	'maximumSalaray' => $payload['SalaryMax'],
24	4	'minimumSalaray' => $payload['SalaryMin'],
25	4	'baseSalaray' => $payload['SalaryMin'],
26	4	]);
27	4	$job->setDatePostedAsString($payload['PostDate']);
28	4	$job = $this->setValidThroughAsString($payload['ExpireDate'], $job);
29	4	$job = $this->setCategory($payload, $job);
30	4	$job = $this->setCompany($payload, $job);
31	4	return $this->setLocation($payload, $job);
32		}
33
34		/**
35		* Job response object default keys that should be set
36		*
37		* @return string
38		*/
39	4	public function getDefaultResponseFields()
40		{
41		return [
		0 ignored issues – show Bug Best Practice introduced 2016-09-22 16:59 UTC by Report Bug Copy Issue Report The return type of `return array('Descriptio..., 'WorkStatusDisplay');` (`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...
42	4	'Description',
43	4	'JobTitle',
44	4	'Url',
45	4	'Id',
46	4	'PostDate',
47	4	'ExpireDate',
48	4	'Requirements',
49	4	'SalaryMax',
50	4	'SalaryMin',
51	4	'SalaryMin',
52	4	'CategoryDisplay',
53	4	'WorkStatusDisplay',
54	4	];
55		}
56
57		/**
58		* Get listings path
59		*
60		* @return string
61		*/
62	4	public function getListingsPath()
63		{
64	4	return 'Jobs';
65		}
66
67		/**
68		* Parses the category and work type and attaches it to the job
69		*
70		* @param $payload array
71		* @param $job \JobApis\Jobs\Client\Job
72		*
73		* @return \JobApis\Jobs\Client\Job
74		*/
75	4	protected function setCategory($payload, $job)
76		{
77	4	if (isset($payload['CategoryDisplay']) && is_array($payload['CategoryDisplay'])) {
78	4	$job->setOccupationalCategory(implode(', ', $payload['CategoryDisplay']));
79	4	}
80	4	if (isset($payload['CategoryDisplay']) && is_array($payload['WorkStatusDisplay'])) {
81	4	$job->setEmploymentType(implode(', ', $payload['WorkStatusDisplay']));
82	4	}
83	4	return $job;
84		}
85
86		/**
87		* Parses the company name and attaches it to the job
88		*
89		* @param $payload array
90		* @param $job \JobApis\Jobs\Client\Job
91		*
92		* @return \JobApis\Jobs\Client\Job
93		*/
94	4	protected function setCompany($payload, $job)
95		{
96	4	if (isset($payload['Company'])) {
97	4	$job->setCompany($payload['Company']);
98	4	}
99	4	return $job;
100		}
101
102		/**
103		* Parses the location and attaches it to the job
104		*
105		* @param $payload array
106		* @param $job \JobApis\Jobs\Client\Job
107		*
108		* @return \JobApis\Jobs\Client\Job
109		*/
110	4	protected function setLocation($payload, $job)
111		{
112	4	if (isset($payload['FormattedCityState'])) {
113	4	$job->setLocation($payload['FormattedCityState']);
114	4	}
115	4	if (isset($payload['State'])) {
116	4	$job->setState($payload['State']);
117	4	}
118	4	if (isset($payload['Country'])) {
119	4	$job->setCountry($payload['Country']);
120	4	}
121	4	if (isset($payload['City'])) {
122	4	$job->setCity($payload['City']);
123	4	}
124	4	if (isset($payload['Longitude'])) {
125	4	$job->setLongitude($payload['Longitude']);
126	4	}
127	4	if (isset($payload['Latitude'])) {
128	4	$job->setLatitude($payload['Latitude']);
129	4	}
130	4	if (isset($payload['Zip'])) {
131	4	$job->setPostalCode($payload['Zip']);
132	4	}
133	4	return $job;
134		}
135
136		/**
137		* Sets validThrough.
138		*
139		* @param string $validThrough
140		* @param $job \JobApis\Jobs\Client\Job
141		*
142		* @return $job
		0 ignored issues – show Documentation introduced 2016-10-07 00:09 UTC by Report Bug Copy Issue Report The doc-type `$job` could not be parsed: Unknown type name "$job" 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...
143		*/
144	4	protected function setValidThroughAsString($validThrough, $job)
145		{
146	4	if (strtotime($validThrough) !== false) {
147	4	$job->validThrough = new \DateTime($validThrough);
148	4	}
149
150	4	return $job;
151		}
152		}
153

jobapis / jobs-careercast

Push — master ( f95505...a1ea25 )

CareercastProvider::getDefaultResponseFields() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like