JobClass::loadTimeout() - Code Metrics - Inspection of "Rename project: new project aims to run with Symfo..." - mikaelkael/GearmanBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 355f41...200862 )

by Mickael

created 2016-11-14 19:40 UTC

JobClass::loadTimeout() A

↳ Parent: JobClass

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

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

<?php

/**
 * Gearman Bundle for Symfony2 / Symfony3
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * Feel free to edit as you please, and have fun.
 *
 * @author Marc Morera <[email protected]>
 */

namespace Mkk\GearmanBundle\Module;

use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Mkk\GearmanBundle\Driver\Gearman\Job as JobAnnotation;

/**
 * Job class
 *
 * This class provide all worker definition.
 */
class JobClass implements ContainerAwareInterface
{
    /**
     * @var string
     *
     * Default description when is not defined
     */
    const DEFAULT_DESCRIPTION = 'No description is defined';

    /**
     * @var string
     *
     * Callable name for this job
     * If is setted on annotations, this value will be used
     *  otherwise, natural method name will be used.
     */
    private $callableName;

    /**
     * @var string
     *
     * Method name
     */
    private $methodName;

    /**
     * @var string
     *
     * RealCallable name for this job without the job prefix
     *
     */
    private $realCallableNameNoPrefix;

    /**
     * @var string
     *
     * RealCallable name for this job
     * natural method name will be used.
     */
    private $realCallableName;

    /**
     * @var string
     *
     * Description of Job
     */
    private $description;

    /**
     * @var integer
     *
     * Number of iterations this job will be alive before die
     */
    private $iterations;

    /**
     * @var string
     *
     * Default method this job will be call into Gearman client
     */
    private $defaultMethod;

    /**
     * @var int
     *
     * Job minimum execution time
     */
    private $minimumExecutionTime;

    /**
     * @var int
     *
     * Timeout for idle worker
     */
    private $timeout;

    /**
     * @var array
     *
     * Collection of servers to connect
     */
    private $servers;

    /**
     * @var string
     *
     * The prefix to be prepended to all job callable names.
     */
    private $jobPrefix;

    /**
     * @var ContainerInterface
     */
    protected $container;

    /**
     * Construct method
     *
     * @param JobAnnotation    $jobAnnotation     JobAnnotation class
     * @param \ReflectionMethod $reflectionMethod  ReflextionMethod class
     * @param string           $callableNameClass Callable name class
     * @param array            $servers           Array of servers defined for Worker
     * @param array            $defaultSettings   Default settings for Worker
     */
    public function __construct(
        JobAnnotation $jobAnnotation,
        \ReflectionMethod $reflectionMethod,
        $callableNameClass,
        array $servers,
        array $defaultSettings
    )
    {

        $this->callableName = is_null($jobAnnotation->name)
            ? $reflectionMethod->getName()
            : $jobAnnotation->name;

        $this->methodName = $reflectionMethod->getName();
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->realCallableNameNoPrefix = is_null($jobAnnotation->realCallableName)
            ? str_replace('\\', '', $callableNameClass . '~' . $this->callableName)
            : $jobAnnotation->realCallableName;

        $this->jobPrefix = isset($defaultSettings['jobPrefix'])
            ? $defaultSettings['jobPrefix']
            : null;

        $this->realCallableName = $this->jobPrefix . $this->realCallableNameNoPrefix;
        $this->description = is_null($jobAnnotation->description)
$a = "a";
$ab = "ab";
$abc = "abc";
            ? self::DEFAULT_DESCRIPTION
            : $jobAnnotation->description;

        $this->servers = $this->loadServers($jobAnnotation, $servers);
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->iterations = $this->loadIterations($jobAnnotation, $defaultSettings);
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->minimumExecutionTime = $this->loadMinimumExecutionTime($jobAnnotation, $defaultSettings);
        $this->timeout = $this->loadTimeout($jobAnnotation, $defaultSettings);
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->defaultMethod = $this->loadDefaultMethod($jobAnnotation, $defaultSettings);
$a = "a";
$ab = "ab";
$abc = "abc";
    }

    /**
     * Load servers
     *
     * If any server is defined in JobAnnotation, this one is used.
     * Otherwise is used servers set in Class
     *
     * @param JobAnnotation $jobAnnotation JobAnnotation class
     * @param array         $servers       Array of servers defined for Worker
     *
     * @return array Servers
     */
    private function loadServers(JobAnnotation $jobAnnotation, array $servers)
    {

        /**
         * If is configured some servers definition in the worker, overwrites
         */
        if ($jobAnnotation->servers) {

            $servers = (is_array($jobAnnotation->servers) && !isset($jobAnnotation->servers['host']))

                ? $jobAnnotation->servers
                : array($jobAnnotation->servers);
        }

        return $servers;
    }

    /**
     * Load iterations
     *
     * If iterations is defined in JobAnnotation, this one is used.
     * Otherwise is used set in Class
     *
     * @param JobAnnotation $jobAnnotation   JobAnnotation class
     * @param array         $defaultSettings Default settings for Worker
     *
     * @return integer Iteration
     */
    private function loadIterations(JobAnnotation $jobAnnotation, array $defaultSettings)
    {
        return is_null($jobAnnotation->iterations)
            ? (int) $defaultSettings['iterations']
            : (int) $jobAnnotation->iterations;
    }

    /**
     * Load defaultMethod
     *
     * If defaultMethod is defined in JobAnnotation, this one is used.
     * Otherwise is used set in Class
     *
     * @param JobAnnotation $jobAnnotation   JobAnnotation class
     * @param array         $defaultSettings Default settings for Worker
     *
     * @return string Default method
     */
    private function loadDefaultMethod(JobAnnotation $jobAnnotation, array $defaultSettings)
    {
        return is_null($jobAnnotation->defaultMethod)
            ? $defaultSettings['method']
            : $jobAnnotation->defaultMethod;
    }

    /**
     * Load minimumExecutionTime
     *
     * If minimumExecutionTime is defined in JobAnnotation, this one is used.
     * Otherwise is used set in Class
     *
     * @param JobAnnotation $jobAnnotation
     * @param array $defaultSettings
     *
     * @return int
     */
    private function loadMinimumExecutionTime(JobAnnotation $jobAnnotation, array $defaultSettings)
    {
        return is_null($jobAnnotation->minimumExecutionTime)
            ? (int) $defaultSettings['minimumExecutionTime']
            : (int) $jobAnnotation->minimumExecutionTime;
    }

    /**
     * Load timeout
     *
     * If timeout is defined in JobAnnotation, this one is used.
     * Otherwise is used set in Class
     *
     * @param JobAnnotation $jobAnnotation
     * @param array $defaultSettings
     *
     * @return int
     */
    private function loadTimeout(JobAnnotation $jobAnnotation, array $defaultSettings)
    {
        return is_null($jobAnnotation->timeout)
            ? (int) $defaultSettings['timeout']
            : (int) $jobAnnotation->timeout;
    }

    /**
     * Retrieve all Job data in cache format
     *
     * @return array

     */
    public function toArray()
    {
        return array(

            'callableName'             => $this->callableName,
            'methodName'               => $this->methodName,
            'realCallableName'         => $this->realCallableName,
            'jobPrefix'                => $this->jobPrefix,
            'realCallableNameNoPrefix' => $this->realCallableNameNoPrefix,
            'description'              => $this->description,
            'iterations'               => $this->iterations,
            'minimumExecutionTime'     => $this->minimumExecutionTime,
            'timeout'                  => $this->timeout,
            'servers'                  => $this->servers,
            'defaultMethod'            => $this->defaultMethod,
        );
    }

    /**
     * Sets the container.
     *
     * @param ContainerInterface|null $container A ContainerInterface instance or null
     */
    public function setContainer(ContainerInterface $container = null)
    {
        $this->container = $container;
    }
}



1		<?php
2
3		/**
4		* Gearman Bundle for Symfony2 / Symfony3
5		*
6		* For the full copyright and license information, please view the LICENSE
7		* file that was distributed with this source code.
8		*
9		* Feel free to edit as you please, and have fun.
10		*
11		* @author Marc Morera <[email protected]>
12		*/
13
14		namespace Mkk\GearmanBundle\Module;
15
16		use Symfony\Component\DependencyInjection\ContainerAwareInterface;
17		use Symfony\Component\DependencyInjection\ContainerInterface;
18		use Mkk\GearmanBundle\Driver\Gearman\Job as JobAnnotation;
19
20		/**
21		* Job class
22		*
23		* This class provide all worker definition.
24		*/
25		class JobClass implements ContainerAwareInterface
26		{
27		/**
28		* @var string
29		*
30		* Default description when is not defined
31		*/
32		const DEFAULT_DESCRIPTION = 'No description is defined';
33
34		/**
35		* @var string
36		*
37		* Callable name for this job
38		* If is setted on annotations, this value will be used
39		* otherwise, natural method name will be used.
40		*/
41		private $callableName;
42
43		/**
44		* @var string
45		*
46		* Method name
47		*/
48		private $methodName;
49
50		/**
51		* @var string
52		*
53		* RealCallable name for this job without the job prefix
54		*
55		*/
56		private $realCallableNameNoPrefix;
57
58		/**
59		* @var string
60		*
61		* RealCallable name for this job
62		* natural method name will be used.
63		*/
64		private $realCallableName;
65
66		/**
67		* @var string
68		*
69		* Description of Job
70		*/
71		private $description;
72
73		/**
74		* @var integer
75		*
76		* Number of iterations this job will be alive before die
77		*/
78		private $iterations;
79
80		/**
81		* @var string
82		*
83		* Default method this job will be call into Gearman client
84		*/
85		private $defaultMethod;
86
87		/**
88		* @var int
89		*
90		* Job minimum execution time
91		*/
92		private $minimumExecutionTime;
93
94		/**
95		* @var int
96		*
97		* Timeout for idle worker
98		*/
99		private $timeout;
100
101		/**
102		* @var array
103		*
104		* Collection of servers to connect
105		*/
106		private $servers;
107
108		/**
109		* @var string
110		*
111		* The prefix to be prepended to all job callable names.
112		*/
113		private $jobPrefix;
114
115		/**
116		* @var ContainerInterface
117		*/
118		protected $container;
119
120		/**
121		* Construct method
122		*
123		* @param JobAnnotation $jobAnnotation JobAnnotation class
124		* @param \ReflectionMethod $reflectionMethod ReflextionMethod class
125		* @param string $callableNameClass Callable name class
126		* @param array $servers Array of servers defined for Worker
127		* @param array $defaultSettings Default settings for Worker
128		*/
129	6	public function __construct(
130		JobAnnotation $jobAnnotation,
131		\ReflectionMethod $reflectionMethod,
132		$callableNameClass,
133		array $servers,
134		array $defaultSettings
135		)
136		{
137
138	6	$this->callableName = is_null($jobAnnotation->name)
139	5	? $reflectionMethod->getName()
140	1	: $jobAnnotation->name;
141
142	6	$this->methodName = $reflectionMethod->getName();
		0 ignored issues – show Coding Style introduced 2016-11-11 12:39 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 15 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
143	6	$this->realCallableNameNoPrefix = is_null($jobAnnotation->realCallableName)
144	4	? str_replace('\\', '', $callableNameClass . '~' . $this->callableName)
145	2	: $jobAnnotation->realCallableName;
146
147	6	$this->jobPrefix = isset($defaultSettings['jobPrefix'])
148	2	? $defaultSettings['jobPrefix']
149	4	: null;
150
151	6	$this->realCallableName = $this->jobPrefix . $this->realCallableNameNoPrefix;
152	6	$this->description = is_null($jobAnnotation->description)
		0 ignored issues – show Coding Style introduced 2016-11-11 12:39 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
153	5	? self::DEFAULT_DESCRIPTION
154	1	: $jobAnnotation->description;
155
156	6	$this->servers = $this->loadServers($jobAnnotation, $servers);
		0 ignored issues – show Coding Style introduced 2016-11-11 12:39 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 14 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
157	6	$this->iterations = $this->loadIterations($jobAnnotation, $defaultSettings);
		0 ignored issues – show Coding Style introduced 2016-11-11 12:39 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 11 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
158	6	$this->minimumExecutionTime = $this->loadMinimumExecutionTime($jobAnnotation, $defaultSettings);
159	6	$this->timeout = $this->loadTimeout($jobAnnotation, $defaultSettings);
		0 ignored issues – show Coding Style introduced 2016-11-11 12:39 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 14 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
160	6	$this->defaultMethod = $this->loadDefaultMethod($jobAnnotation, $defaultSettings);
		0 ignored issues – show Coding Style introduced 2016-11-11 12:39 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 8 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
161	6	}
162
163		/**
164		* Load servers
165		*
166		* If any server is defined in JobAnnotation, this one is used.
167		* Otherwise is used servers set in Class
168		*
169		* @param JobAnnotation $jobAnnotation JobAnnotation class
170		* @param array $servers Array of servers defined for Worker
171		*
172		* @return array Servers
173		*/
174	6	private function loadServers(JobAnnotation $jobAnnotation, array $servers)
175		{
176
177		/**
178		* If is configured some servers definition in the worker, overwrites
179		*/
180	6	if ($jobAnnotation->servers) {
181
182	3	$servers = (is_array($jobAnnotation->servers) && !isset($jobAnnotation->servers['host']))
		0 ignored issues – show Coding Style introduced 2016-11-11 12:39 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$servers`. This often makes code more readable. Loading history...
183	1	? $jobAnnotation->servers
184	3	: array($jobAnnotation->servers);
185		}
186
187	6	return $servers;
188		}
189
190		/**
191		* Load iterations
192		*
193		* If iterations is defined in JobAnnotation, this one is used.
194		* Otherwise is used set in Class
195		*
196		* @param JobAnnotation $jobAnnotation JobAnnotation class
197		* @param array $defaultSettings Default settings for Worker
198		*
199		* @return integer Iteration
200		*/
201	6	private function loadIterations(JobAnnotation $jobAnnotation, array $defaultSettings)
202		{
203	6	return is_null($jobAnnotation->iterations)
204	5	? (int) $defaultSettings['iterations']
205	6	: (int) $jobAnnotation->iterations;
206		}
207
208		/**
209		* Load defaultMethod
210		*
211		* If defaultMethod is defined in JobAnnotation, this one is used.
212		* Otherwise is used set in Class
213		*
214		* @param JobAnnotation $jobAnnotation JobAnnotation class
215		* @param array $defaultSettings Default settings for Worker
216		*
217		* @return string Default method
218		*/
219	6	private function loadDefaultMethod(JobAnnotation $jobAnnotation, array $defaultSettings)
220		{
221	6	return is_null($jobAnnotation->defaultMethod)
222	5	? $defaultSettings['method']
223	6	: $jobAnnotation->defaultMethod;
224		}
225
226		/**
227		* Load minimumExecutionTime
228		*
229		* If minimumExecutionTime is defined in JobAnnotation, this one is used.
230		* Otherwise is used set in Class
231		*
232		* @param JobAnnotation $jobAnnotation
233		* @param array $defaultSettings
234		*
235		* @return int
236		*/
237	6	private function loadMinimumExecutionTime(JobAnnotation $jobAnnotation, array $defaultSettings)
238		{
239	6	return is_null($jobAnnotation->minimumExecutionTime)
240	6	? (int) $defaultSettings['minimumExecutionTime']
241	6	: (int) $jobAnnotation->minimumExecutionTime;
242		}
243
244		/**
245		* Load timeout
246		*
247		* If timeout is defined in JobAnnotation, this one is used.
248		* Otherwise is used set in Class
249		*
250		* @param JobAnnotation $jobAnnotation
251		* @param array $defaultSettings
252		*
253		* @return int
254		*/
255	6	private function loadTimeout(JobAnnotation $jobAnnotation, array $defaultSettings)
256		{
257	6	return is_null($jobAnnotation->timeout)
258	6	? (int) $defaultSettings['timeout']
259	6	: (int) $jobAnnotation->timeout;
260		}
261
262		/**
263		* Retrieve all Job data in cache format
264		*
265		* @return array
		0 ignored issues – show Documentation introduced 2016-11-11 12:39 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string,string\|integer\|array>`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
266		*/
267	6	public function toArray()
268		{
269		return array(
270
271	6	'callableName' => $this->callableName,
272	6	'methodName' => $this->methodName,
273	6	'realCallableName' => $this->realCallableName,
274	6	'jobPrefix' => $this->jobPrefix,
275	6	'realCallableNameNoPrefix' => $this->realCallableNameNoPrefix,
276	6	'description' => $this->description,
277	6	'iterations' => $this->iterations,
278	6	'minimumExecutionTime' => $this->minimumExecutionTime,
279	6	'timeout' => $this->timeout,
280	6	'servers' => $this->servers,
281	6	'defaultMethod' => $this->defaultMethod,
282		);
283		}
284
285		/**
286		* Sets the container.
287		*
288		* @param ContainerInterface\|null $container A ContainerInterface instance or null
289		*/
290		public function setContainer(ContainerInterface $container = null)
291		{
292		$this->container = $container;
293		}
294		}
		0 ignored issues – show Coding Style introduced 2016-11-11 12:39 UTC by Report Bug Copy Issue Report As per coding style, files should not end with a newline character. This check marks files that end in a newline character, i.e. an empy line. Loading history...
295

mikaelkael / GearmanBundle

Push — master ( 355f41...200862 )

JobClass::loadTimeout() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like