@@ -12,7 +12,7 @@ |
||
12 | 12 | $autoload = realpath($root.'/../vendor/autoload.php'); |
13 | 13 | |
14 | 14 | // we need the autoloader to be present |
15 | - if($autoload === false) |
|
15 | + if ($autoload === false) |
|
16 | 16 | { |
17 | 17 | die('<b>ERROR:</b> Autoloader not present. Run composer update first.'); |
18 | 18 | } |
@@ -23,7 +23,7 @@ |
||
23 | 23 | */ |
24 | 24 | function init() |
25 | 25 | { |
26 | - if(!class_exists('\AppLocalize\Localization')) { |
|
26 | + if (!class_exists('\AppLocalize\Localization')) { |
|
27 | 27 | return; |
28 | 28 | } |
29 | 29 |
@@ -26,41 +26,41 @@ discard block |
||
26 | 26 | */ |
27 | 27 | class Mailcode |
28 | 28 | { |
29 | - /** |
|
30 | - * @var Mailcode_Parser|NULL |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var Mailcode_Parser|NULL |
|
31 | + */ |
|
32 | 32 | protected $parser = null; |
33 | 33 | |
34 | - /** |
|
35 | - * @var Mailcode_Commands|NULL |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var Mailcode_Commands|NULL |
|
36 | + */ |
|
37 | 37 | protected $commands = null; |
38 | 38 | |
39 | - /** |
|
40 | - * Creates a new mailcode instance. |
|
41 | - * @return Mailcode |
|
42 | - */ |
|
39 | + /** |
|
40 | + * Creates a new mailcode instance. |
|
41 | + * @return Mailcode |
|
42 | + */ |
|
43 | 43 | public static function create() : Mailcode |
44 | 44 | { |
45 | 45 | return new Mailcode(); |
46 | 46 | } |
47 | 47 | |
48 | - /** |
|
49 | - * Parses the string to detect all commands contained within. |
|
50 | - * |
|
51 | - * @param string $string |
|
52 | - * @return Mailcode_Collection |
|
53 | - */ |
|
48 | + /** |
|
49 | + * Parses the string to detect all commands contained within. |
|
50 | + * |
|
51 | + * @param string $string |
|
52 | + * @return Mailcode_Collection |
|
53 | + */ |
|
54 | 54 | public function parseString(string $string) : Mailcode_Collection |
55 | 55 | { |
56 | 56 | return $this->getParser()->parseString($string); |
57 | 57 | } |
58 | 58 | |
59 | - /** |
|
60 | - * Retrieves the string parser instance used to detect commands. |
|
61 | - * |
|
62 | - * @return Mailcode_Parser |
|
63 | - */ |
|
59 | + /** |
|
60 | + * Retrieves the string parser instance used to detect commands. |
|
61 | + * |
|
62 | + * @return Mailcode_Parser |
|
63 | + */ |
|
64 | 64 | public function getParser() : Mailcode_Parser |
65 | 65 | { |
66 | 66 | if(!isset($this->parser)) |
@@ -71,12 +71,12 @@ discard block |
||
71 | 71 | return $this->parser; |
72 | 72 | } |
73 | 73 | |
74 | - /** |
|
75 | - * Retrieves the commands collection, which is used to |
|
76 | - * access information on the available commands. |
|
77 | - * |
|
78 | - * @return Mailcode_Commands |
|
79 | - */ |
|
74 | + /** |
|
75 | + * Retrieves the commands collection, which is used to |
|
76 | + * access information on the available commands. |
|
77 | + * |
|
78 | + * @return Mailcode_Commands |
|
79 | + */ |
|
80 | 80 | public function getCommands() : Mailcode_Commands |
81 | 81 | { |
82 | 82 | if(!isset($this->commands)) |
@@ -63,7 +63,7 @@ discard block |
||
63 | 63 | */ |
64 | 64 | public function getParser() : Mailcode_Parser |
65 | 65 | { |
66 | - if(!isset($this->parser)) |
|
66 | + if (!isset($this->parser)) |
|
67 | 67 | { |
68 | 68 | $this->parser = new Mailcode_Parser($this); |
69 | 69 | } |
@@ -79,7 +79,7 @@ discard block |
||
79 | 79 | */ |
80 | 80 | public function getCommands() : Mailcode_Commands |
81 | 81 | { |
82 | - if(!isset($this->commands)) |
|
82 | + if (!isset($this->commands)) |
|
83 | 83 | { |
84 | 84 | $this->commands = new Mailcode_Commands(); |
85 | 85 | } |
@@ -23,16 +23,16 @@ discard block |
||
23 | 23 | { |
24 | 24 | const ERROR_COMMAND_NAME_DOES_NOT_EXIST = 45901; |
25 | 25 | |
26 | - /** |
|
27 | - * @var Mailcode_Commands_Command[] |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var Mailcode_Commands_Command[] |
|
28 | + */ |
|
29 | 29 | private $commands = array(); |
30 | 30 | |
31 | - /** |
|
32 | - * Retrieves a list of all available command IDs. |
|
33 | - * |
|
34 | - * @return string[] |
|
35 | - */ |
|
31 | + /** |
|
32 | + * Retrieves a list of all available command IDs. |
|
33 | + * |
|
34 | + * @return string[] |
|
35 | + */ |
|
36 | 36 | public function getIDs() : array |
37 | 37 | { |
38 | 38 | static $ids = array(); |
@@ -45,13 +45,13 @@ discard block |
||
45 | 45 | return $ids; |
46 | 46 | } |
47 | 47 | |
48 | - /** |
|
49 | - * Retrieves a list of all available commands, sorted by label. |
|
50 | - * |
|
51 | - * NOTE: These instances are only used for information purposes. |
|
52 | - * |
|
53 | - * @return Mailcode_Commands_Command[] |
|
54 | - */ |
|
48 | + /** |
|
49 | + * Retrieves a list of all available commands, sorted by label. |
|
50 | + * |
|
51 | + * NOTE: These instances are only used for information purposes. |
|
52 | + * |
|
53 | + * @return Mailcode_Commands_Command[] |
|
54 | + */ |
|
55 | 55 | public function getAll() |
56 | 56 | { |
57 | 57 | if(!empty($this->commands)) { |
@@ -77,12 +77,12 @@ discard block |
||
77 | 77 | return $result; |
78 | 78 | } |
79 | 79 | |
80 | - /** |
|
81 | - * Gets an available command by its ID. |
|
82 | - * |
|
83 | - * @param string $id |
|
84 | - * @return Mailcode_Commands_Command |
|
85 | - */ |
|
80 | + /** |
|
81 | + * Gets an available command by its ID. |
|
82 | + * |
|
83 | + * @param string $id |
|
84 | + * @return Mailcode_Commands_Command |
|
85 | + */ |
|
86 | 86 | public function getByID(string $id) : Mailcode_Commands_Command |
87 | 87 | { |
88 | 88 | static $instances = array(); |
@@ -95,15 +95,15 @@ discard block |
||
95 | 95 | return $instances[$id]; |
96 | 96 | } |
97 | 97 | |
98 | - /** |
|
99 | - * Retrieves the ID of a command by its name. |
|
100 | - * |
|
101 | - * @param string $name |
|
102 | - * @throws Mailcode_Exception |
|
103 | - * @return string |
|
104 | - * |
|
105 | - * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST |
|
106 | - */ |
|
98 | + /** |
|
99 | + * Retrieves the ID of a command by its name. |
|
100 | + * |
|
101 | + * @param string $name |
|
102 | + * @throws Mailcode_Exception |
|
103 | + * @return string |
|
104 | + * |
|
105 | + * @see Mailcode_Commands::ERROR_COMMAND_NAME_DOES_NOT_EXIST |
|
106 | + */ |
|
107 | 107 | public function getIDByName(string $name) : string |
108 | 108 | { |
109 | 109 | $items = $this->getAll(); |
@@ -132,12 +132,12 @@ discard block |
||
132 | 132 | return in_array($id, $ids); |
133 | 133 | } |
134 | 134 | |
135 | - /** |
|
136 | - * Checks wether the specified name exists. |
|
137 | - * |
|
138 | - * @param string $name For example: "showvar". |
|
139 | - * @return bool |
|
140 | - */ |
|
135 | + /** |
|
136 | + * Checks wether the specified name exists. |
|
137 | + * |
|
138 | + * @param string $name For example: "showvar". |
|
139 | + * @return bool |
|
140 | + */ |
|
141 | 141 | public function nameExists(string $name) : bool |
142 | 142 | { |
143 | 143 | $items = $this->getAll(); |
@@ -37,7 +37,7 @@ discard block |
||
37 | 37 | { |
38 | 38 | static $ids = array(); |
39 | 39 | |
40 | - if(empty($ids)) { |
|
40 | + if (empty($ids)) { |
|
41 | 41 | $ids = \AppUtils\FileHelper::createFileFinder(__DIR__.'/Commands/Command') |
42 | 42 | ->getPHPClassNames(); |
43 | 43 | } |
@@ -54,7 +54,7 @@ discard block |
||
54 | 54 | */ |
55 | 55 | public function getAll() |
56 | 56 | { |
57 | - if(!empty($this->commands)) { |
|
57 | + if (!empty($this->commands)) { |
|
58 | 58 | return $this->commands; |
59 | 59 | } |
60 | 60 | |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | |
63 | 63 | $result = array(); |
64 | 64 | |
65 | - foreach($ids as $id) |
|
65 | + foreach ($ids as $id) |
|
66 | 66 | { |
67 | 67 | $result[] = $this->getByID($id); |
68 | 68 | } |
@@ -87,7 +87,7 @@ discard block |
||
87 | 87 | { |
88 | 88 | static $instances = array(); |
89 | 89 | |
90 | - if(!isset($instances[$id])) |
|
90 | + if (!isset($instances[$id])) |
|
91 | 91 | { |
92 | 92 | $instances[$id] = $this->createCommand($id, '__dummy', '', ''); |
93 | 93 | } |
@@ -108,9 +108,9 @@ discard block |
||
108 | 108 | { |
109 | 109 | $items = $this->getAll(); |
110 | 110 | |
111 | - foreach($items as $item) |
|
111 | + foreach ($items as $item) |
|
112 | 112 | { |
113 | - if($item->getName() === $name) { |
|
113 | + if ($item->getName() === $name) { |
|
114 | 114 | return $item->getID(); |
115 | 115 | } |
116 | 116 | } |
@@ -142,9 +142,9 @@ discard block |
||
142 | 142 | { |
143 | 143 | $items = $this->getAll(); |
144 | 144 | |
145 | - foreach($items as $item) |
|
145 | + foreach ($items as $item) |
|
146 | 146 | { |
147 | - if($item->getName() === $name) { |
|
147 | + if ($item->getName() === $name) { |
|
148 | 148 | return true; |
149 | 149 | } |
150 | 150 | } |
@@ -20,9 +20,9 @@ discard block |
||
20 | 20 | */ |
21 | 21 | class Mailcode_Collection |
22 | 22 | { |
23 | - /** |
|
24 | - * @var Mailcode_Commands_Command[] |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var Mailcode_Commands_Command[] |
|
25 | + */ |
|
26 | 26 | protected $commands = array(); |
27 | 27 | |
28 | 28 | /** |
@@ -30,12 +30,12 @@ discard block |
||
30 | 30 | */ |
31 | 31 | protected $errors = array(); |
32 | 32 | |
33 | - /** |
|
34 | - * Adds a command to the collection. |
|
35 | - * |
|
36 | - * @param Mailcode_Commands_Command $command |
|
37 | - * @return Mailcode_Collection |
|
38 | - */ |
|
33 | + /** |
|
34 | + * Adds a command to the collection. |
|
35 | + * |
|
36 | + * @param Mailcode_Commands_Command $command |
|
37 | + * @return Mailcode_Collection |
|
38 | + */ |
|
39 | 39 | public function addCommand(Mailcode_Commands_Command $command) : Mailcode_Collection |
40 | 40 | { |
41 | 41 | $hash = $command->getHash(); |
@@ -47,21 +47,21 @@ discard block |
||
47 | 47 | return $this; |
48 | 48 | } |
49 | 49 | |
50 | - /** |
|
51 | - * Whether there are any commands in the collection. |
|
52 | - * |
|
53 | - * @return bool |
|
54 | - */ |
|
50 | + /** |
|
51 | + * Whether there are any commands in the collection. |
|
52 | + * |
|
53 | + * @return bool |
|
54 | + */ |
|
55 | 55 | public function hasCommands() : bool |
56 | 56 | { |
57 | 57 | return !empty($this->commands); |
58 | 58 | } |
59 | 59 | |
60 | - /** |
|
61 | - * Counts the amount of commands in the collection. |
|
62 | - * |
|
63 | - * @return int |
|
64 | - */ |
|
60 | + /** |
|
61 | + * Counts the amount of commands in the collection. |
|
62 | + * |
|
63 | + * @return int |
|
64 | + */ |
|
65 | 65 | public function countCommands() : int |
66 | 66 | { |
67 | 67 | return count($this->commands); |
@@ -81,9 +81,9 @@ discard block |
||
81 | 81 | $this->errors[] = new Mailcode_Collection_Error_Command($command); |
82 | 82 | } |
83 | 83 | |
84 | - /** |
|
85 | - * @return Mailcode_Collection_Error[] |
|
86 | - */ |
|
84 | + /** |
|
85 | + * @return Mailcode_Collection_Error[] |
|
86 | + */ |
|
87 | 87 | public function getErrors() |
88 | 88 | { |
89 | 89 | return $this->errors; |
@@ -94,13 +94,13 @@ discard block |
||
94 | 94 | return empty($this->errors); |
95 | 95 | } |
96 | 96 | |
97 | - /** |
|
98 | - * Retrieves all commands that were detected. |
|
99 | - * |
|
100 | - * @return \Mailcode\Mailcode_Commands_Command[] |
|
101 | - */ |
|
97 | + /** |
|
98 | + * Retrieves all commands that were detected. |
|
99 | + * |
|
100 | + * @return \Mailcode\Mailcode_Commands_Command[] |
|
101 | + */ |
|
102 | 102 | public function getCommands() |
103 | 103 | { |
104 | - return $this->commands; |
|
104 | + return $this->commands; |
|
105 | 105 | } |
106 | 106 | } |
@@ -40,7 +40,7 @@ |
||
40 | 40 | { |
41 | 41 | $hash = $command->getHash(); |
42 | 42 | |
43 | - if(!isset($this->commands[$hash])) { |
|
43 | + if (!isset($this->commands[$hash])) { |
|
44 | 44 | $this->commands[$hash] = $command; |
45 | 45 | } |
46 | 46 |
@@ -25,24 +25,24 @@ |
||
25 | 25 | { |
26 | 26 | const ERROR_PLACEHOLDER_TOO_LONG = 47901; |
27 | 27 | |
28 | - /** |
|
29 | - * @var int |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var int |
|
30 | + */ |
|
31 | 31 | protected $id; |
32 | 32 | |
33 | - /** |
|
34 | - * @var Mailcode_Parser_Safeguard |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var Mailcode_Parser_Safeguard |
|
35 | + */ |
|
36 | 36 | protected $safeguard; |
37 | 37 | |
38 | - /** |
|
39 | - * @var Mailcode_Commands_Command |
|
40 | - */ |
|
38 | + /** |
|
39 | + * @var Mailcode_Commands_Command |
|
40 | + */ |
|
41 | 41 | protected $command; |
42 | 42 | |
43 | - /** |
|
44 | - * @var string |
|
45 | - */ |
|
43 | + /** |
|
44 | + * @var string |
|
45 | + */ |
|
46 | 46 | protected $replacement = ''; |
47 | 47 | |
48 | 48 | public function __construct(int $id, Mailcode_Commands_Command $command, Mailcode_Parser_Safeguard $safeguard) |
@@ -64,7 +64,7 @@ discard block |
||
64 | 64 | |
65 | 65 | public function getReplacementText() : string |
66 | 66 | { |
67 | - if(!empty($this->replacement)) |
|
67 | + if (!empty($this->replacement)) |
|
68 | 68 | { |
69 | 69 | return $this->replacement; |
70 | 70 | } |
@@ -82,13 +82,13 @@ discard block |
||
82 | 82 | // to total amount of zeroes to pad with to obtain the total length |
83 | 83 | $padLength = $this->getLength() - $length; |
84 | 84 | |
85 | - if($padLength < 0) |
|
85 | + if ($padLength < 0) |
|
86 | 86 | { |
87 | 87 | $padLength = 0; |
88 | 88 | } |
89 | 89 | |
90 | 90 | // create the zero-padded ID to fill the format string with |
91 | - $paddedID = str_pad((string)$this->id, $padLength, '0'); |
|
91 | + $paddedID = str_pad((string)$this->id, $padLength, '0'); |
|
92 | 92 | |
93 | 93 | $this->replacement = sprintf($format, $paddedID); |
94 | 94 |
@@ -32,29 +32,29 @@ discard block |
||
32 | 32 | |
33 | 33 | const VALIDATION_UNKNOWN_COMMAND_NAME = 4; |
34 | 34 | |
35 | - /** |
|
36 | - * @var string |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var string |
|
37 | + */ |
|
38 | 38 | protected $type = ''; |
39 | 39 | |
40 | - /** |
|
41 | - * @var string |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var string |
|
42 | + */ |
|
43 | 43 | protected $paramsString = ''; |
44 | 44 | |
45 | - /** |
|
46 | - * @var string |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var string |
|
47 | + */ |
|
48 | 48 | protected $matchedText = ''; |
49 | 49 | |
50 | - /** |
|
51 | - * @var string |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var string |
|
52 | + */ |
|
53 | 53 | protected $hash = ''; |
54 | 54 | |
55 | - /** |
|
56 | - * @var \AppUtils\OperationResult |
|
57 | - */ |
|
55 | + /** |
|
56 | + * @var \AppUtils\OperationResult |
|
57 | + */ |
|
58 | 58 | protected $validationResult = null; |
59 | 59 | |
60 | 60 | public function __construct(string $type='', string $paramsString='', string $matchedText='') |
@@ -64,33 +64,33 @@ discard block |
||
64 | 64 | $this->matchedText = $matchedText; |
65 | 65 | } |
66 | 66 | |
67 | - /** |
|
68 | - * @return string The ID of the command = the name of the command class file. |
|
69 | - */ |
|
67 | + /** |
|
68 | + * @return string The ID of the command = the name of the command class file. |
|
69 | + */ |
|
70 | 70 | public function getID() : string |
71 | 71 | { |
72 | 72 | $tokens = explode('_', get_class($this)); |
73 | 73 | return array_pop($tokens); |
74 | 74 | } |
75 | 75 | |
76 | - /** |
|
77 | - * Checks whether this is a dummy command, which is only |
|
78 | - * used to access information on the command type. It cannot |
|
79 | - * be used as an actual live command. |
|
80 | - * |
|
81 | - * @return bool |
|
82 | - */ |
|
76 | + /** |
|
77 | + * Checks whether this is a dummy command, which is only |
|
78 | + * used to access information on the command type. It cannot |
|
79 | + * be used as an actual live command. |
|
80 | + * |
|
81 | + * @return bool |
|
82 | + */ |
|
83 | 83 | public function isDummy() : bool |
84 | 84 | { |
85 | 85 | return $this->type === '__dummy'; |
86 | 86 | } |
87 | 87 | |
88 | - /** |
|
89 | - * Retrieves a hash of the actual matched command string, |
|
90 | - * which is used in collections to detect duplicate commands. |
|
91 | - * |
|
92 | - * @return string |
|
93 | - */ |
|
88 | + /** |
|
89 | + * Retrieves a hash of the actual matched command string, |
|
90 | + * which is used in collections to detect duplicate commands. |
|
91 | + * |
|
92 | + * @return string |
|
93 | + */ |
|
94 | 94 | public function getHash() : string |
95 | 95 | { |
96 | 96 | $this->requireNonDummy(); |
@@ -57,7 +57,7 @@ discard block |
||
57 | 57 | */ |
58 | 58 | protected $validationResult = null; |
59 | 59 | |
60 | - public function __construct(string $type='', string $paramsString='', string $matchedText='') |
|
60 | + public function __construct(string $type = '', string $paramsString = '', string $matchedText = '') |
|
61 | 61 | { |
62 | 62 | $this->type = $type; |
63 | 63 | $this->paramsString = $paramsString; |
@@ -95,7 +95,7 @@ discard block |
||
95 | 95 | { |
96 | 96 | $this->requireNonDummy(); |
97 | 97 | |
98 | - if($this->hash === '') { |
|
98 | + if ($this->hash === '') { |
|
99 | 99 | $this->hash = md5($this->matchedText); |
100 | 100 | } |
101 | 101 | |
@@ -104,7 +104,7 @@ discard block |
||
104 | 104 | |
105 | 105 | protected function requireNonDummy() : void |
106 | 106 | { |
107 | - if(!$this->isDummy()) |
|
107 | + if (!$this->isDummy()) |
|
108 | 108 | { |
109 | 109 | return; |
110 | 110 | } |
@@ -125,7 +125,7 @@ discard block |
||
125 | 125 | { |
126 | 126 | $this->requireNonDummy(); |
127 | 127 | |
128 | - if(isset($this->validationResult)) |
|
128 | + if (isset($this->validationResult)) |
|
129 | 129 | { |
130 | 130 | return $this->validationResult; |
131 | 131 | } |
@@ -141,7 +141,7 @@ discard block |
||
141 | 141 | |
142 | 142 | public function getValidationResult() : \AppUtils\OperationResult |
143 | 143 | { |
144 | - if(isset($this->validationResult)) |
|
144 | + if (isset($this->validationResult)) |
|
145 | 145 | { |
146 | 146 | return $this->validationResult; |
147 | 147 | } |
@@ -155,7 +155,7 @@ discard block |
||
155 | 155 | |
156 | 156 | protected function validateSyntax() |
157 | 157 | { |
158 | - if($this->requiresParameters() && empty($this->paramsString)) |
|
158 | + if ($this->requiresParameters() && empty($this->paramsString)) |
|
159 | 159 | { |
160 | 160 | $this->validationResult->makeError( |
161 | 161 | t('Parameters have to be specified.'), |
@@ -164,11 +164,11 @@ discard block |
||
164 | 164 | return; |
165 | 165 | } |
166 | 166 | |
167 | - if($this->supportsType() && !empty($this->type)) |
|
167 | + if ($this->supportsType() && !empty($this->type)) |
|
168 | 168 | { |
169 | 169 | $types = $this->getSupportedTypes(); |
170 | 170 | |
171 | - if(!in_array($this->type, $types)) |
|
171 | + if (!in_array($this->type, $types)) |
|
172 | 172 | { |
173 | 173 | $this->validationResult->makeError( |
174 | 174 | t('The command addon %1$s is not supported.', $this->type).' '. |
@@ -180,7 +180,7 @@ discard block |
||
180 | 180 | } |
181 | 181 | } |
182 | 182 | |
183 | - if(!$this->supportsType() && !empty($this->type)) |
|
183 | + if (!$this->supportsType() && !empty($this->type)) |
|
184 | 184 | { |
185 | 185 | $this->validationResult->makeError( |
186 | 186 | t('Command addons are not supported (the %1$s part).', $this->type), |
@@ -26,14 +26,14 @@ discard block |
||
26 | 26 | '{\s*([a-z]+)\s+([a-z]+)\s*:([^}]+)}' |
27 | 27 | ); |
28 | 28 | |
29 | - /** |
|
30 | - * @var Mailcode |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var Mailcode |
|
31 | + */ |
|
32 | 32 | protected $mailcode; |
33 | 33 | |
34 | - /** |
|
35 | - * @var Mailcode_Commands |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var Mailcode_Commands |
|
36 | + */ |
|
37 | 37 | protected $commands; |
38 | 38 | |
39 | 39 | public function __construct(Mailcode $mailcode) |
@@ -42,24 +42,24 @@ discard block |
||
42 | 42 | $this->commands = $this->mailcode->getCommands(); |
43 | 43 | } |
44 | 44 | |
45 | - /** |
|
46 | - * Gets the regex format string used to detect commands. |
|
47 | - * |
|
48 | - * @return string |
|
49 | - */ |
|
45 | + /** |
|
46 | + * Gets the regex format string used to detect commands. |
|
47 | + * |
|
48 | + * @return string |
|
49 | + */ |
|
50 | 50 | protected static function getRegex() : string |
51 | 51 | { |
52 | 52 | return '/'.implode('|', self::COMMAND_REGEX_PARTS).'/sixU'; |
53 | 53 | } |
54 | 54 | |
55 | - /** |
|
56 | - * Parses a string to detect all commands within. Returns a |
|
57 | - * collection instance that contains information on all the |
|
58 | - * commands. |
|
59 | - * |
|
60 | - * @param string $string |
|
61 | - * @return Mailcode_Collection A collection with all unique commands found. |
|
62 | - */ |
|
55 | + /** |
|
56 | + * Parses a string to detect all commands within. Returns a |
|
57 | + * collection instance that contains information on all the |
|
58 | + * commands. |
|
59 | + * |
|
60 | + * @param string $string |
|
61 | + * @return Mailcode_Collection A collection with all unique commands found. |
|
62 | + */ |
|
63 | 63 | public function parseString(string $string) : Mailcode_Collection |
64 | 64 | { |
65 | 65 | $collection = new Mailcode_Collection(); |
@@ -79,14 +79,14 @@ discard block |
||
79 | 79 | return $collection; |
80 | 80 | } |
81 | 81 | |
82 | - /** |
|
83 | - * Processes a single match found in the string: creates the command, |
|
84 | - * and adds it to the collection if it's a valid command, or to the list |
|
85 | - * of invalid commands otherwise. |
|
86 | - * |
|
87 | - * @param Mailcode_Parser_Match $match |
|
88 | - * @param Mailcode_Collection $collection |
|
89 | - */ |
|
82 | + /** |
|
83 | + * Processes a single match found in the string: creates the command, |
|
84 | + * and adds it to the collection if it's a valid command, or to the list |
|
85 | + * of invalid commands otherwise. |
|
86 | + * |
|
87 | + * @param Mailcode_Parser_Match $match |
|
88 | + * @param Mailcode_Collection $collection |
|
89 | + */ |
|
90 | 90 | protected function processMatch(Mailcode_Parser_Match $match, Mailcode_Collection $collection) : void |
91 | 91 | { |
92 | 92 | $name = $match->getName(); |
@@ -117,14 +117,14 @@ discard block |
||
117 | 117 | $collection->addInvalidCommand($cmd); |
118 | 118 | } |
119 | 119 | |
120 | - /** |
|
121 | - * Parses a single regex match: determines which named group |
|
122 | - * matches, and retrieves the according information. |
|
123 | - * |
|
124 | - * @param array $matches The regex results array. |
|
125 | - * @param int $index The matched index. |
|
126 | - * @return Mailcode_Parser_Match |
|
127 | - */ |
|
120 | + /** |
|
121 | + * Parses a single regex match: determines which named group |
|
122 | + * matches, and retrieves the according information. |
|
123 | + * |
|
124 | + * @param array $matches The regex results array. |
|
125 | + * @param int $index The matched index. |
|
126 | + * @return Mailcode_Parser_Match |
|
127 | + */ |
|
128 | 128 | protected function parseMatch(array $matches, int $index) : Mailcode_Parser_Match |
129 | 129 | { |
130 | 130 | $name = ''; // the command name, e.g. "showvar" |
@@ -162,14 +162,14 @@ discard block |
||
162 | 162 | ); |
163 | 163 | } |
164 | 164 | |
165 | - /** |
|
166 | - * Creates an instance of the safeguard tool, which |
|
167 | - * is used to safeguard commands in a string with placeholders. |
|
168 | - * |
|
169 | - * @param string $subject The string to use to safeguard commands in. |
|
170 | - * @return Mailcode_Parser_Safeguard |
|
171 | - * @see Mailcode_Parser_Safeguard |
|
172 | - */ |
|
165 | + /** |
|
166 | + * Creates an instance of the safeguard tool, which |
|
167 | + * is used to safeguard commands in a string with placeholders. |
|
168 | + * |
|
169 | + * @param string $subject The string to use to safeguard commands in. |
|
170 | + * @return Mailcode_Parser_Safeguard |
|
171 | + * @see Mailcode_Parser_Safeguard |
|
172 | + */ |
|
173 | 173 | public function createSafeguard(string $subject) : Mailcode_Parser_Safeguard |
174 | 174 | { |
175 | 175 | return new Mailcode_Parser_Safeguard($this, $subject); |
@@ -69,7 +69,7 @@ discard block |
||
69 | 69 | |
70 | 70 | $total = count($matches[0]); |
71 | 71 | |
72 | - for($i=0; $i < $total; $i++) |
|
72 | + for ($i = 0; $i < $total; $i++) |
|
73 | 73 | { |
74 | 74 | $match = $this->parseMatch($matches, $i); |
75 | 75 | |
@@ -91,7 +91,7 @@ discard block |
||
91 | 91 | { |
92 | 92 | $name = $match->getName(); |
93 | 93 | |
94 | - if(!$this->commands->nameExists($name)) |
|
94 | + if (!$this->commands->nameExists($name)) |
|
95 | 95 | { |
96 | 96 | $collection->addErrorMessage( |
97 | 97 | $match->getMatchedString(), |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | $match->getMatchedString() |
109 | 109 | ); |
110 | 110 | |
111 | - if($cmd->isValid()) |
|
111 | + if ($cmd->isValid()) |
|
112 | 112 | { |
113 | 113 | $collection->addCommand($cmd); |
114 | 114 | return; |
@@ -138,16 +138,16 @@ discard block |
||
138 | 138 | // 5 = parameter type command, type |
139 | 139 | // 6 = parameter type command, params |
140 | 140 | |
141 | - if(!empty($matches[1][$index])) |
|
141 | + if (!empty($matches[1][$index])) |
|
142 | 142 | { |
143 | 143 | $name = $matches[1][$index]; |
144 | 144 | } |
145 | - else if(!empty($matches[2][$index])) |
|
145 | + else if (!empty($matches[2][$index])) |
|
146 | 146 | { |
147 | 147 | $name = $matches[2][$index]; |
148 | 148 | $params = $matches[3][$index]; |
149 | 149 | } |
150 | - else if(!empty($matches[4][$index])) |
|
150 | + else if (!empty($matches[4][$index])) |
|
151 | 151 | { |
152 | 152 | $name = $matches[4][$index]; |
153 | 153 | $type = $matches[5][$index]; |
@@ -141,13 +141,11 @@ |
||
141 | 141 | if(!empty($matches[1][$index])) |
142 | 142 | { |
143 | 143 | $name = $matches[1][$index]; |
144 | - } |
|
145 | - else if(!empty($matches[2][$index])) |
|
144 | + } else if(!empty($matches[2][$index])) |
|
146 | 145 | { |
147 | 146 | $name = $matches[2][$index]; |
148 | 147 | $params = $matches[3][$index]; |
149 | - } |
|
150 | - else if(!empty($matches[4][$index])) |
|
148 | + } else if(!empty($matches[4][$index])) |
|
151 | 149 | { |
152 | 150 | $name = $matches[4][$index]; |
153 | 151 | $type = $matches[5][$index]; |
@@ -55,40 +55,40 @@ discard block |
||
55 | 55 | |
56 | 56 | const ERROR_EMPTY_DELIMITER = 47803; |
57 | 57 | |
58 | - /** |
|
59 | - * @var Mailcode_Parser |
|
60 | - */ |
|
58 | + /** |
|
59 | + * @var Mailcode_Parser |
|
60 | + */ |
|
61 | 61 | protected $parser; |
62 | 62 | |
63 | - /** |
|
64 | - * @var Mailcode_Collection |
|
65 | - */ |
|
63 | + /** |
|
64 | + * @var Mailcode_Collection |
|
65 | + */ |
|
66 | 66 | protected $commands; |
67 | 67 | |
68 | - /** |
|
69 | - * @var string |
|
70 | - */ |
|
68 | + /** |
|
69 | + * @var string |
|
70 | + */ |
|
71 | 71 | protected $originalString; |
72 | 72 | |
73 | - /** |
|
74 | - * @var Mailcode_Collection |
|
75 | - */ |
|
73 | + /** |
|
74 | + * @var Mailcode_Collection |
|
75 | + */ |
|
76 | 76 | protected $collection; |
77 | 77 | |
78 | - /** |
|
79 | - * Counter for the placeholders, global for all placeholders. |
|
80 | - * @var integer |
|
81 | - */ |
|
78 | + /** |
|
79 | + * Counter for the placeholders, global for all placeholders. |
|
80 | + * @var integer |
|
81 | + */ |
|
82 | 82 | private static $counter = 0; |
83 | 83 | |
84 | - /** |
|
85 | - * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
86 | - */ |
|
84 | + /** |
|
85 | + * @var Mailcode_Parser_Safeguard_Placeholder[] |
|
86 | + */ |
|
87 | 87 | protected $placeholders; |
88 | 88 | |
89 | - /** |
|
90 | - * @var string |
|
91 | - */ |
|
89 | + /** |
|
90 | + * @var string |
|
91 | + */ |
|
92 | 92 | protected $delimiter = '__'; |
93 | 93 | |
94 | 94 | public function __construct(Mailcode_Parser $parser, string $subject) |
@@ -97,15 +97,15 @@ discard block |
||
97 | 97 | $this->originalString = $subject; |
98 | 98 | } |
99 | 99 | |
100 | - /** |
|
101 | - * Sets the delimiter character sequence used to prepend |
|
102 | - * and append to the placeholders. |
|
103 | - * |
|
104 | - * The delimiter's default is "__" (two underscores). |
|
105 | - * |
|
106 | - * @param string $delimiter |
|
107 | - * @return Mailcode_Parser_Safeguard |
|
108 | - */ |
|
100 | + /** |
|
101 | + * Sets the delimiter character sequence used to prepend |
|
102 | + * and append to the placeholders. |
|
103 | + * |
|
104 | + * The delimiter's default is "__" (two underscores). |
|
105 | + * |
|
106 | + * @param string $delimiter |
|
107 | + * @return Mailcode_Parser_Safeguard |
|
108 | + */ |
|
109 | 109 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
110 | 110 | { |
111 | 111 | if(empty($delimiter)) |
@@ -127,15 +127,15 @@ discard block |
||
127 | 127 | return $this->delimiter; |
128 | 128 | } |
129 | 129 | |
130 | - /** |
|
131 | - * Retrieves the safe string in which all commands have been replaced |
|
132 | - * by placeholder strings. |
|
133 | - * |
|
134 | - * @return string |
|
135 | - * @throws Mailcode_Exception |
|
136 | - * |
|
137 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
138 | - */ |
|
130 | + /** |
|
131 | + * Retrieves the safe string in which all commands have been replaced |
|
132 | + * by placeholder strings. |
|
133 | + * |
|
134 | + * @return string |
|
135 | + * @throws Mailcode_Exception |
|
136 | + * |
|
137 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
138 | + */ |
|
139 | 139 | public function makeSafe() : string |
140 | 140 | { |
141 | 141 | $this->requireValidCollection(); |
@@ -171,12 +171,12 @@ discard block |
||
171 | 171 | } |
172 | 172 | |
173 | 173 | |
174 | - /** |
|
175 | - * Retrieves all placeholders that have to be added to |
|
176 | - * the subject text. |
|
177 | - * |
|
178 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
179 | - */ |
|
174 | + /** |
|
175 | + * Retrieves all placeholders that have to be added to |
|
176 | + * the subject text. |
|
177 | + * |
|
178 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
179 | + */ |
|
180 | 180 | public function getPlaceholders() |
181 | 181 | { |
182 | 182 | if(isset($this->placeholders)) |
@@ -228,46 +228,46 @@ discard block |
||
228 | 228 | return str_replace($placeholderStrings, array_values($replaces), $string); |
229 | 229 | } |
230 | 230 | |
231 | - /** |
|
232 | - * Makes the string whole again after transforming or filtering it, |
|
233 | - * by replacing the command placeholders with the original commands. |
|
234 | - * |
|
235 | - * @param string $string |
|
236 | - * @return string |
|
237 | - * @throws Mailcode_Exception |
|
238 | - * |
|
239 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
240 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
241 | - */ |
|
231 | + /** |
|
232 | + * Makes the string whole again after transforming or filtering it, |
|
233 | + * by replacing the command placeholders with the original commands. |
|
234 | + * |
|
235 | + * @param string $string |
|
236 | + * @return string |
|
237 | + * @throws Mailcode_Exception |
|
238 | + * |
|
239 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
240 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
241 | + */ |
|
242 | 242 | public function makeWhole(string $string) : string |
243 | 243 | { |
244 | 244 | return $this->restore($string, false); |
245 | 245 | } |
246 | 246 | |
247 | - /** |
|
248 | - * Like makeWhole(), but replaces the commands with a syntax |
|
249 | - * highlighted version, meant for human readable texts only. |
|
250 | - * |
|
251 | - * Note: the commands lose their functionality (They cannot be |
|
252 | - * parsed from that string again). |
|
253 | - * |
|
254 | - * @param string $string |
|
255 | - * @return string |
|
256 | - * @throws Mailcode_Exception |
|
257 | - * |
|
258 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
259 | - * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
260 | - */ |
|
247 | + /** |
|
248 | + * Like makeWhole(), but replaces the commands with a syntax |
|
249 | + * highlighted version, meant for human readable texts only. |
|
250 | + * |
|
251 | + * Note: the commands lose their functionality (They cannot be |
|
252 | + * parsed from that string again). |
|
253 | + * |
|
254 | + * @param string $string |
|
255 | + * @return string |
|
256 | + * @throws Mailcode_Exception |
|
257 | + * |
|
258 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
259 | + * @see Mailcode_Parser_Safeguard::ERROR_COMMAND_PLACEHOLDER_MISSING |
|
260 | + */ |
|
261 | 261 | public function makeHighlighted(string $string) : string |
262 | 262 | { |
263 | 263 | return $this->restore($string, true); |
264 | 264 | } |
265 | 265 | |
266 | - /** |
|
267 | - * Retrieves the commands collection contained in the string. |
|
268 | - * |
|
269 | - * @return Mailcode_Collection |
|
270 | - */ |
|
266 | + /** |
|
267 | + * Retrieves the commands collection contained in the string. |
|
268 | + * |
|
269 | + * @return Mailcode_Collection |
|
270 | + */ |
|
271 | 271 | public function getCollection() : Mailcode_Collection |
272 | 272 | { |
273 | 273 | if(isset($this->collection)) |
@@ -285,11 +285,11 @@ discard block |
||
285 | 285 | return $this->getCollection()->isValid(); |
286 | 286 | } |
287 | 287 | |
288 | - /** |
|
289 | - * @throws Mailcode_Exception |
|
290 | - * |
|
291 | - * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
292 | - */ |
|
288 | + /** |
|
289 | + * @throws Mailcode_Exception |
|
290 | + * |
|
291 | + * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS |
|
292 | + */ |
|
293 | 293 | protected function requireValidCollection() : void |
294 | 294 | { |
295 | 295 | if($this->getCollection()->isValid()) |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | */ |
109 | 109 | public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard |
110 | 110 | { |
111 | - if(empty($delimiter)) |
|
111 | + if (empty($delimiter)) |
|
112 | 112 | { |
113 | 113 | throw new Mailcode_Exception( |
114 | 114 | 'Empty delimiter', |
@@ -145,17 +145,17 @@ discard block |
||
145 | 145 | return str_replace(array_values($replaces), array_keys($replaces), $this->originalString); |
146 | 146 | } |
147 | 147 | |
148 | - protected function getReplaces(bool $highlighted=false) : array |
|
148 | + protected function getReplaces(bool $highlighted = false) : array |
|
149 | 149 | { |
150 | 150 | $placeholders = $this->getPlaceholders(); |
151 | 151 | |
152 | 152 | $replaces = array(); |
153 | 153 | |
154 | - foreach($placeholders as $placeholder) |
|
154 | + foreach ($placeholders as $placeholder) |
|
155 | 155 | { |
156 | 156 | $replace = ''; |
157 | 157 | |
158 | - if($highlighted) |
|
158 | + if ($highlighted) |
|
159 | 159 | { |
160 | 160 | $replace = $placeholder->getHighlightedText(); |
161 | 161 | } |
@@ -179,7 +179,7 @@ discard block |
||
179 | 179 | */ |
180 | 180 | public function getPlaceholders() |
181 | 181 | { |
182 | - if(isset($this->placeholders)) |
|
182 | + if (isset($this->placeholders)) |
|
183 | 183 | { |
184 | 184 | return $this->placeholders; |
185 | 185 | } |
@@ -188,7 +188,7 @@ discard block |
||
188 | 188 | |
189 | 189 | $cmds = $this->getCollection()->getCommands(); |
190 | 190 | |
191 | - foreach($cmds as $command) |
|
191 | + foreach ($cmds as $command) |
|
192 | 192 | { |
193 | 193 | self::$counter++; |
194 | 194 | |
@@ -202,7 +202,7 @@ discard block |
||
202 | 202 | return $this->placeholders; |
203 | 203 | } |
204 | 204 | |
205 | - protected function restore(string $string, bool $highlighted=false) : string |
|
205 | + protected function restore(string $string, bool $highlighted = false) : string |
|
206 | 206 | { |
207 | 207 | $this->requireValidCollection(); |
208 | 208 | |
@@ -210,9 +210,9 @@ discard block |
||
210 | 210 | |
211 | 211 | $placeholderStrings = array_keys($replaces); |
212 | 212 | |
213 | - foreach($placeholderStrings as $search) |
|
213 | + foreach ($placeholderStrings as $search) |
|
214 | 214 | { |
215 | - if(!strstr($string, $search)) |
|
215 | + if (!strstr($string, $search)) |
|
216 | 216 | { |
217 | 217 | throw new Mailcode_Exception( |
218 | 218 | 'Command placeholder not found', |
@@ -270,7 +270,7 @@ discard block |
||
270 | 270 | */ |
271 | 271 | public function getCollection() : Mailcode_Collection |
272 | 272 | { |
273 | - if(isset($this->collection)) |
|
273 | + if (isset($this->collection)) |
|
274 | 274 | { |
275 | 275 | return $this->collection; |
276 | 276 | } |
@@ -292,7 +292,7 @@ discard block |
||
292 | 292 | */ |
293 | 293 | protected function requireValidCollection() : void |
294 | 294 | { |
295 | - if($this->getCollection()->isValid()) |
|
295 | + if ($this->getCollection()->isValid()) |
|
296 | 296 | { |
297 | 297 | return; |
298 | 298 | } |
@@ -158,8 +158,7 @@ |
||
158 | 158 | if($highlighted) |
159 | 159 | { |
160 | 160 | $replace = $placeholder->getHighlightedText(); |
161 | - } |
|
162 | - else |
|
161 | + } else |
|
163 | 162 | { |
164 | 163 | $replace = $placeholder->getOriginalText(); |
165 | 164 | } |