@@ -23,14 +23,14 @@ discard block |
||
| 23 | 23 | */ |
| 24 | 24 | class Mailcode_Parser_Safeguard_Formatter_SingleLines extends Mailcode_Parser_Safeguard_Formatter |
| 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(string $subject) : string |
@@ -51,13 +51,13 @@ discard block |
||
| 51 | 51 | return $this->eolLength; |
| 52 | 52 | } |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * We only use placeholders that contain commands that do |
|
| 56 | - * not generate contents, since these are the only ones |
|
| 57 | - * that may need adjusting. |
|
| 58 | - * |
|
| 59 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
| 60 | - */ |
|
| 54 | + /** |
|
| 55 | + * We only use placeholders that contain commands that do |
|
| 56 | + * not generate contents, since these are the only ones |
|
| 57 | + * that may need adjusting. |
|
| 58 | + * |
|
| 59 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
| 60 | + */ |
|
| 61 | 61 | protected function filterPlaceholders() |
| 62 | 62 | { |
| 63 | 63 | $placeholders = $this->safeguard->getPlaceholders(); |
@@ -64,9 +64,9 @@ |
||
| 64 | 64 | |
| 65 | 65 | $result = array(); |
| 66 | 66 | |
| 67 | - foreach($placeholders as $placeholder) |
|
| 67 | + foreach ($placeholders as $placeholder) |
|
| 68 | 68 | { |
| 69 | - if(!$placeholder->getCommand()->generatesContent()) |
|
| 69 | + if (!$placeholder->getCommand()->generatesContent()) |
|
| 70 | 70 | { |
| 71 | 71 | $result[] = $placeholder; |
| 72 | 72 | } |
@@ -23,24 +23,24 @@ discard block |
||
| 23 | 23 | */ |
| 24 | 24 | class Mailcode_Parser_Safeguard_Formatter_SingleLines_Location extends Mailcode_Parser_Safeguard_FormatterLocation |
| 25 | 25 | { |
| 26 | - /** |
|
| 27 | - * @var int |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var int |
|
| 28 | + */ |
|
| 29 | 29 | protected $eolLength; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var string |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var string |
|
| 33 | + */ |
|
| 34 | 34 | protected $eol; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var boolean |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var boolean |
|
| 38 | + */ |
|
| 39 | 39 | protected $prepend = false; |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @var boolean |
|
| 43 | - */ |
|
| 41 | + /** |
|
| 42 | + * @var boolean |
|
| 43 | + */ |
|
| 44 | 44 | protected $append = false; |
| 45 | 45 | |
| 46 | 46 | protected function init() : void |
@@ -52,11 +52,11 @@ discard block |
||
| 52 | 52 | $this->analyzeAppend(); |
| 53 | 53 | } |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * Whether an EOL character needs to be appended or prepended. |
|
| 57 | - * |
|
| 58 | - * @return bool |
|
| 59 | - */ |
|
| 55 | + /** |
|
| 56 | + * Whether an EOL character needs to be appended or prepended. |
|
| 57 | + * |
|
| 58 | + * @return bool |
|
| 59 | + */ |
|
| 60 | 60 | public function requiresAdjustment() : bool |
| 61 | 61 | { |
| 62 | 62 | return $this->requiresAppend() || $this->requiresPrepend(); |
@@ -77,21 +77,21 @@ discard block |
||
| 77 | 77 | $position = $this->location->getStartPosition(); |
| 78 | 78 | |
| 79 | 79 | // we're at the beginning of the string |
| 80 | - if($position == 0) |
|
| 80 | + if ($position == 0) |
|
| 81 | 81 | { |
| 82 | 82 | return; |
| 83 | 83 | } |
| 84 | 84 | |
| 85 | 85 | $prevPos = $position - $this->eolLength; |
| 86 | 86 | |
| 87 | - if($prevPos < 0) |
|
| 87 | + if ($prevPos < 0) |
|
| 88 | 88 | { |
| 89 | 89 | $prevPos = 0; |
| 90 | 90 | } |
| 91 | 91 | |
| 92 | 92 | $prev = mb_substr($this->location->getSubjectString(), $prevPos, $this->eolLength); |
| 93 | 93 | |
| 94 | - if($prev !== $this->formatter->getEOLChar()) |
|
| 94 | + if ($prev !== $this->formatter->getEOLChar()) |
|
| 95 | 95 | { |
| 96 | 96 | $this->prepend = true; |
| 97 | 97 | } |
@@ -104,21 +104,21 @@ discard block |
||
| 104 | 104 | $position = $this->location->getEndPosition(); |
| 105 | 105 | |
| 106 | 106 | // we're at the end of the string |
| 107 | - if($position >= $subjectLength) |
|
| 107 | + if ($position >= $subjectLength) |
|
| 108 | 108 | { |
| 109 | 109 | return; |
| 110 | 110 | } |
| 111 | 111 | |
| 112 | 112 | $nextPos = $position + $this->eolLength; |
| 113 | 113 | |
| 114 | - if($nextPos > $subjectLength) |
|
| 114 | + if ($nextPos > $subjectLength) |
|
| 115 | 115 | { |
| 116 | 116 | $nextPos = $subjectLength - $this->eolLength; |
| 117 | 117 | } |
| 118 | 118 | |
| 119 | 119 | $next = mb_substr($this->location->getSubjectString(), $nextPos, $this->eolLength); |
| 120 | 120 | |
| 121 | - if($next !== $this->formatter->getEOLChar()) |
|
| 121 | + if ($next !== $this->formatter->getEOLChar()) |
|
| 122 | 122 | { |
| 123 | 123 | $this->append = true; |
| 124 | 124 | } |
@@ -129,12 +129,12 @@ discard block |
||
| 129 | 129 | $prepend = ''; |
| 130 | 130 | $append = ''; |
| 131 | 131 | |
| 132 | - if($this->requiresPrepend()) |
|
| 132 | + if ($this->requiresPrepend()) |
|
| 133 | 133 | { |
| 134 | 134 | $prepend = $this->eol; |
| 135 | 135 | } |
| 136 | 136 | |
| 137 | - if($this->requiresAppend()) |
|
| 137 | + if ($this->requiresAppend()) |
|
| 138 | 138 | { |
| 139 | 139 | $append = $this->eol; |
| 140 | 140 | } |
@@ -24,9 +24,9 @@ discard block |
||
| 24 | 24 | { |
| 25 | 25 | const COMMAND_MARKER = '__MAILCODE_COMMAND__'; |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var array<int,array<int,string>> |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var array<int,array<int,string>> |
|
| 29 | + */ |
|
| 30 | 30 | private $tagAncestry; |
| 31 | 31 | |
| 32 | 32 | protected function init() : void |
@@ -49,18 +49,18 @@ discard block |
||
| 49 | 49 | { |
| 50 | 50 | if($this->isInTagAttributes() || $this->isInExcludedTag()) |
| 51 | 51 | { |
| 52 | - return false; |
|
| 52 | + return false; |
|
| 53 | 53 | } |
| 54 | 54 | |
| 55 | 55 | return true; |
| 56 | 56 | } |
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * Retrieves the part of the subject string that comes |
|
| 60 | - * before the command. |
|
| 61 | - * |
|
| 62 | - * @return string |
|
| 63 | - */ |
|
| 58 | + /** |
|
| 59 | + * Retrieves the part of the subject string that comes |
|
| 60 | + * before the command. |
|
| 61 | + * |
|
| 62 | + * @return string |
|
| 63 | + */ |
|
| 64 | 64 | private function getHaystackBefore() : string |
| 65 | 65 | { |
| 66 | 66 | $pos = $this->location->getStartPosition(); |
@@ -80,12 +80,12 @@ discard block |
||
| 80 | 80 | return mb_substr($subject, 0, $pos).self::COMMAND_MARKER.'>'; |
| 81 | 81 | } |
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * Whether the command is nested in one of the tags |
|
| 85 | - * that have been added to the list of excluded tags. |
|
| 86 | - * |
|
| 87 | - * @return bool |
|
| 88 | - */ |
|
| 83 | + /** |
|
| 84 | + * Whether the command is nested in one of the tags |
|
| 85 | + * that have been added to the list of excluded tags. |
|
| 86 | + * |
|
| 87 | + * @return bool |
|
| 88 | + */ |
|
| 89 | 89 | private function isInExcludedTag() : bool |
| 90 | 90 | { |
| 91 | 91 | $tagNames = $this->getParentTags(); |
@@ -101,12 +101,12 @@ discard block |
||
| 101 | 101 | return false; |
| 102 | 102 | } |
| 103 | 103 | |
| 104 | - /** |
|
| 105 | - * Retrieves a list of the command's parent HTML tags, from |
|
| 106 | - * highest to lowest. |
|
| 107 | - * |
|
| 108 | - * @return string[] |
|
| 109 | - */ |
|
| 104 | + /** |
|
| 105 | + * Retrieves a list of the command's parent HTML tags, from |
|
| 106 | + * highest to lowest. |
|
| 107 | + * |
|
| 108 | + * @return string[] |
|
| 109 | + */ |
|
| 110 | 110 | private function getParentTags() : array |
| 111 | 111 | { |
| 112 | 112 | // Create a stack of all direct parent tags of the command. |
@@ -129,12 +129,12 @@ discard block |
||
| 129 | 129 | return $stack; |
| 130 | 130 | } |
| 131 | 131 | |
| 132 | - /** |
|
| 133 | - * Checks whether the command is located within the attributes |
|
| 134 | - * of an HTML tag. |
|
| 135 | - * |
|
| 136 | - * @return bool |
|
| 137 | - */ |
|
| 132 | + /** |
|
| 133 | + * Checks whether the command is located within the attributes |
|
| 134 | + * of an HTML tag. |
|
| 135 | + * |
|
| 136 | + * @return bool |
|
| 137 | + */ |
|
| 138 | 138 | private function isInTagAttributes() : bool |
| 139 | 139 | { |
| 140 | 140 | // This check is easy: if the command is in the attribute |
@@ -47,7 +47,7 @@ discard block |
||
| 47 | 47 | |
| 48 | 48 | public function requiresAdjustment(): bool |
| 49 | 49 | { |
| 50 | - if($this->isInTagAttributes() || $this->isInExcludedTag()) |
|
| 50 | + if ($this->isInTagAttributes() || $this->isInExcludedTag()) |
|
| 51 | 51 | { |
| 52 | 52 | return false; |
| 53 | 53 | } |
@@ -66,7 +66,7 @@ discard block |
||
| 66 | 66 | $pos = $this->location->getStartPosition(); |
| 67 | 67 | |
| 68 | 68 | // at the beginning of the document? Sure, we can highlight this. |
| 69 | - if($pos === 0) |
|
| 69 | + if ($pos === 0) |
|
| 70 | 70 | { |
| 71 | 71 | return ''; |
| 72 | 72 | } |
@@ -90,9 +90,9 @@ discard block |
||
| 90 | 90 | { |
| 91 | 91 | $tagNames = $this->getParentTags(); |
| 92 | 92 | |
| 93 | - foreach($tagNames as $tagName) |
|
| 93 | + foreach ($tagNames as $tagName) |
|
| 94 | 94 | { |
| 95 | - if($this->formatter->isTagExcluded($tagName)) |
|
| 95 | + if ($this->formatter->isTagExcluded($tagName)) |
|
| 96 | 96 | { |
| 97 | 97 | return true; |
| 98 | 98 | } |
@@ -112,11 +112,11 @@ discard block |
||
| 112 | 112 | // Create a stack of all direct parent tags of the command. |
| 113 | 113 | // Handles closing tags as well. |
| 114 | 114 | $stack = array(); |
| 115 | - foreach($this->tagAncestry[2] as $idx => $tagName) |
|
| 115 | + foreach ($this->tagAncestry[2] as $idx => $tagName) |
|
| 116 | 116 | { |
| 117 | 117 | $closing = $this->tagAncestry[1][$idx] === '/'; |
| 118 | 118 | |
| 119 | - if($closing) |
|
| 119 | + if ($closing) |
|
| 120 | 120 | { |
| 121 | 121 | array_pop($stack); |
| 122 | 122 | } |
@@ -139,9 +139,9 @@ discard block |
||
| 139 | 139 | { |
| 140 | 140 | // This check is easy: if the command is in the attribute |
| 141 | 141 | // of any of the tags, we will find the command marker in there. |
| 142 | - foreach($this->tagAncestry[3] as $attributes) |
|
| 142 | + foreach ($this->tagAncestry[3] as $attributes) |
|
| 143 | 143 | { |
| 144 | - if(strstr($attributes, self::COMMAND_MARKER)) |
|
| 144 | + if (strstr($attributes, self::COMMAND_MARKER)) |
|
| 145 | 145 | { |
| 146 | 146 | return true; |
| 147 | 147 | } |
@@ -119,8 +119,7 @@ |
||
| 119 | 119 | if($closing) |
| 120 | 120 | { |
| 121 | 121 | array_pop($stack); |
| 122 | - } |
|
| 123 | - else |
|
| 122 | + } else |
|
| 124 | 123 | { |
| 125 | 124 | $stack[] = $tagName; |
| 126 | 125 | } |
@@ -22,9 +22,9 @@ discard block |
||
| 22 | 22 | */ |
| 23 | 23 | class Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting extends Mailcode_Parser_Safeguard_Formatter |
| 24 | 24 | { |
| 25 | - /** |
|
| 26 | - * @var string[] |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var string[] |
|
| 27 | + */ |
|
| 28 | 28 | private $excludeTags = array( |
| 29 | 29 | 'style', // NOTE: style tags are excluded natively on the parser level. |
| 30 | 30 | 'script' |
@@ -35,13 +35,13 @@ discard block |
||
| 35 | 35 | return $subject; |
| 36 | 36 | } |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * Adds an HTML tag name to the list of tags within which |
|
| 40 | - * commands may not be highlighted. |
|
| 41 | - * |
|
| 42 | - * @param string $tagName Case insensitive. |
|
| 43 | - * @return Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting |
|
| 44 | - */ |
|
| 38 | + /** |
|
| 39 | + * Adds an HTML tag name to the list of tags within which |
|
| 40 | + * commands may not be highlighted. |
|
| 41 | + * |
|
| 42 | + * @param string $tagName Case insensitive. |
|
| 43 | + * @return Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting |
|
| 44 | + */ |
|
| 45 | 45 | public function excludeTag(string $tagName) : Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting |
| 46 | 46 | { |
| 47 | 47 | $tagName = strtolower($tagName); |
@@ -54,12 +54,12 @@ discard block |
||
| 54 | 54 | return $this; |
| 55 | 55 | } |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Adds several exluded tag names at once. |
|
| 59 | - * |
|
| 60 | - * @param string[] $tagNames |
|
| 61 | - * @return Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting |
|
| 62 | - */ |
|
| 57 | + /** |
|
| 58 | + * Adds several exluded tag names at once. |
|
| 59 | + * |
|
| 60 | + * @param string[] $tagNames |
|
| 61 | + * @return Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting |
|
| 62 | + */ |
|
| 63 | 63 | public function excludeTags(array $tagNames) : Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting |
| 64 | 64 | { |
| 65 | 65 | foreach($tagNames as $tagName) |
@@ -70,12 +70,12 @@ discard block |
||
| 70 | 70 | return $this; |
| 71 | 71 | } |
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * Whether the specified tag name is in the exlusion list. |
|
| 75 | - * |
|
| 76 | - * @param string $tagName |
|
| 77 | - * @return bool |
|
| 78 | - */ |
|
| 73 | + /** |
|
| 74 | + * Whether the specified tag name is in the exlusion list. |
|
| 75 | + * |
|
| 76 | + * @param string $tagName |
|
| 77 | + * @return bool |
|
| 78 | + */ |
|
| 79 | 79 | public function isTagExcluded(string $tagName) : bool |
| 80 | 80 | { |
| 81 | 81 | $tagName = strtolower($tagName); |
@@ -46,7 +46,7 @@ discard block |
||
| 46 | 46 | { |
| 47 | 47 | $tagName = strtolower($tagName); |
| 48 | 48 | |
| 49 | - if(!in_array($tagName, $this->excludeTags)) |
|
| 49 | + if (!in_array($tagName, $this->excludeTags)) |
|
| 50 | 50 | { |
| 51 | 51 | $this->excludeTags[] = $tagName; |
| 52 | 52 | } |
@@ -62,7 +62,7 @@ discard block |
||
| 62 | 62 | */ |
| 63 | 63 | public function excludeTags(array $tagNames) : Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting |
| 64 | 64 | { |
| 65 | - foreach($tagNames as $tagName) |
|
| 65 | + foreach ($tagNames as $tagName) |
|
| 66 | 66 | { |
| 67 | 67 | $this->excludeTag((string)$tagName); |
| 68 | 68 | } |
@@ -24,9 +24,9 @@ discard block |
||
| 24 | 24 | */ |
| 25 | 25 | abstract class Mailcode_Parser_Safeguard_Formatter |
| 26 | 26 | { |
| 27 | - /** |
|
| 28 | - * @var Mailcode_Parser_Safeguard |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var Mailcode_Parser_Safeguard |
|
| 29 | + */ |
|
| 30 | 30 | protected $safeguard; |
| 31 | 31 | |
| 32 | 32 | public function __construct(Mailcode_Parser_Safeguard $safeguard) |
@@ -88,12 +88,12 @@ discard block |
||
| 88 | 88 | return $locator->getSubjectString(); |
| 89 | 89 | } |
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * Resolves the newline character used in the string. |
|
| 93 | - * |
|
| 94 | - * @param string $subject |
|
| 95 | - * @return string |
|
| 96 | - */ |
|
| 91 | + /** |
|
| 92 | + * Resolves the newline character used in the string. |
|
| 93 | + * |
|
| 94 | + * @param string $subject |
|
| 95 | + * @return string |
|
| 96 | + */ |
|
| 97 | 97 | protected function resolveNewlineChar(string $subject) : string |
| 98 | 98 | { |
| 99 | 99 | $eol = ConvertHelper::detectEOLCharacter($subject); |
@@ -106,9 +106,9 @@ discard block |
||
| 106 | 106 | return PHP_EOL; |
| 107 | 107 | } |
| 108 | 108 | |
| 109 | - /** |
|
| 110 | - * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
| 111 | - */ |
|
| 109 | + /** |
|
| 110 | + * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[] |
|
| 111 | + */ |
|
| 112 | 112 | protected function filterPlaceholders() |
| 113 | 113 | { |
| 114 | 114 | return $this->safeguard->getPlaceholders(); |
@@ -62,7 +62,7 @@ discard block |
||
| 62 | 62 | |
| 63 | 63 | $total = count($placeholders); |
| 64 | 64 | |
| 65 | - for($i=0; $i < $total; $i++) |
|
| 65 | + for ($i = 0; $i < $total; $i++) |
|
| 66 | 66 | { |
| 67 | 67 | $subject = $this->process($placeholders[$i], $subject); |
| 68 | 68 | } |
@@ -75,11 +75,11 @@ discard block |
||
| 75 | 75 | $locator = $placeholder->createLocator($subject); |
| 76 | 76 | $positions = $locator->getLocations(); |
| 77 | 77 | |
| 78 | - foreach($positions as $position) |
|
| 78 | + foreach ($positions as $position) |
|
| 79 | 79 | { |
| 80 | 80 | $replace = $this->resolveReplacementText($position); |
| 81 | 81 | |
| 82 | - if($replace !== $position->getPlaceholderString()) |
|
| 82 | + if ($replace !== $position->getPlaceholderString()) |
|
| 83 | 83 | { |
| 84 | 84 | $locator->replaceWith($position, $replace); |
| 85 | 85 | } |
@@ -98,7 +98,7 @@ discard block |
||
| 98 | 98 | { |
| 99 | 99 | $eol = ConvertHelper::detectEOLCharacter($subject); |
| 100 | 100 | |
| 101 | - if($eol) |
|
| 101 | + if ($eol) |
|
| 102 | 102 | { |
| 103 | 103 | return $eol->getCharacter(); |
| 104 | 104 | } |
@@ -29,49 +29,49 @@ discard block |
||
| 29 | 29 | const ERROR_PLACEHOLDER_STRING_MISSING = 63501; |
| 30 | 30 | const ERROR_COULD_NOT_FIND_PLACEHOLDER_TEXT = 63502; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | 35 | private $replacementText; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var Mailcode_Parser_Safeguard_Placeholder_Locator |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var Mailcode_Parser_Safeguard_Placeholder_Locator |
|
| 39 | + */ |
|
| 40 | 40 | private $locator; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location |
|
| 44 | + */ |
|
| 45 | 45 | private $origin; |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @var string |
|
| 49 | - */ |
|
| 47 | + /** |
|
| 48 | + * @var string |
|
| 49 | + */ |
|
| 50 | 50 | private $placeholderText; |
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * @var integer |
|
| 54 | - */ |
|
| 52 | + /** |
|
| 53 | + * @var integer |
|
| 54 | + */ |
|
| 55 | 55 | private $offset = 0; |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * @var string |
|
| 59 | - */ |
|
| 57 | + /** |
|
| 58 | + * @var string |
|
| 59 | + */ |
|
| 60 | 60 | private $subject; |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * @var integer |
|
| 64 | - */ |
|
| 62 | + /** |
|
| 63 | + * @var integer |
|
| 64 | + */ |
|
| 65 | 65 | private $prefixLength = 0; |
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * @var integer |
|
| 69 | - */ |
|
| 67 | + /** |
|
| 68 | + * @var integer |
|
| 69 | + */ |
|
| 70 | 70 | private $placeholderLength = 0; |
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * @var integer |
|
| 74 | - */ |
|
| 72 | + /** |
|
| 73 | + * @var integer |
|
| 74 | + */ |
|
| 75 | 75 | private $lengthDifference = 0; |
| 76 | 76 | |
| 77 | 77 | public function __construct(Mailcode_Parser_Safeguard_Placeholder_Locator_Location $origin, string $replacementText, string $subject) |
@@ -91,11 +91,11 @@ discard block |
||
| 91 | 91 | return $this->subject; |
| 92 | 92 | } |
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * Adjusts the positions of all locations that come after |
|
| 96 | - * this one, to account for the added string length of the |
|
| 97 | - * placeholder that has been replaced. |
|
| 98 | - */ |
|
| 94 | + /** |
|
| 95 | + * Adjusts the positions of all locations that come after |
|
| 96 | + * this one, to account for the added string length of the |
|
| 97 | + * placeholder that has been replaced. |
|
| 98 | + */ |
|
| 99 | 99 | private function adjustPositions() : void |
| 100 | 100 | { |
| 101 | 101 | $locations = $this->origin->getNextAll(); |
@@ -101,7 +101,7 @@ discard block |
||
| 101 | 101 | $locations = $this->origin->getNextAll(); |
| 102 | 102 | $offset = $this->lengthDifference; |
| 103 | 103 | |
| 104 | - foreach($locations as $location) |
|
| 104 | + foreach ($locations as $location) |
|
| 105 | 105 | { |
| 106 | 106 | $location->updatePositionByOffset($offset); |
| 107 | 107 | |
@@ -113,7 +113,7 @@ discard block |
||
| 113 | 113 | { |
| 114 | 114 | $length = mb_strpos($this->replacementText, $this->placeholderText); |
| 115 | 115 | |
| 116 | - if($length === false) |
|
| 116 | + if ($length === false) |
|
| 117 | 117 | { |
| 118 | 118 | throw new Mailcode_Exception( |
| 119 | 119 | 'Replacement text does not contain placeholder string.', |
@@ -23,29 +23,29 @@ discard block |
||
| 23 | 23 | */ |
| 24 | 24 | class Mailcode_Parser_Safeguard_Placeholder_Locator_Location |
| 25 | 25 | { |
| 26 | - /** |
|
| 27 | - * @var Mailcode_Parser_Safeguard_Placeholder |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var Mailcode_Parser_Safeguard_Placeholder |
|
| 28 | + */ |
|
| 29 | 29 | private $placeholder; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var int |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var int |
|
| 33 | + */ |
|
| 34 | 34 | private $startPos; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var int |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var int |
|
| 38 | + */ |
|
| 39 | 39 | private $length; |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @var int |
|
| 43 | - */ |
|
| 41 | + /** |
|
| 42 | + * @var int |
|
| 43 | + */ |
|
| 44 | 44 | private $index; |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @var Mailcode_Parser_Safeguard_Placeholder_Locator |
|
| 48 | - */ |
|
| 46 | + /** |
|
| 47 | + * @var Mailcode_Parser_Safeguard_Placeholder_Locator |
|
| 48 | + */ |
|
| 49 | 49 | private $locator; |
| 50 | 50 | |
| 51 | 51 | public function __construct(Mailcode_Parser_Safeguard_Placeholder_Locator $locator, Mailcode_Parser_Safeguard_Placeholder $placeholder, int $index, int $startPos, int $length) |
@@ -112,31 +112,31 @@ discard block |
||
| 112 | 112 | return $this->getPrevious() !== null; |
| 113 | 113 | } |
| 114 | 114 | |
| 115 | - /** |
|
| 116 | - * Retrieves the placeholder location right after this one, if any. |
|
| 117 | - * |
|
| 118 | - * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location|NULL |
|
| 119 | - */ |
|
| 115 | + /** |
|
| 116 | + * Retrieves the placeholder location right after this one, if any. |
|
| 117 | + * |
|
| 118 | + * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location|NULL |
|
| 119 | + */ |
|
| 120 | 120 | public function getNext() : ?Mailcode_Parser_Safeguard_Placeholder_Locator_Location |
| 121 | 121 | { |
| 122 | 122 | return $this->locator->getLocationByIndex(($this->index-1)); |
| 123 | 123 | } |
| 124 | 124 | |
| 125 | - /** |
|
| 126 | - * Retrieves the placeholder location right before this one, if any. |
|
| 127 | - * |
|
| 128 | - * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location|NULL |
|
| 129 | - */ |
|
| 125 | + /** |
|
| 126 | + * Retrieves the placeholder location right before this one, if any. |
|
| 127 | + * |
|
| 128 | + * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location|NULL |
|
| 129 | + */ |
|
| 130 | 130 | public function getPrevious() : ?Mailcode_Parser_Safeguard_Placeholder_Locator_Location |
| 131 | 131 | { |
| 132 | 132 | return $this->locator->getLocationByIndex(($this->index+1)); |
| 133 | 133 | } |
| 134 | 134 | |
| 135 | - /** |
|
| 136 | - * Retrieves all placeholder locations that come after this one, if any. |
|
| 137 | - * |
|
| 138 | - * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location[] |
|
| 139 | - */ |
|
| 135 | + /** |
|
| 136 | + * Retrieves all placeholder locations that come after this one, if any. |
|
| 137 | + * |
|
| 138 | + * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location[] |
|
| 139 | + */ |
|
| 140 | 140 | public function getNextAll() : array |
| 141 | 141 | { |
| 142 | 142 | $locations = $this->locator->getLocations(); |
@@ -119,7 +119,7 @@ discard block |
||
| 119 | 119 | */ |
| 120 | 120 | public function getNext() : ?Mailcode_Parser_Safeguard_Placeholder_Locator_Location |
| 121 | 121 | { |
| 122 | - return $this->locator->getLocationByIndex(($this->index-1)); |
|
| 122 | + return $this->locator->getLocationByIndex(($this->index - 1)); |
|
| 123 | 123 | } |
| 124 | 124 | |
| 125 | 125 | /** |
@@ -129,7 +129,7 @@ discard block |
||
| 129 | 129 | */ |
| 130 | 130 | public function getPrevious() : ?Mailcode_Parser_Safeguard_Placeholder_Locator_Location |
| 131 | 131 | { |
| 132 | - return $this->locator->getLocationByIndex(($this->index+1)); |
|
| 132 | + return $this->locator->getLocationByIndex(($this->index + 1)); |
|
| 133 | 133 | } |
| 134 | 134 | |
| 135 | 135 | /** |
@@ -141,7 +141,7 @@ discard block |
||
| 141 | 141 | { |
| 142 | 142 | $locations = $this->locator->getLocations(); |
| 143 | 143 | |
| 144 | - return array_slice($locations, $this->index+1); |
|
| 144 | + return array_slice($locations, $this->index + 1); |
|
| 145 | 145 | } |
| 146 | 146 | |
| 147 | 147 | public function updatePositionByOffset(int $offset) : void |
@@ -29,19 +29,19 @@ discard block |
||
| 29 | 29 | */ |
| 30 | 30 | class Mailcode_Parser_Safeguard_Placeholder_Locator |
| 31 | 31 | { |
| 32 | - /** |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | 35 | private $subject; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var Mailcode_Parser_Safeguard_Placeholder |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var Mailcode_Parser_Safeguard_Placeholder |
|
| 39 | + */ |
|
| 40 | 40 | private $placeholder; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location[] |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location[] |
|
| 44 | + */ |
|
| 45 | 45 | private $instances = array(); |
| 46 | 46 | |
| 47 | 47 | public function __construct(Mailcode_Parser_Safeguard_Placeholder $placeholder, string $subject) |
@@ -52,11 +52,11 @@ discard block |
||
| 52 | 52 | $this->localizeInstances(); |
| 53 | 53 | } |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * Attempts to find the placeholder's instances in the |
|
| 57 | - * target string, and returns a location instance for |
|
| 58 | - * each, which allows accessing their exact position. |
|
| 59 | - */ |
|
| 55 | + /** |
|
| 56 | + * Attempts to find the placeholder's instances in the |
|
| 57 | + * target string, and returns a location instance for |
|
| 58 | + * each, which allows accessing their exact position. |
|
| 59 | + */ |
|
| 60 | 60 | private function localizeInstances() : void |
| 61 | 61 | { |
| 62 | 62 | $lastPos = 0; |
@@ -81,21 +81,21 @@ discard block |
||
| 81 | 81 | } |
| 82 | 82 | } |
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location[] |
|
| 86 | - */ |
|
| 84 | + /** |
|
| 85 | + * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location[] |
|
| 86 | + */ |
|
| 87 | 87 | public function getLocations() : array |
| 88 | 88 | { |
| 89 | 89 | return $this->instances; |
| 90 | 90 | } |
| 91 | 91 | |
| 92 | - /** |
|
| 93 | - * Retrieves a location by its index in the locations list (in |
|
| 94 | - * ascending order as found in the subject string, zero based.) |
|
| 95 | - * |
|
| 96 | - * @param int $index |
|
| 97 | - * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location|NULL |
|
| 98 | - */ |
|
| 92 | + /** |
|
| 93 | + * Retrieves a location by its index in the locations list (in |
|
| 94 | + * ascending order as found in the subject string, zero based.) |
|
| 95 | + * |
|
| 96 | + * @param int $index |
|
| 97 | + * @return Mailcode_Parser_Safeguard_Placeholder_Locator_Location|NULL |
|
| 98 | + */ |
|
| 99 | 99 | public function getLocationByIndex(int $index) : ?Mailcode_Parser_Safeguard_Placeholder_Locator_Location |
| 100 | 100 | { |
| 101 | 101 | if(isset($this->instances[$index])) |
@@ -106,19 +106,19 @@ discard block |
||
| 106 | 106 | return null; |
| 107 | 107 | } |
| 108 | 108 | |
| 109 | - /** |
|
| 110 | - * Replaces the placeholder at the location with the specified |
|
| 111 | - * replacement text. |
|
| 112 | - * |
|
| 113 | - * NOTE: The replacement text MUST contain the original placeholder |
|
| 114 | - * for this to work. An exception will be triggered otherwise. |
|
| 115 | - * |
|
| 116 | - * @param Mailcode_Parser_Safeguard_Placeholder_Locator_Location $location |
|
| 117 | - * @param string $replacementText |
|
| 118 | - * @throws Mailcode_Exception |
|
| 119 | - * |
|
| 120 | - * @see Mailcode_Parser_Safeguard_Placeholder_Locator_Replacer::ERROR_PLACEHOLDER_STRING_MISSING |
|
| 121 | - */ |
|
| 109 | + /** |
|
| 110 | + * Replaces the placeholder at the location with the specified |
|
| 111 | + * replacement text. |
|
| 112 | + * |
|
| 113 | + * NOTE: The replacement text MUST contain the original placeholder |
|
| 114 | + * for this to work. An exception will be triggered otherwise. |
|
| 115 | + * |
|
| 116 | + * @param Mailcode_Parser_Safeguard_Placeholder_Locator_Location $location |
|
| 117 | + * @param string $replacementText |
|
| 118 | + * @throws Mailcode_Exception |
|
| 119 | + * |
|
| 120 | + * @see Mailcode_Parser_Safeguard_Placeholder_Locator_Replacer::ERROR_PLACEHOLDER_STRING_MISSING |
|
| 121 | + */ |
|
| 122 | 122 | public function replaceWith(Mailcode_Parser_Safeguard_Placeholder_Locator_Location $location, string $replacementText) : void |
| 123 | 123 | { |
| 124 | 124 | $replacer = new Mailcode_Parser_Safeguard_Placeholder_Locator_Replacer( |
@@ -130,11 +130,11 @@ discard block |
||
| 130 | 130 | $this->subject = $replacer->replace(); |
| 131 | 131 | } |
| 132 | 132 | |
| 133 | - /** |
|
| 134 | - * Retrieves the subject string, with all changes that were made, if any. |
|
| 135 | - * |
|
| 136 | - * @return string |
|
| 137 | - */ |
|
| 133 | + /** |
|
| 134 | + * Retrieves the subject string, with all changes that were made, if any. |
|
| 135 | + * |
|
| 136 | + * @return string |
|
| 137 | + */ |
|
| 138 | 138 | public function getSubjectString() : string |
| 139 | 139 | { |
| 140 | 140 | return $this->subject; |
@@ -63,7 +63,7 @@ discard block |
||
| 63 | 63 | $needle = $this->placeholder->getReplacementText(); |
| 64 | 64 | $index = 0; |
| 65 | 65 | |
| 66 | - while(($lastPos = mb_strpos($this->subject, $needle, $lastPos)) !== false) |
|
| 66 | + while (($lastPos = mb_strpos($this->subject, $needle, $lastPos)) !== false) |
|
| 67 | 67 | { |
| 68 | 68 | $length = mb_strlen($needle); |
| 69 | 69 | |
@@ -98,7 +98,7 @@ discard block |
||
| 98 | 98 | */ |
| 99 | 99 | public function getLocationByIndex(int $index) : ?Mailcode_Parser_Safeguard_Placeholder_Locator_Location |
| 100 | 100 | { |
| 101 | - if(isset($this->instances[$index])) |
|
| 101 | + if (isset($this->instances[$index])) |
|
| 102 | 102 | { |
| 103 | 103 | return $this->instances[$index]; |
| 104 | 104 | } |
@@ -22,14 +22,14 @@ discard block |
||
| 22 | 22 | */ |
| 23 | 23 | abstract class Mailcode_Parser_Safeguard_FormatterLocation |
| 24 | 24 | { |
| 25 | - /** |
|
| 26 | - * @var Mailcode_Parser_Safeguard_Formatter |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var Mailcode_Parser_Safeguard_Formatter |
|
| 27 | + */ |
|
| 28 | 28 | protected $formatter; |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location |
|
| 32 | - */ |
|
| 30 | + /** |
|
| 31 | + * @var Mailcode_Parser_Safeguard_Placeholder_Locator_Location |
|
| 32 | + */ |
|
| 33 | 33 | protected $location; |
| 34 | 34 | |
| 35 | 35 | public function __construct(Mailcode_Parser_Safeguard_Formatter $formatter, Mailcode_Parser_Safeguard_Placeholder_Locator_Location $location) |
@@ -42,22 +42,22 @@ discard block |
||
| 42 | 42 | |
| 43 | 43 | abstract protected function init() : void; |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * Whether this specific placeholder location needs to be adjusted. |
|
| 47 | - * |
|
| 48 | - * @return bool |
|
| 49 | - */ |
|
| 45 | + /** |
|
| 46 | + * Whether this specific placeholder location needs to be adjusted. |
|
| 47 | + * |
|
| 48 | + * @return bool |
|
| 49 | + */ |
|
| 50 | 50 | abstract public function requiresAdjustment() : bool; |
| 51 | 51 | |
| 52 | 52 | abstract protected function getAdjustedText() : string; |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Retrieves the placeholder text, adjusted as needed by the |
|
| 56 | - * formatter. If no adjustments are required, this will simply |
|
| 57 | - * return the vanilla placeholder string. |
|
| 58 | - * |
|
| 59 | - * @return string |
|
| 60 | - */ |
|
| 54 | + /** |
|
| 55 | + * Retrieves the placeholder text, adjusted as needed by the |
|
| 56 | + * formatter. If no adjustments are required, this will simply |
|
| 57 | + * return the vanilla placeholder string. |
|
| 58 | + * |
|
| 59 | + * @return string |
|
| 60 | + */ |
|
| 61 | 61 | public function getPlaceholderText() : string |
| 62 | 62 | { |
| 63 | 63 | if($this->requiresAdjustment()) |
@@ -60,7 +60,7 @@ |
||
| 60 | 60 | */ |
| 61 | 61 | public function getPlaceholderText() : string |
| 62 | 62 | { |
| 63 | - if($this->requiresAdjustment()) |
|
| 63 | + if ($this->requiresAdjustment()) |
|
| 64 | 64 | { |
| 65 | 65 | $text = $this->getAdjustedText(); |
| 66 | 66 | |