|
1
|
|
|
<?php |
|
2
|
|
|
namespace izzum\command; |
|
3
|
|
|
use izzum\command\Exception; |
|
4
|
|
|
use izzum\command\ICommand; |
|
5
|
|
|
|
|
6
|
|
|
/** |
|
7
|
|
|
* Serves as base class for all other concrete commands. |
|
8
|
|
|
* Concrete commands must implement the _execute() method. |
|
9
|
|
|
* |
|
10
|
|
|
* Intent: Encapsulate a request as an object, thereby letting you parameterize |
|
11
|
|
|
* clients with different requests, queue or log requests. |
|
12
|
|
|
* |
|
13
|
|
|
* A concrete Command (a subclass) can (and should be) injected with contextual |
|
14
|
|
|
* data via |
|
15
|
|
|
* dependency injection in the constructor |
|
16
|
|
|
* |
|
17
|
|
|
* @author Rolf Vreijdenberger |
|
18
|
|
|
* @link https://en.wikipedia.org/wiki/Command_pattern |
|
19
|
|
|
* |
|
20
|
|
|
*/ |
|
21
|
|
|
abstract class Command implements ICommand { |
|
22
|
|
|
|
|
23
|
|
|
/** |
|
24
|
|
|
* (non-PHPdoc) |
|
25
|
|
|
* |
|
26
|
|
|
* @see \izzum\command\ICommand::execute() |
|
27
|
|
|
* @throws Exception https://en.wikipedia.org/wiki/Template_method_pattern |
|
28
|
|
|
*/ |
|
29
|
39 |
|
final public function execute() |
|
30
|
|
|
{ |
|
31
|
|
|
try { |
|
32
|
39 |
|
$this->_execute(); |
|
33
|
39 |
|
} catch(Exception $e) { |
|
34
|
3 |
|
$this->handleException($e); |
|
35
|
3 |
|
throw $e; |
|
36
|
5 |
|
} catch(\Exception $e) { |
|
37
|
|
|
// make sure we always throw the right type |
|
38
|
5 |
|
$e = new Exception($e->getMessage(), $e->getCode(), $e); |
|
39
|
5 |
|
$this->handleException($e); |
|
40
|
5 |
|
throw ($e); |
|
41
|
|
|
} |
|
42
|
35 |
|
} |
|
43
|
|
|
|
|
44
|
|
|
/** |
|
45
|
|
|
* hook method for logging etc. |
|
46
|
|
|
* |
|
47
|
|
|
* @param Exception $e |
|
48
|
|
|
*/ |
|
49
|
5 |
|
protected function handleException($e) |
|
|
|
|
|
|
50
|
|
|
{ |
|
51
|
|
|
// implement in subclass if needed |
|
52
|
5 |
|
} |
|
53
|
|
|
|
|
54
|
|
|
/** |
|
55
|
|
|
* |
|
56
|
|
|
* @throws \Exception |
|
57
|
|
|
*/ |
|
58
|
|
|
abstract protected function _execute(); |
|
59
|
|
|
|
|
60
|
|
|
/** |
|
61
|
|
|
* |
|
62
|
|
|
* @return string |
|
63
|
|
|
*/ |
|
64
|
5 |
|
public function toString() |
|
65
|
|
|
{ |
|
66
|
|
|
// includes the namespace |
|
67
|
5 |
|
return get_class($this); |
|
68
|
|
|
} |
|
69
|
|
|
|
|
70
|
1 |
|
public function __toString() |
|
71
|
|
|
{ |
|
72
|
1 |
|
return $this->toString(); |
|
73
|
|
|
} |
|
74
|
|
|
} |
rolfvreijdenberger /
izzum-statemachine
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.