Passed
Push — master ( e8275e...2e2cc3 )
by Sebastian
03:17
created
src/Mailcode/Parser/Statement/Tokenizer/Token/Operand.php 1 patch
Indentation   +18 added lines, -18 removed lines patch added patch discarded remove patch
@@ -30,10 +30,10 @@  discard block
 block discarded – undo
30 30
         return $this->getSign();
31 31
     }
32 32
     
33
-   /**
34
-    * Retrieves all known comparison operator signs.
35
-    * @return string[]
36
-    */
33
+    /**
34
+     * Retrieves all known comparison operator signs.
35
+     * @return string[]
36
+     */
37 37
     public static function getComparisonSigns() : array
38 38
     {
39 39
         return array(
@@ -46,10 +46,10 @@  discard block
 block discarded – undo
46 46
         );
47 47
     }
48 48
     
49
-   /**
50
-    * Retrieves all known arithmetic operator signs.
51
-    * @return string[]
52
-    */
49
+    /**
50
+     * Retrieves all known arithmetic operator signs.
51
+     * @return string[]
52
+     */
53 53
     public static function getArithmeticSigns() : array
54 54
     {
55 55
         return array(
@@ -60,11 +60,11 @@  discard block
 block discarded – undo
60 60
         );
61 61
     }
62 62
     
63
-   /**
64
-    * Whether the operator is comparison related (equals, not equals, smaller, greater...).
65
-    *  
66
-    * @return bool
67
-    */
63
+    /**
64
+     * Whether the operator is comparison related (equals, not equals, smaller, greater...).
65
+     *  
66
+     * @return bool
67
+     */
68 68
     public function isComparator() : bool
69 69
     {
70 70
         return 
@@ -76,11 +76,11 @@  discard block
 block discarded – undo
76 76
         $this->isSmallerOrEquals();
77 77
     }
78 78
     
79
-   /**
80
-    * Whether the operator is calculation related (minus, plus, divide, multiply).
81
-    * 
82
-    * @return bool
83
-    */
79
+    /**
80
+     * Whether the operator is calculation related (minus, plus, divide, multiply).
81
+     * 
82
+     * @return bool
83
+     */
84 84
     public function isCalculator() : bool
85 85
     {
86 86
         return 
Please login to merge, or discard this patch.
src/Mailcode/Parser/Safeguard/Formatter/ReplacerType.php 2 patches
Indentation   +7 added lines, -7 removed lines patch added patch discarded remove patch
@@ -35,13 +35,13 @@
 block discarded – undo
35 35
         }
36 36
     }
37 37
     
38
-   /**
39
-    * Resolves the string with which this location needs to be
40
-    * replaced.
41
-    * 
42
-    * @param Mailcode_Parser_Safeguard_Formatter_Location $location
43
-    * @return string
44
-    */
38
+    /**
39
+     * Resolves the string with which this location needs to be
40
+     * replaced.
41
+     * 
42
+     * @param Mailcode_Parser_Safeguard_Formatter_Location $location
43
+     * @return string
44
+     */
45 45
     private function resolveReplacement(Mailcode_Parser_Safeguard_Formatter_Location $location) : string
46 46
     {
47 47
         if($location->requiresAdjustment())
Please login to merge, or discard this patch.
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -29,7 +29,7 @@  discard block
 block discarded – undo
29 29
     {
30 30
         $locations = $this->resolveLocations();
31 31
         
32
-        foreach($locations as $location)
32
+        foreach ($locations as $location)
33 33
         {
34 34
             $location->replaceWith($this->resolveReplacement($location));
35 35
             
@@ -46,7 +46,7 @@  discard block
 block discarded – undo
46 46
     */
47 47
     private function resolveReplacement(Mailcode_Parser_Safeguard_Formatter_Location $location) : string
48 48
     {
49
-        if($location->requiresAdjustment())
49
+        if ($location->requiresAdjustment())
50 50
         {
51 51
             return $this->getReplaceString($location);
52 52
         }
Please login to merge, or discard this patch.
src/Mailcode/Parser/Safeguard/Formatter/Type/SingleLines.php 1 patch
Indentation   +6 added lines, -6 removed lines patch added patch discarded remove patch
@@ -23,14 +23,14 @@
 block discarded – undo
23 23
  */
24 24
 class Mailcode_Parser_Safeguard_Formatter_Type_SingleLines extends Mailcode_Parser_Safeguard_Formatter_FormatType
25 25
 {
26
-   /**
27
-    * @var string
28
-    */
26
+    /**
27
+     * @var string
28
+     */
29 29
     private $eol;
30 30
     
31
-   /**
32
-    * @var int
33
-    */
31
+    /**
32
+     * @var int
33
+     */
34 34
     private $eolLength;
35 35
     
36 36
     protected function initFormatting() : void
Please login to merge, or discard this patch.
src/Mailcode/Parser/Safeguard/Formatter/Type/SingleLines/Location.php 2 patches
Indentation   +6 added lines, -6 removed lines patch added patch discarded remove patch
@@ -25,14 +25,14 @@
 block discarded – undo
25 25
  */
26 26
 class Mailcode_Parser_Safeguard_Formatter_Type_SingleLines_Location extends Mailcode_Parser_Safeguard_Formatter_Location
27 27
 {
28
-   /**
29
-    * @var int
30
-    */
28
+    /**
29
+     * @var int
30
+     */
31 31
     protected $eolLength;
32 32
     
33
-   /**
34
-    * @var string
35
-    */
33
+    /**
34
+     * @var string
35
+     */
36 36
     protected $eol;
37 37
     
38 38
     protected function init() : void
Please login to merge, or discard this patch.
Spacing   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -55,7 +55,7 @@  discard block
 block discarded – undo
55 55
         $position = $this->getStartPosition();
56 56
         
57 57
         // we're at the beginning of the string
58
-        if($position === false || $position === 0)
58
+        if ($position === false || $position === 0)
59 59
         {
60 60
             $this->log(sprintf(
61 61
                 'Prepend: NO | Position: [%s] | Not found, or at beginning of string.', 
@@ -67,7 +67,7 @@  discard block
 block discarded – undo
67 67
         
68 68
         $prevPos = $position - $this->eolLength;
69 69
         
70
-        if($prevPos < 0)
70
+        if ($prevPos < 0)
71 71
         {
72 72
             $prevPos = 0;
73 73
         }
@@ -77,7 +77,7 @@  discard block
 block discarded – undo
77 77
     
78 78
     protected function checkPreviousPosition(int $prevPos) : void
79 79
     {
80
-        if($this->isWithinCommand($prevPos))
80
+        if ($this->isWithinCommand($prevPos))
81 81
         {
82 82
             $this->log(sprintf(
83 83
                 'Prepend: NO | Position: [%s] | Is within a mailcode command.', 
@@ -89,7 +89,7 @@  discard block
 block discarded – undo
89 89
         
90 90
         $match = $this->subject->getSubstr($prevPos, $this->eolLength);
91 91
         
92
-        if($match !== $this->formatter->getEOLChar())
92
+        if ($match !== $this->formatter->getEOLChar())
93 93
         {
94 94
             $this->log(sprintf(
95 95
                 'Prepend: YES | Position: [%s] | Characters: [%s] | Do not match the EOL character.',
@@ -108,7 +108,7 @@  discard block
 block discarded – undo
108 108
         $position = $this->getEndPosition();
109 109
         
110 110
         // we're at the end of the string
111
-        if($position === false || $position >= $subjectLength)
111
+        if ($position === false || $position >= $subjectLength)
112 112
         {
113 113
             $this->log(sprintf(
114 114
                 'Append: NO | Position: [%s] | End of string, or too long | Subject length: [%s]',
@@ -121,7 +121,7 @@  discard block
 block discarded – undo
121 121
         
122 122
         $nextPos = $position + $this->eolLength;
123 123
         
124
-        if($nextPos > $subjectLength)
124
+        if ($nextPos > $subjectLength)
125 125
         {
126 126
             $nextPos = $subjectLength - $this->eolLength;
127 127
         }
@@ -131,7 +131,7 @@  discard block
 block discarded – undo
131 131
     
132 132
     protected function checkNextPosition(int $nextPos) : void
133 133
     {
134
-        if($this->isWithinCommand($nextPos))
134
+        if ($this->isWithinCommand($nextPos))
135 135
         {
136 136
             $this->log(sprintf(
137 137
                 'Append: YES | Position: [%s] | Is within a mailcode command.',
@@ -145,7 +145,7 @@  discard block
 block discarded – undo
145 145
         
146 146
         $next = $this->subject->getSubstr($nextPos, $this->eolLength);
147 147
         
148
-        if($next !== $this->formatter->getEOLChar())
148
+        if ($next !== $this->formatter->getEOLChar())
149 149
         {
150 150
             $this->log(sprintf(
151 151
                 'Append: YES | Position: [%s] | Next characters: [%s] | Do not match the EOL character.',
Please login to merge, or discard this patch.
src/Mailcode/Parser/Safeguard/Formatter/Type/MarkVariables/Location.php 1 patch
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -32,7 +32,7 @@
 block discarded – undo
32 32
     
33 33
     public function requiresAdjustment(): bool
34 34
     {
35
-        if(!parent::requiresAdjustment())
35
+        if (!parent::requiresAdjustment())
36 36
         {
37 37
             return false;
38 38
         }
Please login to merge, or discard this patch.
src/Mailcode/Parser/Safeguard/Formatter/Type/HTMLHighlighting/Location.php 3 patches
Braces   +1 added lines, -2 removed lines patch added patch discarded remove patch
@@ -119,8 +119,7 @@
 block discarded – undo
119 119
             if($closing)
120 120
             {
121 121
                 array_pop($stack);
122
-            }
123
-            else
122
+            } else
124 123
             {
125 124
                 $stack[] = $tagName;
126 125
             }
Please login to merge, or discard this patch.
Indentation   +36 added lines, -36 removed lines patch added patch discarded remove patch
@@ -24,14 +24,14 @@  discard block
 block discarded – undo
24 24
 {
25 25
     const COMMAND_MARKER = '__MAILCODE_COMMAND__';
26 26
     
27
-   /**
28
-    * @var boolean
29
-    */
27
+    /**
28
+     * @var boolean
29
+     */
30 30
     private $ancestryChecked = false;
31 31
     
32
-   /**
33
-    * @var array<int,array<int,string>>
34
-    */
32
+    /**
33
+     * @var array<int,array<int,string>>
34
+     */
35 35
     private $tagAncestry = array();
36 36
     
37 37
     protected function init() : void
@@ -43,12 +43,12 @@  discard block
 block discarded – undo
43 43
         return !$this->isInTagAttributes() && !$this->isInExcludedTag();
44 44
     }
45 45
     
46
-   /**
47
-    * Retrieves the part of the subject string that comes
48
-    * before the command.
49
-    * 
50
-    * @return string
51
-    */
46
+    /**
47
+     * Retrieves the part of the subject string that comes
48
+     * before the command.
49
+     * 
50
+     * @return string
51
+     */
52 52
     private function getHaystackBefore() : string
53 53
     {
54 54
         $pos = $this->getStartPosition();
@@ -65,12 +65,12 @@  discard block
 block discarded – undo
65 65
         return $this->subject->getSubstr(0, $pos).self::COMMAND_MARKER.'>';
66 66
     }
67 67
     
68
-   /**
69
-    * Whether the command is nested in one of the tags
70
-    * that have been added to the list of excluded tags.
71
-    * 
72
-    * @return bool
73
-    */
68
+    /**
69
+     * Whether the command is nested in one of the tags
70
+     * that have been added to the list of excluded tags.
71
+     * 
72
+     * @return bool
73
+     */
74 74
     protected function isInExcludedTag() : bool
75 75
     {
76 76
         $tagNames = $this->getParentTags();
@@ -86,12 +86,12 @@  discard block
 block discarded – undo
86 86
         return false;
87 87
     }
88 88
     
89
-   /**
90
-    * Retrieves a list of the command's parent HTML tags, from
91
-    * highest to lowest.
92
-    * 
93
-    * @return string[]
94
-    */
89
+    /**
90
+     * Retrieves a list of the command's parent HTML tags, from
91
+     * highest to lowest.
92
+     * 
93
+     * @return string[]
94
+     */
95 95
     private function getParentTags() : array
96 96
     {
97 97
         $tags = $this->getTagAncestry();
@@ -116,12 +116,12 @@  discard block
 block discarded – undo
116 116
         return $stack;
117 117
     }
118 118
     
119
-   /**
120
-    * Checks whether the command is located within the attributes
121
-    * of an HTML tag.
122
-    * 
123
-    * @return bool
124
-    */
119
+    /**
120
+     * Checks whether the command is located within the attributes
121
+     * of an HTML tag.
122
+     * 
123
+     * @return bool
124
+     */
125 125
     protected function isInTagAttributes() : bool
126 126
     {
127 127
         $tags = $this->getTagAncestry();
@@ -139,12 +139,12 @@  discard block
 block discarded – undo
139 139
         return false;
140 140
     }
141 141
     
142
-   /**
143
-    * Retrieves a list of tag names that come as parents 
144
-    * above the command.
145
-    * 
146
-    * @return array<int,array<int,string>>
147
-    */
142
+    /**
143
+     * Retrieves a list of tag names that come as parents 
144
+     * above the command.
145
+     * 
146
+     * @return array<int,array<int,string>>
147
+     */
148 148
     private function getTagAncestry() : array
149 149
     {
150 150
         if($this->ancestryChecked)
Please login to merge, or discard this patch.
Spacing   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -53,7 +53,7 @@  discard block
 block discarded – undo
53 53
     {
54 54
         $pos = $this->getStartPosition();
55 55
         
56
-        if(is_bool($pos))
56
+        if (is_bool($pos))
57 57
         {
58 58
             return '';
59 59
         }
@@ -75,9 +75,9 @@  discard block
 block discarded – undo
75 75
     {
76 76
         $tagNames = $this->getParentTags();
77 77
         
78
-        foreach($tagNames as $tagName)
78
+        foreach ($tagNames as $tagName)
79 79
         {
80
-            if($this->formatter->isTagExcluded($tagName))
80
+            if ($this->formatter->isTagExcluded($tagName))
81 81
             {
82 82
                 return true;
83 83
             }
@@ -99,11 +99,11 @@  discard block
 block discarded – undo
99 99
         // Create a stack of all direct parent tags of the command.
100 100
         // Handles closing tags as well.
101 101
         $stack = array();
102
-        foreach($tags[2] as $idx => $tagName)
102
+        foreach ($tags[2] as $idx => $tagName)
103 103
         {
104 104
             $closing = $tags[1][$idx] === '/';
105 105
             
106
-            if($closing)
106
+            if ($closing)
107 107
             {
108 108
                 array_pop($stack);
109 109
             }
@@ -128,9 +128,9 @@  discard block
 block discarded – undo
128 128
         
129 129
         // This check is easy: if the command is in the attribute
130 130
         // of any of the tags, we will find the command marker in there.
131
-        foreach($tags[3] as $attributes)
131
+        foreach ($tags[3] as $attributes)
132 132
         {
133
-            if(strstr($attributes, self::COMMAND_MARKER))
133
+            if (strstr($attributes, self::COMMAND_MARKER))
134 134
             {
135 135
                 return true;
136 136
             }
@@ -147,7 +147,7 @@  discard block
 block discarded – undo
147 147
     */
148 148
     private function getTagAncestry() : array
149 149
     {
150
-        if($this->ancestryChecked)
150
+        if ($this->ancestryChecked)
151 151
         {
152 152
             return $this->tagAncestry;
153 153
         }
Please login to merge, or discard this patch.
src/Mailcode/Parser/Safeguard/Formatter/FormatType.php 2 patches
Indentation   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -25,11 +25,11 @@
 block discarded – undo
25 25
         return PHP_INT_MAX;
26 26
     }
27 27
 
28
-   /**
29
-    * Formats the specified string according to the formatter.
30
-    * Retrieve the updated string from the string container used
31
-    * to create the formatter, or use `getSubjectString()`.
32
-    */
28
+    /**
29
+     * Formats the specified string according to the formatter.
30
+     * Retrieve the updated string from the string container used
31
+     * to create the formatter, or use `getSubjectString()`.
32
+     */
33 33
     public function format() : void
34 34
     {
35 35
         $locations = $this->resolveLocations();
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -34,7 +34,7 @@
 block discarded – undo
34 34
     {
35 35
         $locations = $this->resolveLocations();
36 36
         
37
-        foreach($locations as $location)
37
+        foreach ($locations as $location)
38 38
         {
39 39
             $location->format();
40 40
             
Please login to merge, or discard this patch.
src/Mailcode/Parser/Safeguard/Formatting.php 2 patches
Spacing   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -131,7 +131,7 @@  discard block
 block discarded – undo
131 131
     
132 132
     public function applyFormatting() : void
133 133
     {
134
-        if($this->applied)
134
+        if ($this->applied)
135 135
         {
136 136
             return;
137 137
         }
@@ -146,9 +146,9 @@  discard block
 block discarded – undo
146 146
 
147 147
     private function applyFormatTypes() : void
148 148
     {
149
-        foreach($this->formatters as $formatter)
149
+        foreach ($this->formatters as $formatter)
150 150
         {
151
-            if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_FormatType)
151
+            if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_FormatType)
152 152
             {
153 153
                 $formatter->format();
154 154
             }
@@ -157,9 +157,9 @@  discard block
 block discarded – undo
157 157
     
158 158
     private function applyReplaceTypes() : void
159 159
     {
160
-        foreach($this->formatters as $formatter)
160
+        foreach ($this->formatters as $formatter)
161 161
         {
162
-            if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_ReplacerType)
162
+            if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_ReplacerType)
163 163
             {
164 164
                 $formatter->replace();
165 165
             }
@@ -168,7 +168,7 @@  discard block
 block discarded – undo
168 168
     
169 169
     private function validateFormatters() : void
170 170
     {
171
-        if(empty($this->formatters))
171
+        if (empty($this->formatters))
172 172
         {
173 173
             throw new Mailcode_Exception(
174 174
                 'No formatters selected',
@@ -179,7 +179,7 @@  discard block
 block discarded – undo
179 179
         
180 180
         $amount = $this->countReplacers();
181 181
         
182
-        if($amount > 1) 
182
+        if ($amount > 1) 
183 183
         {
184 184
             throw new Mailcode_Exception(
185 185
                 'More than one replacer formatter selected',
@@ -189,7 +189,7 @@  discard block
 block discarded – undo
189 189
         }
190 190
         
191 191
         // by default, at minimum the normalized formatter must be selected.
192
-        if($amount === 0)
192
+        if ($amount === 0)
193 193
         {
194 194
             $this->replaceWithNormalized();
195 195
         }
@@ -204,9 +204,9 @@  discard block
 block discarded – undo
204 204
     {
205 205
         $count = 0;
206 206
         
207
-        foreach($this->formatters as $formatter)
207
+        foreach ($this->formatters as $formatter)
208 208
         {
209
-            if($formatter instanceof Mailcode_Parser_Safeguard_Formatter_ReplacerType)
209
+            if ($formatter instanceof Mailcode_Parser_Safeguard_Formatter_ReplacerType)
210 210
             {
211 211
                 $count++;
212 212
             }
Please login to merge, or discard this patch.
Indentation   +67 added lines, -67 removed lines patch added patch discarded remove patch
@@ -32,29 +32,29 @@  discard block
 block discarded – undo
32 32
     const ERROR_TOO_MANY_REPLACERS = 65902;
33 33
     const ERROR_NO_FORMATTERS_ADDED = 65903;
34 34
     
35
-   /**
36
-    * @var Mailcode_Parser_Safeguard
37
-    */
35
+    /**
36
+     * @var Mailcode_Parser_Safeguard
37
+     */
38 38
     private $safeguard;
39 39
     
40
-   /**
41
-    * @var Mailcode_Parser_Safeguard_Formatter[]
42
-    */
40
+    /**
41
+     * @var Mailcode_Parser_Safeguard_Formatter[]
42
+     */
43 43
     private $formatters = array();
44 44
     
45
-   /**
46
-    * @var Mailcode_StringContainer
47
-    */
45
+    /**
46
+     * @var Mailcode_StringContainer
47
+     */
48 48
     private $subject;
49 49
     
50
-   /**
51
-    * @var boolean
52
-    */
50
+    /**
51
+     * @var boolean
52
+     */
53 53
     private $applied = false;
54 54
     
55
-   /**
56
-    * @var boolean
57
-    */
55
+    /**
56
+     * @var boolean
57
+     */
58 58
     private $partial = false;
59 59
     
60 60
     public function __construct(Mailcode_Parser_Safeguard $safeguard, Mailcode_StringContainer $subject)
@@ -96,17 +96,17 @@  discard block
 block discarded – undo
96 96
         return $formatter;
97 97
     }
98 98
     
99
-   /**
100
-    * Adds a formatter that will surround all variables with
101
-    * markup to highlight them independently of command syntax
102
-    * highlighting.
103
-    * 
104
-    * This is used to mark variables visually even after commands
105
-    * have been replaced by the target system's post processing.
106
-    * Can be combined with a replacer and other formats.
107
-    * 
108
-    * @return Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables
109
-    */
99
+    /**
100
+     * Adds a formatter that will surround all variables with
101
+     * markup to highlight them independently of command syntax
102
+     * highlighting.
103
+     * 
104
+     * This is used to mark variables visually even after commands
105
+     * have been replaced by the target system's post processing.
106
+     * Can be combined with a replacer and other formats.
107
+     * 
108
+     * @return Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables
109
+     */
110 110
     public function formatWithMarkedVariables() : Mailcode_Parser_Safeguard_Formatter_Type_MarkVariables
111 111
     {
112 112
         $formatter = $this->createMarkVariables();
@@ -200,11 +200,11 @@  discard block
 block discarded – undo
200 200
         }
201 201
     }
202 202
     
203
-   /**
204
-    * Counts the amount of replacer formatters that have been added.
205
-    * 
206
-    * @return int
207
-    */
203
+    /**
204
+     * Counts the amount of replacer formatters that have been added.
205
+     * 
206
+     * @return int
207
+     */
208 208
     private function countReplacers() : int
209 209
     {
210 210
         $count = 0;
@@ -220,37 +220,37 @@  discard block
 block discarded – undo
220 220
         return $count;
221 221
     }
222 222
 
223
-   /**
224
-    * Creates a formatter that adds HTML syntax highlighting
225
-    * for all commands in the specified string, intelligently
226
-    * checking the location of the commands to ensure that they
227
-    * can be syntax highlighted.
228
-    * 
229
-    * For example, commands in HTML attributes will not be
230
-    * highlighted, as this would break the HTML.
231
-    *  
232
-    * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
233
-    */
223
+    /**
224
+     * Creates a formatter that adds HTML syntax highlighting
225
+     * for all commands in the specified string, intelligently
226
+     * checking the location of the commands to ensure that they
227
+     * can be syntax highlighted.
228
+     * 
229
+     * For example, commands in HTML attributes will not be
230
+     * highlighted, as this would break the HTML.
231
+     *  
232
+     * @return Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
233
+     */
234 234
     public function createHTMLHighlighting() : Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting
235 235
     {
236 236
         return new Mailcode_Parser_Safeguard_Formatter_Type_HTMLHighlighting($this);
237 237
     }
238 238
 
239
-   /**
240
-    * Creates the formatter that ensures that all commands
241
-    * are placed on a separate line in the subject string.
242
-    */
239
+    /**
240
+     * Creates the formatter that ensures that all commands
241
+     * are placed on a separate line in the subject string.
242
+     */
243 243
     public function createSingleLines() : Mailcode_Parser_Safeguard_Formatter_Type_SingleLines
244 244
     {
245 245
         return new Mailcode_Parser_Safeguard_Formatter_Type_SingleLines($this);
246 246
     }
247 247
     
248
-   /**
249
-    * Creates the formatter that replaces all commands by
250
-    * their normalized variants.
251
-    * 
252
-    * @return Mailcode_Parser_Safeguard_Formatter_Type_Normalized
253
-    */
248
+    /**
249
+     * Creates the formatter that replaces all commands by
250
+     * their normalized variants.
251
+     * 
252
+     * @return Mailcode_Parser_Safeguard_Formatter_Type_Normalized
253
+     */
254 254
     public function createNormalized() : Mailcode_Parser_Safeguard_Formatter_Type_Normalized
255 255
     {
256 256
         return new Mailcode_Parser_Safeguard_Formatter_Type_Normalized($this);
@@ -273,26 +273,26 @@  discard block
 block discarded – undo
273 273
         return $this->subject->getString();
274 274
     }
275 275
 
276
-   /**
277
-    * Whether the formatting is done partially: missing placeholders
278
-    * will simply be ignored.
279
-    * 
280
-    * @return bool
281
-    */
276
+    /**
277
+     * Whether the formatting is done partially: missing placeholders
278
+     * will simply be ignored.
279
+     * 
280
+     * @return bool
281
+     */
282 282
     public function isPartial() : bool
283 283
     {
284 284
         return $this->partial;
285 285
     }
286 286
     
287
-   /**
288
-    * The formatting will ignore missing placeholders. Use this if the
289
-    * formatting will be done on a text that may not contain all of the
290
-    * initial placeholders anymore.
291
-    * 
292
-    * This is like the safeguard's makeWholePartial() method.
293
-    * 
294
-    * @return Mailcode_Parser_Safeguard_Formatting
295
-    */
287
+    /**
288
+     * The formatting will ignore missing placeholders. Use this if the
289
+     * formatting will be done on a text that may not contain all of the
290
+     * initial placeholders anymore.
291
+     * 
292
+     * This is like the safeguard's makeWholePartial() method.
293
+     * 
294
+     * @return Mailcode_Parser_Safeguard_Formatting
295
+     */
296 296
     public function makePartial() : Mailcode_Parser_Safeguard_Formatting
297 297
     {
298 298
         $this->partial = true;
Please login to merge, or discard this patch.
src/Mailcode/Parser/Safeguard.php 3 patches
Braces   +1 added lines, -2 removed lines patch added patch discarded remove patch
@@ -260,8 +260,7 @@
 block discarded – undo
260 260
         if($highlighted)
261 261
         {
262 262
             $formatting->replaceWithHTMLHighlighting();
263
-        }
264
-        else 
263
+        } else 
265 264
         {
266 265
             $formatting->replaceWithNormalized();
267 266
         }
Please login to merge, or discard this patch.
Spacing   +21 added lines, -21 removed lines patch added patch discarded remove patch
@@ -180,7 +180,7 @@  discard block
 block discarded – undo
180 180
         $placeholders = $this->getPlaceholders();
181 181
         $string = $this->originalString;
182 182
         
183
-        foreach($placeholders as $placeholder)
183
+        foreach ($placeholders as $placeholder)
184 184
         {
185 185
             $string = $this->makePlaceholderSafe($string, $placeholder);
186 186
         }
@@ -210,14 +210,14 @@  discard block
 block discarded – undo
210 210
         $placeholders = $this->getPlaceholders();
211 211
         $total = count($placeholders);
212 212
 
213
-        for($i=0; $i < $total; $i++)
213
+        for ($i = 0; $i < $total; $i++)
214 214
         {
215 215
             $placeholder = $placeholders[$i];
216 216
             $command = $placeholder->getCommand();
217 217
 
218
-            if($command instanceof Mailcode_Interfaces_Commands_ProtectedContent)
218
+            if ($command instanceof Mailcode_Interfaces_Commands_ProtectedContent)
219 219
             {
220
-                $string = $command->protectContent($string, $placeholder, $placeholders[$i+1]);
220
+                $string = $command->protectContent($string, $placeholder, $placeholders[$i + 1]);
221 221
             }
222 222
         }
223 223
 
@@ -228,7 +228,7 @@  discard block
 block discarded – undo
228 228
     {
229 229
         $pos = mb_strpos($string, $placeholder->getOriginalText());
230 230
 
231
-        if($pos === false)
231
+        if ($pos === false)
232 232
         {
233 233
             throw new Mailcode_Exception(
234 234
                 'Placeholder original text not found',
@@ -267,7 +267,7 @@  discard block
 block discarded – undo
267 267
     */
268 268
     public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting
269 269
     {
270
-        if(is_string($subject))
270
+        if (is_string($subject))
271 271
         {
272 272
             $subject = Mailcode::create()->createString($subject);
273 273
         }
@@ -283,7 +283,7 @@  discard block
 block discarded – undo
283 283
     */
284 284
     public function getPlaceholders()
285 285
     {
286
-        if(isset($this->placeholders))
286
+        if (isset($this->placeholders))
287 287
         {
288 288
             return $this->placeholders;
289 289
         }
@@ -292,7 +292,7 @@  discard block
 block discarded – undo
292 292
         
293 293
         $cmds = $this->getCollection()->getCommands();
294 294
         
295
-        foreach($cmds as $command)
295
+        foreach ($cmds as $command)
296 296
         {
297 297
             self::$counter++;
298 298
             
@@ -313,21 +313,21 @@  discard block
 block discarded – undo
313 313
      * @return string
314 314
      * @throws Mailcode_Exception
315 315
      */
316
-    protected function restore(string $string, bool $partial=false, bool $highlighted=false) : string
316
+    protected function restore(string $string, bool $partial = false, bool $highlighted = false) : string
317 317
     {
318
-        if(!$partial)
318
+        if (!$partial)
319 319
         {
320 320
             $this->requireValidCollection();
321 321
         }
322 322
         
323 323
         $formatting = $this->createFormatting($string);
324 324
 
325
-        if($partial)
325
+        if ($partial)
326 326
         {
327 327
             $formatting->makePartial();
328 328
         }
329 329
         
330
-        if($highlighted)
330
+        if ($highlighted)
331 331
         {
332 332
             $formatting->replaceWithHTMLHighlighting();
333 333
         }
@@ -347,7 +347,7 @@  discard block
 block discarded – undo
347 347
         {
348 348
             $command = $placeholder->getCommand();
349 349
 
350
-            if($command instanceof Mailcode_Interfaces_Commands_ProtectedContent)
350
+            if ($command instanceof Mailcode_Interfaces_Commands_ProtectedContent)
351 351
             {
352 352
                 $string = $command->restoreContent($string);
353 353
             }
@@ -440,7 +440,7 @@  discard block
 block discarded – undo
440 440
     */
441 441
     public function getCollection() : Mailcode_Collection
442 442
     {
443
-        if(isset($this->collection))
443
+        if (isset($this->collection))
444 444
         {
445 445
             return $this->collection;
446 446
         }
@@ -462,7 +462,7 @@  discard block
 block discarded – undo
462 462
     */
463 463
     protected function requireValidCollection() : void
464 464
     {
465
-        if($this->getCollection()->isValid())
465
+        if ($this->getCollection()->isValid())
466 466
         {
467 467
             return;
468 468
         }
@@ -485,7 +485,7 @@  discard block
 block discarded – undo
485 485
     */
486 486
     public function getPlaceholderStrings() : array
487 487
     {
488
-        if(is_array($this->placeholderStrings))
488
+        if (is_array($this->placeholderStrings))
489 489
         {
490 490
             return $this->placeholderStrings;
491 491
         }
@@ -494,7 +494,7 @@  discard block
 block discarded – undo
494 494
         
495 495
         $this->placeholderStrings = array();
496 496
         
497
-        foreach($placeholders as $placeholder)
497
+        foreach ($placeholders as $placeholder)
498 498
         {
499 499
             $this->placeholderStrings[] = $placeholder->getReplacementText();
500 500
         }
@@ -520,9 +520,9 @@  discard block
 block discarded – undo
520 520
     {
521 521
         $placeholders = $this->getPlaceholders();
522 522
         
523
-        foreach($placeholders as $placeholder)
523
+        foreach ($placeholders as $placeholder)
524 524
         {
525
-            if($placeholder->getID() === $id)
525
+            if ($placeholder->getID() === $id)
526 526
             {
527 527
                 return $placeholder;
528 528
             }
@@ -549,9 +549,9 @@  discard block
 block discarded – undo
549 549
     {
550 550
         $placeholders = $this->getPlaceholders();
551 551
         
552
-        foreach($placeholders as $placeholder)
552
+        foreach ($placeholders as $placeholder)
553 553
         {
554
-            if($placeholder->getReplacementText() === $string)
554
+            if ($placeholder->getReplacementText() === $string)
555 555
             {
556 556
                 return $placeholder;
557 557
             }
Please login to merge, or discard this patch.
Indentation   +144 added lines, -144 removed lines patch added patch discarded remove patch
@@ -54,45 +54,45 @@  discard block
 block discarded – undo
54 54
     const ERROR_INVALID_COMMANDS = 47801;
55 55
     const ERROR_PLACEHOLDER_NOT_FOUND = 47804;
56 56
 
57
-   /**
58
-    * @var Mailcode_Parser
59
-    */
57
+    /**
58
+     * @var Mailcode_Parser
59
+     */
60 60
     protected $parser;
61 61
     
62
-   /**
63
-    * @var Mailcode_Collection
64
-    */
62
+    /**
63
+     * @var Mailcode_Collection
64
+     */
65 65
     protected $commands;
66 66
     
67
-   /**
68
-    * @var string
69
-    */
67
+    /**
68
+     * @var string
69
+     */
70 70
     protected $originalString;
71 71
     
72
-   /**
73
-    * @var Mailcode_Collection
74
-    */
72
+    /**
73
+     * @var Mailcode_Collection
74
+     */
75 75
     protected $collection;
76 76
     
77
-   /**
78
-    * Counter for the placeholders, global for all placeholders.
79
-    * @var integer
80
-    */
77
+    /**
78
+     * Counter for the placeholders, global for all placeholders.
79
+     * @var integer
80
+     */
81 81
     private static $counter = 0;
82 82
     
83
-   /**
84
-    * @var Mailcode_Parser_Safeguard_Placeholder[]
85
-    */
83
+    /**
84
+     * @var Mailcode_Parser_Safeguard_Placeholder[]
85
+     */
86 86
     protected $placeholders;
87 87
     
88
-   /**
89
-    * @var string
90
-    */
88
+    /**
89
+     * @var string
90
+     */
91 91
     protected $delimiter = '999';
92 92
     
93
-   /**
94
-    * @var string[]|NULL
95
-    */
93
+    /**
94
+     * @var string[]|NULL
95
+     */
96 96
     protected $placeholderStrings;
97 97
 
98 98
     public function __construct(Mailcode_Parser $parser, string $subject)
@@ -111,28 +111,28 @@  discard block
 block discarded – undo
111 111
         self::$counter = 0;
112 112
     }
113 113
     
114
-   /**
115
-    * Retrieves the string the safeguard was created for.
116
-    * 
117
-    * @return string
118
-    */
114
+    /**
115
+     * Retrieves the string the safeguard was created for.
116
+     * 
117
+     * @return string
118
+     */
119 119
     public function getOriginalString() : string
120 120
     {
121 121
         return $this->originalString;
122 122
     }
123 123
     
124
-   /**
125
-    * Sets the delimiter character sequence used to prepend
126
-    * and append to the placeholders.
127
-    * 
128
-    * The delimiter's default is "999".
129
-    *
130
-    * Minimum characters: 2
131
-    * Invalid characters: Any characters that get URL encoded
132
-    *
133
-    * @param string $delimiter
134
-    * @return Mailcode_Parser_Safeguard
135
-    */
124
+    /**
125
+     * Sets the delimiter character sequence used to prepend
126
+     * and append to the placeholders.
127
+     * 
128
+     * The delimiter's default is "999".
129
+     *
130
+     * Minimum characters: 2
131
+     * Invalid characters: Any characters that get URL encoded
132
+     *
133
+     * @param string $delimiter
134
+     * @return Mailcode_Parser_Safeguard
135
+     */
136 136
     public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
137 137
     {
138 138
         $validator = new Mailcode_Parser_Safeguard_DelimiterValidator($delimiter);
@@ -148,15 +148,15 @@  discard block
 block discarded – undo
148 148
         return $this->delimiter;
149 149
     }
150 150
     
151
-   /**
152
-    * Retrieves the safe string in which all commands have been replaced
153
-    * by placeholder strings.
154
-    *
155
-    * @return string
156
-    * @throws Mailcode_Exception 
157
-    *
158
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
159
-    */
151
+    /**
152
+     * Retrieves the safe string in which all commands have been replaced
153
+     * by placeholder strings.
154
+     *
155
+     * @return string
156
+     * @throws Mailcode_Exception 
157
+     *
158
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
159
+     */
160 160
     public function makeSafe() : string
161 161
     {
162 162
         $this->requireValidCollection();
@@ -164,16 +164,16 @@  discard block
 block discarded – undo
164 164
         return $this->makeSafePartial();
165 165
     }
166 166
     
167
-   /**
168
-    * Like makeSafe(), but allows partial (invalid) commands: use this
169
-    * if the subject string may contain only part of the whole set of
170
-    * commands. 
171
-    * 
172
-    * Example: parsing a text with an opening if statement, without the 
173
-    * matching end statement.
174
-    * 
175
-    * @return string
176
-    */
167
+    /**
168
+     * Like makeSafe(), but allows partial (invalid) commands: use this
169
+     * if the subject string may contain only part of the whole set of
170
+     * commands. 
171
+     * 
172
+     * Example: parsing a text with an opening if statement, without the 
173
+     * matching end statement.
174
+     * 
175
+     * @return string
176
+     */
177 177
     public function makeSafePartial() : string
178 178
     {
179 179
         $placeholders = $this->getPlaceholders();
@@ -257,13 +257,13 @@  discard block
 block discarded – undo
257 257
         $analyzer->analyze();
258 258
     }
259 259
     
260
-   /**
261
-    * Creates a formatting handler, which can be used to specify
262
-    * which formattings to use for the commands in the subject string.
263
-    * 
264
-    * @param Mailcode_StringContainer|string $subject
265
-    * @return Mailcode_Parser_Safeguard_Formatting
266
-    */
260
+    /**
261
+     * Creates a formatting handler, which can be used to specify
262
+     * which formattings to use for the commands in the subject string.
263
+     * 
264
+     * @param Mailcode_StringContainer|string $subject
265
+     * @return Mailcode_Parser_Safeguard_Formatting
266
+     */
267 267
     public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting
268 268
     {
269 269
         if(is_string($subject))
@@ -274,12 +274,12 @@  discard block
 block discarded – undo
274 274
         return new Mailcode_Parser_Safeguard_Formatting($this, $subject);
275 275
     }
276 276
     
277
-   /**
278
-    * Retrieves all placeholders that have to be added to
279
-    * the subject text.
280
-    * 
281
-    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
282
-    */
277
+    /**
278
+     * Retrieves all placeholders that have to be added to
279
+     * the subject text.
280
+     * 
281
+     * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
282
+     */
283 283
     public function getPlaceholders()
284 284
     {
285 285
         if(isset($this->placeholders))
@@ -355,16 +355,16 @@  discard block
 block discarded – undo
355 355
         return $string;
356 356
     }
357 357
     
358
-   /**
359
-    * Makes the string whole again after transforming or filtering it,
360
-    * by replacing the command placeholders with the original commands.
361
-    *
362
-    * @param string $string
363
-    * @return string
364
-    * @throws Mailcode_Exception
365
-    *
366
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
367
-    */
358
+    /**
359
+     * Makes the string whole again after transforming or filtering it,
360
+     * by replacing the command placeholders with the original commands.
361
+     *
362
+     * @param string $string
363
+     * @return string
364
+     * @throws Mailcode_Exception
365
+     *
366
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
367
+     */
368 368
     public function makeWhole(string $string) : string
369 369
     {
370 370
         return $this->restore(
@@ -374,15 +374,15 @@  discard block
 block discarded – undo
374 374
         );
375 375
     }
376 376
     
377
-   /**
378
-    * Like `makeWhole()`, but ignores missing command placeholders.
379
-    *
380
-    * @param string $string
381
-    * @return string
382
-    * @throws Mailcode_Exception
383
-    *
384
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
385
-    */
377
+    /**
378
+     * Like `makeWhole()`, but ignores missing command placeholders.
379
+     *
380
+     * @param string $string
381
+     * @return string
382
+     * @throws Mailcode_Exception
383
+     *
384
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
385
+     */
386 386
     public function makeWholePartial(string $string) : string
387 387
     {
388 388
         return $this->restore(
@@ -392,19 +392,19 @@  discard block
 block discarded – undo
392 392
         );
393 393
     }
394 394
 
395
-   /**
396
-    * Like `makeWhole()`, but replaces the commands with a syntax
397
-    * highlighted version, meant for human readable texts only.
398
-    * 
399
-    * Note: the commands lose their functionality (They cannot be 
400
-    * parsed from that string again).
401
-    *
402
-    * @param string $string
403
-    * @return string
404
-    * @throws Mailcode_Exception
405
-    *
406
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
407
-    */
395
+    /**
396
+     * Like `makeWhole()`, but replaces the commands with a syntax
397
+     * highlighted version, meant for human readable texts only.
398
+     * 
399
+     * Note: the commands lose their functionality (They cannot be 
400
+     * parsed from that string again).
401
+     *
402
+     * @param string $string
403
+     * @return string
404
+     * @throws Mailcode_Exception
405
+     *
406
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
407
+     */
408 408
     public function makeHighlighted(string $string) : string
409 409
     {
410 410
         return $this->restore(
@@ -414,15 +414,15 @@  discard block
 block discarded – undo
414 414
         );
415 415
     }
416 416
     
417
-   /**
418
-    * Like `makeHighlighted()`, but ignores missing command placeholders.
419
-    * 
420
-    * @param string $string
421
-    * @return string
422
-    * @throws Mailcode_Exception
423
-    *
424
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
425
-    */
417
+    /**
418
+     * Like `makeHighlighted()`, but ignores missing command placeholders.
419
+     * 
420
+     * @param string $string
421
+     * @return string
422
+     * @throws Mailcode_Exception
423
+     *
424
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
425
+     */
426 426
     public function makeHighlightedPartial(string $string) : string
427 427
     {
428 428
         return $this->restore(
@@ -432,11 +432,11 @@  discard block
 block discarded – undo
432 432
         );
433 433
     }
434 434
     
435
-   /**
436
-    * Retrieves the commands collection contained in the string.
437
-    * 
438
-    * @return Mailcode_Collection
439
-    */
435
+    /**
436
+     * Retrieves the commands collection contained in the string.
437
+     * 
438
+     * @return Mailcode_Collection
439
+     */
440 440
     public function getCollection() : Mailcode_Collection
441 441
     {
442 442
         if(isset($this->collection))
@@ -454,11 +454,11 @@  discard block
 block discarded – undo
454 454
         return $this->getCollection()->isValid();
455 455
     }
456 456
     
457
-   /**
458
-    * @throws Mailcode_Exception
459
-    * 
460
-    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
461
-    */
457
+    /**
458
+     * @throws Mailcode_Exception
459
+     * 
460
+     * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
461
+     */
462 462
     protected function requireValidCollection() : void
463 463
     {
464 464
         if($this->getCollection()->isValid())
@@ -477,11 +477,11 @@  discard block
 block discarded – undo
477 477
         );
478 478
     }
479 479
     
480
-   /**
481
-    * Retrieves a list of all placeholder IDs used in the text.
482
-    * 
483
-    * @return string[]
484
-    */
480
+    /**
481
+     * Retrieves a list of all placeholder IDs used in the text.
482
+     * 
483
+     * @return string[]
484
+     */
485 485
     public function getPlaceholderStrings() : array
486 486
     {
487 487
         if(is_array($this->placeholderStrings))
@@ -508,13 +508,13 @@  discard block
 block discarded – undo
508 508
         return in_array($subject, $ids, true);
509 509
     }
510 510
     
511
-   /**
512
-    * Retrieves a placeholder instance by its ID.
513
-    * 
514
-    * @param int $id
515
-    * @throws Mailcode_Exception If the placeholder was not found.
516
-    * @return Mailcode_Parser_Safeguard_Placeholder
517
-    */
511
+    /**
512
+     * Retrieves a placeholder instance by its ID.
513
+     * 
514
+     * @param int $id
515
+     * @throws Mailcode_Exception If the placeholder was not found.
516
+     * @return Mailcode_Parser_Safeguard_Placeholder
517
+     */
518 518
     public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder
519 519
     {
520 520
         $placeholders = $this->getPlaceholders();
@@ -537,13 +537,13 @@  discard block
 block discarded – undo
537 537
         );
538 538
     }
539 539
     
540
-   /**
541
-    * Retrieves a placeholder instance by its replacement text.
542
-    * 
543
-    * @param string $string
544
-    * @throws Mailcode_Exception
545
-    * @return Mailcode_Parser_Safeguard_Placeholder
546
-    */
540
+    /**
541
+     * Retrieves a placeholder instance by its replacement text.
542
+     * 
543
+     * @param string $string
544
+     * @throws Mailcode_Exception
545
+     * @return Mailcode_Parser_Safeguard_Placeholder
546
+     */
547 547
     public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder
548 548
     {
549 549
         $placeholders = $this->getPlaceholders();
Please login to merge, or discard this patch.