MySQLBuilder::setLockPrefix() - Code Metrics - Inspection of "Various changes" - rkrx/php-service-dispatcher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 84470e...c291b9 )

by Ron

created 2021-01-16 22:53 UTC

MySQLBuilder::setLockPrefix() A

↳ Parent: MySQLBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php
namespace Kir\Services\Cmd\Dispatcher\Builder;

use Kir\Services\Cmd\Dispatcher\AttributeRepositories\MySQLAttributeRepository;
use Kir\Services\Cmd\Dispatcher\Dispatcher;
use Kir\Services\Cmd\Dispatcher\Dispatchers\DefaultDispatcher;
use PDO;

class MySQLBuilder {
	/** @var PDO */
	private $pdo;
	/** @var bool */
	private $useLocking = true;
	/** @var string */
	private $lockPrefix = '';
	
	/**
	 * @param PDO $pdo
	 */
	public function __construct(PDO $pdo) {
		$this->pdo = $pdo;
	}
	
	/**
	 * Enabled by default.
	 * You can disable global locking (using MySQL's GET_LOCK) per service-run.
	 * A Lock will be optained before a service runs and will be released, is the service is done
	 * (or an exception was thrown during the run)
	 *
	 * @param bool $useLocking
	 * @return $this
	 */
	public function useLocking(bool $useLocking = true): self {
		$this->useLocking = $useLocking;
		return $this;
	}
	
	/**
	 * Set the lock-prefix for the MySQL-`GET_LOCK` name.
	 *
	 * You can think of it as calling the function like this:
	 * `SELECT GET_LOCK(CONCAT(<lock-prefix>, <registered-service-name>), 0)`
	 *
	 * Something like `my-app:` would result in `my-app:service-xy` if the particular service was registered as
	 * `service-xy`. The Lock is per service. Between two services, the lock will be released and reoptained.
	 *
	 * @param string $lockPrefix
	 * @return $this
	 */
	public function setLockPrefix(string $lockPrefix = ''): self {
		$this->lockPrefix = $lockPrefix;
		return $this;
	}
	
	/**
	 * @return DefaultDispatcher
	 */
	public function build(): DefaultDispatcher {
		$repos = new MySQLAttributeRepository($this->pdo, [
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			'use-locking' => $this->useLocking,
			'lock-prefix' => $this->lockPrefix,
		]);
		return new DefaultDispatcher($repos);
	}
}

1			<?php
2			namespace Kir\Services\Cmd\Dispatcher\Builder;
3
4			use Kir\Services\Cmd\Dispatcher\AttributeRepositories\MySQLAttributeRepository;
5			use Kir\Services\Cmd\Dispatcher\Dispatcher;
6			use Kir\Services\Cmd\Dispatcher\Dispatchers\DefaultDispatcher;
7			use PDO;
8
9			class MySQLBuilder {
10			/** @var PDO */
11			private $pdo;
12			/** @var bool */
13			private $useLocking = true;
14			/** @var string */
15			private $lockPrefix = '';
16
17			/**
18			* @param PDO $pdo
19			*/
20			public function __construct(PDO $pdo) {
21			$this->pdo = $pdo;
22			}
23
24			/**
25			* Enabled by default.
26			* You can disable global locking (using MySQL's GET_LOCK) per service-run.
27			* A Lock will be optained before a service runs and will be released, is the service is done
28			* (or an exception was thrown during the run)
29			*
30			* @param bool $useLocking
31			* @return $this
32			*/
33			public function useLocking(bool $useLocking = true): self {
34			$this->useLocking = $useLocking;
35			return $this;
36			}
37
38			/**
39			* Set the lock-prefix for the MySQL-`GET_LOCK` name.
40			*
41			* You can think of it as calling the function like this:
42			* `SELECT GET_LOCK(CONCAT(<lock-prefix>, <registered-service-name>), 0)`
43			*
44			* Something like `my-app:` would result in `my-app:service-xy` if the particular service was registered as
45			* `service-xy`. The Lock is per service. Between two services, the lock will be released and reoptained.
46			*
47			* @param string $lockPrefix
48			* @return $this
49			*/
50			public function setLockPrefix(string $lockPrefix = ''): self {
51			$this->lockPrefix = $lockPrefix;
52			return $this;
53			}
54
55			/**
56			* @return DefaultDispatcher
57			*/
58			public function build(): DefaultDispatcher {
59			$repos = new MySQLAttributeRepository($this->pdo, [
			0 ignored issues – show Documentation introduced 2021-01-16 22:57 UTC by Report Bug Copy Issue Report `array('use-locking' => $...' => $this->lockPrefix)` is of type `array<string,boolean\|str...lock-prefix":"string"}>`, 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...
60			'use-locking' => $this->useLocking,
61			'lock-prefix' => $this->lockPrefix,
62			]);
63			return new DefaultDispatcher($repos);
64			}
65			}

rkrx / php-service-dispatcher

Push — master ( 84470e...c291b9 )

MySQLBuilder::setLockPrefix() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like