Skip to content

Commit 3bc875b

Browse files
mpywmpyw
authored
Feat+Refactor: Introduce "Replacement" Feature (#6)
1 parent 917c725 commit 3bc875b

20 files changed

+732
-98
lines changed

‎README.md‎

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,32 @@ DB::setSystemVariables(['long_query_time' => 10.0, 'tx_isolation' => 'read-commi
5353

5454
// Assign a variable on a different connection
5555
DB::connection('other_mysql_connection')->setSystemVariable('long_query_time', 10.0);
56+
57+
// Run callback temporarily assigning a variable
58+
DB::usingSystemVariable('long_query_time', 10.0, function () {
59+
/* ... */
60+
});
61+
62+
// Run callback temporarily assigning multiple variables
63+
DB::usingSystemVariables(['long_query_time' => 10.0, 'tx_isolation' => 'read-committed'], function () {
64+
/* ... */
65+
});
66+
67+
// Run callback replacing current value
68+
// NOTE: You MUST declare closure return types.
69+
DB::usingSystemVariables(
70+
[
71+
'long_query_time' => function (float $currentValue): float {
72+
return $currentValue + 5.0;
73+
},
74+
'sql_mode' => function (string $currentValue): string {
75+
return str_replace('ONLY_FULL_GROUP_BY', '', $currentValue);
76+
},
77+
],
78+
function () {
79+
/* ... */
80+
}
81+
);
5682
```
5783

5884
**WARNING:**
@@ -97,12 +123,14 @@ class MySqlConnection extends BaseMySqlConnection
97123

98124
public function withoutForeignKeyChecks(callable $callback, ...$args)
99125
{
100-
$this->setSystemVariable('foreign_key_checks', false);
101-
try {
102-
return $callback(...$args);
103-
} finally {
104-
$this->setSystemVariable('foreign_key_checks', true);
105-
}
126+
return $this->usingSystemVariable('foreign_key_checks', false, $callback, ...$args);
127+
}
128+
129+
public function allowingPartialGroupBy(callable $callback, ...$args)
130+
{
131+
return $this->usingSystemVariable('sql_mode', function (string $mode): string {
132+
return str_replace('ONLY_FULL_GROUP_BY', '', $mode);
133+
}, $callback, ...$args);
106134
}
107135
}
108136
```

‎src/ExpressionInterface.php‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<?php
2+
3+
namespace Mpyw\LaravelMySqlSystemVariableManager;
4+
5+
interface ExpressionInterface
6+
{
7+
public const TYPE_INTEGER = 'integer';
8+
public const TYPE_BOOLEAN = 'boolean';
9+
public const TYPE_FLOAT = 'double';
10+
public const TYPE_STRING = 'string';
11+
12+
public const GRAMMATICAL_TYPE_TO_STRING_TYPE = [
13+
'int' => self::TYPE_INTEGER,
14+
'bool' => self::TYPE_BOOLEAN,
15+
'float' => self::TYPE_FLOAT,
16+
'double' => self::TYPE_FLOAT,
17+
'string' => self::TYPE_STRING,
18+
];
19+
20+
/**
21+
* Return type.
22+
*
23+
* @return string
24+
*/
25+
public function getType(): string;
26+
27+
/**
28+
* Return PDO::PARAM_* type.s
29+
*
30+
* @return int
31+
*/
32+
public function getParamType(): int;
33+
34+
/**
35+
* Return placeholder for prepared statement.
36+
*
37+
* @return string
38+
*/
39+
public function getPlaceholder(): string;
40+
}

‎src/ExpressionTrait.php‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<?php
2+
3+
namespace Mpyw\LaravelMySqlSystemVariableManager;
4+
5+
use PDO;
6+
7+
/**
8+
* Trait ExpressionTrait
9+
*/
10+
trait ExpressionTrait
11+
{
12+
/**
13+
* Return type.
14+
*
15+
* @return string
16+
*/
17+
abstract public function getType(): string;
18+
19+
/**
20+
* Return PDO::PARAM_* type.
21+
*
22+
* @return int
23+
*/
24+
public function getParamType(): int
25+
{
26+
switch ($this->getType()) {
27+
case ExpressionInterface::TYPE_INTEGER:
28+
return PDO::PARAM_INT;
29+
case ExpressionInterface::TYPE_BOOLEAN:
30+
return PDO::PARAM_BOOL;
31+
case ExpressionInterface::TYPE_FLOAT:
32+
case ExpressionInterface::TYPE_STRING:
33+
default:
34+
return PDO::PARAM_STR;
35+
}
36+
}
37+
38+
/**
39+
* Return a placeholder format.
40+
*
41+
* @return string
42+
*/
43+
public function getPlaceholder(): string
44+
{
45+
switch ($this->getType()) {
46+
case ExpressionInterface::TYPE_FLOAT:
47+
return 'cast(? as decimal(65, 30))';
48+
case ExpressionInterface::TYPE_INTEGER:
49+
case ExpressionInterface::TYPE_BOOLEAN:
50+
case ExpressionInterface::TYPE_STRING:
51+
default:
52+
return '?';
53+
}
54+
}
55+
}

‎src/ManagesSystemVariables.php‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,36 @@ public function setSystemVariables(array $values, bool $memoizeForReconnect = tr
5252

5353
return $this;
5454
}
55+
56+
/**
57+
* Run callback temporarily setting MySQL system variable for both read and write PDOs.
58+
* It is lazily executed for unresolved PDO instance.
59+
*
60+
* @param string $key
61+
* @param mixed $value
62+
* @param callable $callback
63+
* @param mixed ...$args
64+
* @return $this
65+
*/
66+
public function usingSystemVariable(string $key, $value, callable $callback, ...$args)
67+
{
68+
return $this->usingSystemVariables([$key => $value], $callback, ...$args);
69+
}
70+
71+
/**
72+
* Run callback temporarily setting MySQL system variables for both read and write PDOs.
73+
* It is lazily executed for unresolved PDO instance.
74+
*
75+
* @param array $values
76+
* @param callable $callback
77+
* @param mixed ...$args
78+
* @return $this
79+
*/
80+
public function usingSystemVariables(array $values, callable $callback, ...$args)
81+
{
82+
(new SystemVariableTemporaryAssigner($this->readPdo, $this->pdo))
83+
->using($values, $callback, ...$args);
84+
85+
return $this;
86+
}
5587
}

‎src/Replacer.php‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
<?php
2+
3+
namespace Mpyw\LaravelMySqlSystemVariableManager;
4+
5+
use InvalidArgumentException;
6+
use Mpyw\LaravelMySqlSystemVariableManager\Replacers\BooleanReplacerInterface;
7+
use Mpyw\LaravelMySqlSystemVariableManager\Replacers\CallbackBooleanReplacer;
8+
use Mpyw\LaravelMySqlSystemVariableManager\Replacers\CallbackFloatReplacer;
9+
use Mpyw\LaravelMySqlSystemVariableManager\Replacers\CallbackIntegerReplacer;
10+
use Mpyw\LaravelMySqlSystemVariableManager\Replacers\CallbackStringReplacer;
11+
use Mpyw\LaravelMySqlSystemVariableManager\Replacers\FloatReplacerInterface;
12+
use Mpyw\LaravelMySqlSystemVariableManager\Replacers\IntegerReplacerInterface;
13+
use Mpyw\LaravelMySqlSystemVariableManager\Replacers\StringReplacerInterface;
14+
15+
class Replacer
16+
{
17+
/**
18+
* Create new int replacer for MySQL system variable.
19+
*
20+
* @param callable $callback
21+
* @return \Mpyw\LaravelMySqlSystemVariableManager\Replacers\IntegerReplacerInterface
22+
*/
23+
public static function int(callable $callback): IntegerReplacerInterface
24+
{
25+
return new CallbackIntegerReplacer($callback);
26+
}
27+
28+
/**
29+
* Create new bool replacer for MySQL system variable.
30+
*
31+
* @param callable $callback
32+
* @return \Mpyw\LaravelMySqlSystemVariableManager\Replacers\BooleanReplacerInterface
33+
*/
34+
public static function bool(callable $callback): BooleanReplacerInterface
35+
{
36+
return new CallbackBooleanReplacer($callback);
37+
}
38+
39+
/**
40+
* Create new float replacer for MySQL system variable.
41+
*
42+
* @param callable $callback
43+
* @return \Mpyw\LaravelMySqlSystemVariableManager\Replacers\FloatReplacerInterface
44+
*/
45+
public static function float(callable $callback): FloatReplacerInterface
46+
{
47+
return new CallbackFloatReplacer($callback);
48+
}
49+
50+
/**
51+
* Create new string replacer for MySQL system variable.
52+
*
53+
* @param callable $callback
54+
* @return \Mpyw\LaravelMySqlSystemVariableManager\Replacers\StringReplacerInterface
55+
*/
56+
public static function str(callable $callback): StringReplacerInterface
57+
{
58+
return new CallbackStringReplacer($callback);
59+
}
60+
61+
/**
62+
* Create new typed replacer for MySQL system variable.
63+
*
64+
* @param string $type
65+
* @param bool|float|int|string $callback
66+
* @return \Mpyw\LaravelMySqlSystemVariableManager\ExpressionInterface
67+
*/
68+
public static function as(string $type, $callback): ExpressionInterface
69+
{
70+
switch ($type) {
71+
case ExpressionInterface::TYPE_INTEGER:
72+
return static::int($callback);
73+
case ExpressionInterface::TYPE_BOOLEAN:
74+
return static::bool($callback);
75+
case ExpressionInterface::TYPE_FLOAT:
76+
return static::float($callback);
77+
case ExpressionInterface::TYPE_STRING:
78+
return static::str($callback);
79+
default:
80+
throw new InvalidArgumentException('The return type must be one of "integer", "boolean", "double" or "string".');
81+
}
82+
}
83+
}

‎src/Replacers/BooleanReplacerInterface.php‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?php
2+
3+
namespace Mpyw\LaravelMySqlSystemVariableManager\Replacers;
4+
5+
use Mpyw\LaravelMySqlSystemVariableManager\ExpressionInterface;
6+
7+
interface BooleanReplacerInterface extends ExpressionInterface
8+
{
9+
/**
10+
* Replace boolean variable value.
11+
*
12+
* @param bool $value
13+
* @return bool
14+
*/
15+
public function replace(bool $value): bool;
16+
}

‎src/Replacers/CallbackBooleanReplacer.php‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?php
2+
3+
namespace Mpyw\LaravelMySqlSystemVariableManager\Replacers;
4+
5+
use Mpyw\LaravelMySqlSystemVariableManager\ExpressionInterface;
6+
use Mpyw\LaravelMySqlSystemVariableManager\ExpressionTrait;
7+
8+
class CallbackBooleanReplacer implements BooleanReplacerInterface
9+
{
10+
use ExpressionTrait;
11+
12+
/**
13+
* @var callable
14+
*/
15+
protected $callback;
16+
17+
/**
18+
* ClosureBooleanReplacer constructor.
19+
*
20+
* @param callable $callback
21+
*/
22+
public function __construct(callable $callback)
23+
{
24+
$this->callback = $callback;
25+
}
26+
27+
/**
28+
* Replace boolean variable value.
29+
*
30+
* @param bool $value
31+
* @return bool
32+
*/
33+
public function replace(bool $value): bool
34+
{
35+
return ($this->callback)($value);
36+
}
37+
38+
/**
39+
* Return type.
40+
*
41+
* @return string
42+
*/
43+
public function getType(): string
44+
{
45+
return ExpressionInterface::TYPE_BOOLEAN;
46+
}
47+
}

‎src/Replacers/CallbackFloatReplacer.php‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?php
2+
3+
namespace Mpyw\LaravelMySqlSystemVariableManager\Replacers;
4+
5+
use Mpyw\LaravelMySqlSystemVariableManager\ExpressionInterface;
6+
use Mpyw\LaravelMySqlSystemVariableManager\ExpressionTrait;
7+
8+
class CallbackFloatReplacer implements FloatReplacerInterface
9+
{
10+
use ExpressionTrait;
11+
12+
/**
13+
* @var callable
14+
*/
15+
protected $callback;
16+
17+
/**
18+
* ClosureFloatReplacer constructor.
19+
*
20+
* @param callable $callback
21+
*/
22+
public function __construct(callable $callback)
23+
{
24+
$this->callback = $callback;
25+
}
26+
27+
/**
28+
* Replace float variable value.
29+
*
30+
* @param float $value
31+
* @return float
32+
*/
33+
public function replace(float $value): float
34+
{
35+
return ($this->callback)($value);
36+
}
37+
38+
/**
39+
* Return type.
40+
*
41+
* @return string
42+
*/
43+
public function getType(): string
44+
{
45+
return ExpressionInterface::TYPE_FLOAT;
46+
}
47+
}

0 commit comments

Comments
 (0)