Worker::getTransport() - Code Metrics - cronario/messenger - Measure and Improve Code Quality continuously with Scrutinizer

Worker::getTransport() A
last analyzed 2015-12-11 11:05 UTC

↳ Parent: Worker

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php

namespace Messenger\Hipchat;

use Cronario\AbstractJob;
use Cronario\AbstractWorker;

/**
 * Class Worker
 *
 * @package Messenger\Sms\Alpha
 */
class Worker extends AbstractWorker
{

    // region VALIDATE ********************************************************

    /**
     * @param Job $job
     *
     * @throws ResultException
     */
    protected function validateJobParams(Job $job)
    {
        if (empty($job->getToken())) {
            throw new ResultException(ResultException::ERROR_PARAM_TOKEN);
        }

        if (empty($job->getRoom())) {
            throw new ResultException(ResultException::ERROR_PARAM_ROOM);
        }

        if (empty($job->getFrom())) {
            throw new ResultException(ResultException::ERROR_PARAM_FROM);
        }

        if (empty($job->getMsg())) {
            throw new ResultException(ResultException::ERROR_PARAM_MSG);
        }

    }

    // endregion *************************************************************

    /**
     * @param $token
     *
     * @return \HipChat\HipChat
     */
    public function getTransport($token)
    {
        return new \HipChat\HipChat($token);
    }

    /**
     * @param Job $job
     *
     * @return bool
     */
    protected function sendMessage(Job $job)
    {
        // prepare transport
        $transport = $this->getTransport($job->getToken());

        // Send message
        $response = $transport->message_room(
            $job->getRoom(),
            $job->getFrom(),
            $job->getMsg(),
            false,
            $job->getColour() ?: \HipChat\HipChat::COLOR_YELLOW,
            $job->getFormat() ?: \HipChat\HipChat::FORMAT_TEXT
        );

        return $response;
    }

    /**
     * @param AbstractJob|Job $job
     *
     * @throws ResultException
     */
    protected function doJob(AbstractJob $job)
    {
        $this->validateJobParams($job);


        try {
            $resultData['response'] = $this->sendMessage($job);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        } catch (\Exception $ex) {
            throw new ResultException(ResultException::ERROR_TRANSPORT);
        }

        throw new ResultException(ResultException::R_SUCCESS, $resultData);
    }
}

1		<?php
2
3		namespace Messenger\Hipchat;
4
5		use Cronario\AbstractJob;
6		use Cronario\AbstractWorker;
7
8		/**
9		* Class Worker
10		*
11		* @package Messenger\Sms\Alpha
12		*/
13		class Worker extends AbstractWorker
14		{
15
16		// region VALIDATE ********************************************************
17
18		/**
19		* @param Job $job
20		*
21		* @throws ResultException
22		*/
23	2	protected function validateJobParams(Job $job)
24		{
25	2	if (empty($job->getToken())) {
26	1	throw new ResultException(ResultException::ERROR_PARAM_TOKEN);
27		}
28
29	2	if (empty($job->getRoom())) {
30	1	throw new ResultException(ResultException::ERROR_PARAM_ROOM);
31		}
32
33	2	if (empty($job->getFrom())) {
34	1	throw new ResultException(ResultException::ERROR_PARAM_FROM);
35		}
36
37	2	if (empty($job->getMsg())) {
38	1	throw new ResultException(ResultException::ERROR_PARAM_MSG);
39		}
40
41	1	}
42
43		// endregion *************************************************************
44
45		/**
46		* @param $token
47		*
48		* @return \HipChat\HipChat
49		*/
50	1	public function getTransport($token)
51		{
52	1	return new \HipChat\HipChat($token);
53		}
54
55		/**
56		* @param Job $job
57		*
58		* @return bool
59		*/
60	1	protected function sendMessage(Job $job)
61		{
62		// prepare transport
63	1	$transport = $this->getTransport($job->getToken());
64
65		// Send message
66	1	$response = $transport->message_room(
67	1	$job->getRoom(),
68	1	$job->getFrom(),
69	1	$job->getMsg(),
70	1	false,
71	1	$job->getColour() ?: \HipChat\HipChat::COLOR_YELLOW,
72	1	$job->getFormat() ?: \HipChat\HipChat::FORMAT_TEXT
73	1	);
74
75	1	return $response;
76		}
77
78		/**
79		* @param AbstractJob\|Job $job
80		*
81		* @throws ResultException
82		*/
83	2	protected function doJob(AbstractJob $job)
84		{
85	2	$this->validateJobParams($job);
		0 ignored issues – show Compatibility introduced 2015-12-10 09:29 UTC by Report Bug Copy Issue Report `$job` of type `object<Cronario\AbstractJob>` is not a sub-type of `object<Messenger\Hipchat\Job>`. It seems like you assume a child class of the class `Cronario\AbstractJob` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
86
87		try {
88	1	$resultData['response'] = $this->sendMessage($job);
		0 ignored issues – show Coding Style Comprehensibility introduced 2015-12-10 09:29 UTC by Report Bug Copy Issue Report `$resultData` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$resultData = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history... Compatibility introduced 2015-12-10 09:29 UTC by Report Bug Copy Issue Report `$job` of type `object<Cronario\AbstractJob>` is not a sub-type of `object<Messenger\Hipchat\Job>`. It seems like you assume a child class of the class `Cronario\AbstractJob` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
89	1	} catch (\Exception $ex) {
90		throw new ResultException(ResultException::ERROR_TRANSPORT);
91		}
92
93	1	throw new ResultException(ResultException::R_SUCCESS, $resultData);
94		}
95		}

cronario / messenger

Worker::getTransport() A last analyzed 2015-12-11 11:05 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Worker::getTransport() A
last analyzed 2015-12-11 11:05 UTC