Mailcode_Parser_Safeguard::getPlaceholderStrings() - Code Metrics - Inspection of "Added testsuite for the collection class." - Mistralys/mailcode - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 75ee28...758f58 )

by Sebastian

created 2020-11-13 09:52 UTC

Mailcode_Parser_Safeguard::getPlaceholderStrings() A

↳ Parent: Mailcode_Parser_Safeguard

Complexity

Conditions	3
Paths	3

Size

Total Lines	17
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	3
eloc	7
c	1
b	0
f	1
nc	3
nop	0
dl	0
loc	17
rs	10

<?php
/**
 * File containing the {@see Mailcode_Parser_Safeguard} class.
 *
 * @package Mailcode
 * @subpackage Parser
 * @see Mailcode_Parser_Safeguard
 */

declare(strict_types=1);

namespace Mailcode;

use AppUtils\ConvertHelper;

/**
 * Command safeguarder: used to replace the mailcode commands
 * in a string with placeholders, to allow safe text transformation
 * and filtering operations on strings, without risking to break 
 * any of the contained commands (if any).
 * 
 * Usage:
 * 
 * <pre>
 * $safeguard = Mailcode::create()->createSafeguard($sourceString);
 * 
 * // replace all commands with placeholders
 * $workString = $safeguard->makeSafe();
 * 
 * // dome something with the work string - filtering, parsing...
 * 
 * // restore all command placeholders
 * $resultString = $safeguard->makeWhole($workString);
 * </pre>
 * 
 * Note that by default, the placeholders are delimited with
 * two underscores, e.g. <code>__PCH0001__</code>. If the text
 * transformations include replacing or modifying underscores,
 * you should use a different delimiter:
 * 
 * <pre>
 * $safeguard = Mailcode::create()->createSafeguard($sourceString);
 * 
 * // change the delimiter to %%. Can be any arbitrary string.
 * $safeguard->setDelimiter('%%');
 * </pre>
 *
 * @package Mailcode
 * @subpackage Parser
 * @author Sebastian Mordziol <[email protected]>
 */
class Mailcode_Parser_Safeguard
{
    const ERROR_INVALID_COMMANDS = 47801;
    const ERROR_EMPTY_DELIMITER = 47803;
    const ERROR_PLACEHOLDER_NOT_FOUND = 47804;
    
   /**
    * @var Mailcode_Parser
    */
    protected $parser;
    
   /**
    * @var Mailcode_Collection
    */
    protected $commands;
    
   /**
    * @var string
    */
    protected $originalString;
    
   /**
    * @var Mailcode_Collection
    */
    protected $collection;
    
   /**
    * Counter for the placeholders, global for all placeholders.
    * @var integer
    */
    private static $counter = 0;
    
   /**
    * @var Mailcode_Parser_Safeguard_Placeholder[]
    */
    protected $placeholders;
    
   /**
    * @var string
    */
    protected $delimiter = '__';
    
   /**
    * @var string[]|NULL
    */
    protected $placeholderStrings;
    
   /**
    * @var Mailcode_Parser_Safeguard_Formatting|NULL
    */
    private $formatting = null;

    
    public function __construct(Mailcode_Parser $parser, string $subject)
    {
        $this->parser = $parser;
        $this->originalString = $subject;
    }
    
   /**
    * Retrieves the string the safeguard was created for.
    * 
    * @return string
    */
    public function getOriginalString() : string
    {
        return $this->originalString;
    }
    
   /**
    * Sets the delimiter character sequence used to prepend
    * and append to the placeholders.
    * 
    * The delimiter's default is "__" (two underscores).
    * 
    * @param string $delimiter
    * @return Mailcode_Parser_Safeguard
    */
    public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
    {
        if(empty($delimiter))
        {
            throw new Mailcode_Exception(
                'Empty delimiter',
                'Delimiters may not be empty.',
                self::ERROR_EMPTY_DELIMITER
            );
        }
        
        $this->delimiter = $delimiter;
        
        return $this;
    }
    
    public function getDelimiter() : string
    {
        return $this->delimiter;
    }
    
   /**
    * Retrieves the safe string in which all commands have been replaced
    * by placeholder strings.
    *
    * @return string
    * @throws Mailcode_Exception 
    *
    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
    */
    public function makeSafe() : string
    {
        $this->requireValidCollection();
        
        return $this->makeSafePartial();
    }
    
   /**
    * Like makeSafe(), but allows partial (invalid) commands: use this
    * if the subject string may contain only part of the whole set of
    * commands. 
    * 
    * Example: parsing a text with an opening if statement, without the 
    * matching end statement.
    * 
    * @return string
    */
    public function makeSafePartial() : string
    {
        $placeholders = $this->getPlaceholders();
        $string = $this->originalString;
        
        foreach($placeholders as $placeholder)
        {
            $string = $this->makePlaceholderSafe($string, $placeholder);
        }

        $this->analyzeURLs($string);

        return $string;
    }

    private function makePlaceholderSafe(string $string, Mailcode_Parser_Safeguard_Placeholder $placeholder) : string
    {
        $pos = mb_strpos($string, $placeholder->getOriginalText());

        if($pos === false)
        {
            throw new Mailcode_Exception(
                'Placeholder original text not found',
                sprintf(
                    'Tried finding the command string [%s], but it has disappeared.',
                    $placeholder->getOriginalText()
                ),
                self::ERROR_PLACEHOLDER_NOT_FOUND
            );
        }

        $before = mb_substr($string, 0, $pos);
        $after = mb_substr($string, $pos + mb_strlen($placeholder->getOriginalText()));

        return $before.$placeholder->getReplacementText().$after;
    }

    /**
     * Detects all URLs in the subject string, and tells all placeholders
     * that are contained in URLs, that they are in an URL.
     *
     * @param string $string
     */
    private function analyzeURLs(string $string) : void
    {
        $urls = ConvertHelper::createURLFinder($string)->getURLs();
        $placeholders = $this->getPlaceholders();

        foreach($urls as $url)
        {
            foreach($placeholders as $placeholder)
            {
                $command = $placeholder->getCommand();

                if(!$command->supportsURLEncoding())
                {
                    continue;
                }

                if(strstr($url, $placeholder->getReplacementText()))
                {
                    $command->setURLEncoding(true);
                }
            }
        }
    }
    
   /**
    * Creates a formatting handler, which can be used to specify
    * which formattings to use for the commands in the subject string.
    * 
    * @param Mailcode_StringContainer|string $subject
    * @return Mailcode_Parser_Safeguard_Formatting
    */
    public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting
    {
        if(is_string($subject))
        {
            $subject = Mailcode::create()->createString($subject);
        }
        
        return new Mailcode_Parser_Safeguard_Formatting($this, $subject);
    }
    
   /**
    * Retrieves all placeholders that have to be added to
    * the subject text.
    * 
    * @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
    */
    public function getPlaceholders()
    {
        if(isset($this->placeholders))
        {
            return $this->placeholders;
        }
        
        $this->placeholders = array();
        
        $cmds = $this->getCollection()->getCommands();
        
        foreach($cmds as $command)
        {
            self::$counter++;
            
            $this->placeholders[] = new Mailcode_Parser_Safeguard_Placeholder(
                self::$counter,
                $command,
                $this
            );
        }

        return $this->placeholders;
    }
    
    protected function restore(string $string, bool $partial=false, bool $highlighted=false) : string
    {
        if(!$partial)
        {
            $this->requireValidCollection();
        }
        
        $formatting = $this->createFormatting($string);

        if($partial)
        {
            $formatting->makePartial();
        }
        
        if($highlighted)
        {
            $formatting->replaceWithHTMLHighlighting();
        }
        else 
        {
            $formatting->replaceWithNormalized();
        }
        
        return $formatting->toString();
    }
    
   /**
    * Makes the string whole again after transforming or filtering it,
    * by replacing the command placeholders with the original commands.
    *
    * @param string $string
    * @return string
    * @throws Mailcode_Exception
    *
    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
    */
    public function makeWhole(string $string) : string
    {
        return $this->restore(
            $string, 
            false, // partial? 
            false // highlight?
        );
    }
    
   /**
    * Like `makeWhole()`, but ignores missing command placeholders.
    *
    * @param string $string
    * @return string
    * @throws Mailcode_Exception
    *
    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
    */
    public function makeWholePartial(string $string) : string
    {
        return $this->restore(
            $string,
            true, // partial?
            false // highlight?
        );
    }

   /**
    * Like `makeWhole()`, but replaces the commands with a syntax
    * highlighted version, meant for human readable texts only.
    * 
    * Note: the commands lose their functionality (They cannot be 
    * parsed from that string again).
    *
    * @param string $string
    * @return string
    * @throws Mailcode_Exception
    *
    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
    */
    public function makeHighlighted(string $string) : string
    {
        return $this->restore(
            $string, 
            false, // partial? 
            true // highlighted?
        );
    }
    
   /**
    * Like `makeHighlighted()`, but ignores missing command placeholders.
    * 
    * @param string $string
    * @return string
    * @throws Mailcode_Exception
    *
    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
    */
    public function makeHighlightedPartial(string $string) : string
    {
        return $this->restore(
            $string, 
            true, // partial? 
            true // highlight?
        );
    }
    
   /**
    * Retrieves the commands collection contained in the string.
    * 
    * @return Mailcode_Collection
    */
    public function getCollection() : Mailcode_Collection
    {
        if(isset($this->collection))
        {
            return $this->collection;
        }
        
        $this->collection = $this->parser->parseString($this->originalString);
        
        return $this->collection;
    }
    
    public function isValid() : bool
    {
        return $this->getCollection()->isValid();
    }
    
   /**
    * @throws Mailcode_Exception
    * 
    * @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
    */
    protected function requireValidCollection() : void
    {
        if($this->getCollection()->isValid())
        {
            return;
        }
        
        throw new Mailcode_Exception(
            'Cannot safeguard invalid commands',
            sprintf(
                'The collection contains invalid commands. Safeguarding is only allowed with valid commands.'.
                'Source string: [%s]',
                $this->originalString
            ),
            self::ERROR_INVALID_COMMANDS
        );
    }
    
   /**
    * Retrieves a list of all placeholder IDs used in the text.
    * 
    * @return string[]
    */
    public function getPlaceholderStrings() : array
    {
        if(is_array($this->placeholderStrings))
        {
            return $this->placeholderStrings;
        }
        
        $placeholders = $this->getPlaceholders();
        
        $this->placeholderStrings = array();
        
        foreach($placeholders as $placeholder)
        {
            $this->placeholderStrings[] = $placeholder->getReplacementText();
        }
        
        return $this->placeholderStrings;
    }
    
    public function isPlaceholder(string $subject) : bool
    {
        $ids = $this->getPlaceholderStrings();
        
        return in_array($subject, $ids);
    }
    
   /**
    * Retrieves a placeholder instance by its ID.
    * 
    * @param int $id
    * @throws Mailcode_Exception If the placeholder was not found.
    * @return Mailcode_Parser_Safeguard_Placeholder
    */
    public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder
    {
        $placeholders = $this->getPlaceholders();
        
        foreach($placeholders as $placeholder)
        {
            if($placeholder->getID() === $id)
            {
                return $placeholder;
            }
        }
        
        throw new Mailcode_Exception(
            'No such safeguard placeholder.',
            sprintf(
                'The placeholder ID [%s] is not present in the safeguard instance.',
                $id
            ),
            self::ERROR_PLACEHOLDER_NOT_FOUND
        );
    }
    
   /**
    * Retrieves a placeholder instance by its replacement text.
    * 
    * @param string $string
    * @throws Mailcode_Exception
    * @return Mailcode_Parser_Safeguard_Placeholder
    */
    public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder
    {
        $placeholders = $this->getPlaceholders();
        
        foreach($placeholders as $placeholder)
        {
            if($placeholder->getReplacementText() === $string)
            {
                return $placeholder;
            }
        }
        
        throw new Mailcode_Exception(
            'No such safeguard placeholder.',
            sprintf(
                'The placeholder replacement string [%s] is not present in the safeguard instance.',
                $string
            ),
            self::ERROR_PLACEHOLDER_NOT_FOUND
        );
    }
    
    public function hasPlaceholders() : bool
    {
        $placeholders = $this->getPlaceholders();
        
        return !empty($placeholders);
    }
}


1			<?php
2			/**
3			* File containing the {@see Mailcode_Parser_Safeguard} class.
4			*
5			* @package Mailcode
6			* @subpackage Parser
7			* @see Mailcode_Parser_Safeguard
8			*/
9
10			declare(strict_types=1);
11
12			namespace Mailcode;
13
14			use AppUtils\ConvertHelper;
15
16			/**
17			* Command safeguarder: used to replace the mailcode commands
18			* in a string with placeholders, to allow safe text transformation
19			* and filtering operations on strings, without risking to break
20			* any of the contained commands (if any).
21			*
22			* Usage:
23			*
24			* <pre>
25			* $safeguard = Mailcode::create()->createSafeguard($sourceString);
26			*
27			* // replace all commands with placeholders
28			* $workString = $safeguard->makeSafe();
29			*
30			* // dome something with the work string - filtering, parsing...
31			*
32			* // restore all command placeholders
33			* $resultString = $safeguard->makeWhole($workString);
34			* </pre>
35			*
36			* Note that by default, the placeholders are delimited with
37			* two underscores, e.g. <code>__PCH0001__</code>. If the text
38			* transformations include replacing or modifying underscores,
39			* you should use a different delimiter:
40			*
41			* <pre>
42			* $safeguard = Mailcode::create()->createSafeguard($sourceString);
43			*
44			* // change the delimiter to %%. Can be any arbitrary string.
45			* $safeguard->setDelimiter('%%');
46			* </pre>
47			*
48			* @package Mailcode
49			* @subpackage Parser
50			* @author Sebastian Mordziol <[email protected]>
51			*/
52			class Mailcode_Parser_Safeguard
53			{
54			const ERROR_INVALID_COMMANDS = 47801;
55			const ERROR_EMPTY_DELIMITER = 47803;
56			const ERROR_PLACEHOLDER_NOT_FOUND = 47804;
57
58			/**
59			* @var Mailcode_Parser
60			*/
61			protected $parser;
62
63			/**
64			* @var Mailcode_Collection
65			*/
66			protected $commands;
67
68			/**
69			* @var string
70			*/
71			protected $originalString;
72
73			/**
74			* @var Mailcode_Collection
75			*/
76			protected $collection;
77
78			/**
79			* Counter for the placeholders, global for all placeholders.
80			* @var integer
81			*/
82			private static $counter = 0;
83
84			/**
85			* @var Mailcode_Parser_Safeguard_Placeholder[]
86			*/
87			protected $placeholders;
88
89			/**
90			* @var string
91			*/
92			protected $delimiter = '__';
93
94			/**
95			* @var string[]\|NULL
96			*/
97			protected $placeholderStrings;
98
99			/**
100			* @var Mailcode_Parser_Safeguard_Formatting\|NULL
101			*/
102			private $formatting = null;
			0 ignored issues – show introduced 2020-09-02 07:00 UTC by Report Bug Copy Issue Report The private property `$formatting` is not used, and could be removed. Loading history...
103
104			public function __construct(Mailcode_Parser $parser, string $subject)
105			{
106			$this->parser = $parser;
107			$this->originalString = $subject;
108			}
109
110			/**
111			* Retrieves the string the safeguard was created for.
112			*
113			* @return string
114			*/
115			public function getOriginalString() : string
116			{
117			return $this->originalString;
118			}
119
120			/**
121			* Sets the delimiter character sequence used to prepend
122			* and append to the placeholders.
123			*
124			* The delimiter's default is "__" (two underscores).
125			*
126			* @param string $delimiter
127			* @return Mailcode_Parser_Safeguard
128			*/
129			public function setDelimiter(string $delimiter) : Mailcode_Parser_Safeguard
130			{
131			if(empty($delimiter))
132			{
133			throw new Mailcode_Exception(
134			'Empty delimiter',
135			'Delimiters may not be empty.',
136			self::ERROR_EMPTY_DELIMITER
137			);
138			}
139
140			$this->delimiter = $delimiter;
141
142			return $this;
143			}
144
145			public function getDelimiter() : string
146			{
147			return $this->delimiter;
148			}
149
150			/**
151			* Retrieves the safe string in which all commands have been replaced
152			* by placeholder strings.
153			*
154			* @return string
155			* @throws Mailcode_Exception
156			*
157			* @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
158			*/
159			public function makeSafe() : string
160			{
161			$this->requireValidCollection();
162
163			return $this->makeSafePartial();
164			}
165
166			/**
167			* Like makeSafe(), but allows partial (invalid) commands: use this
168			* if the subject string may contain only part of the whole set of
169			* commands.
170			*
171			* Example: parsing a text with an opening if statement, without the
172			* matching end statement.
173			*
174			* @return string
175			*/
176			public function makeSafePartial() : string
177			{
178			$placeholders = $this->getPlaceholders();
179			$string = $this->originalString;
180
181			foreach($placeholders as $placeholder)
182			{
183			$string = $this->makePlaceholderSafe($string, $placeholder);
184			}
185
186			$this->analyzeURLs($string);
187
188			return $string;
189			}
190
191			private function makePlaceholderSafe(string $string, Mailcode_Parser_Safeguard_Placeholder $placeholder) : string
192			{
193			$pos = mb_strpos($string, $placeholder->getOriginalText());
194
195			if($pos === false)
196			{
197			throw new Mailcode_Exception(
198			'Placeholder original text not found',
199			sprintf(
200			'Tried finding the command string [%s], but it has disappeared.',
201			$placeholder->getOriginalText()
202			),
203			self::ERROR_PLACEHOLDER_NOT_FOUND
204			);
205			}
206
207			$before = mb_substr($string, 0, $pos);
208			$after = mb_substr($string, $pos + mb_strlen($placeholder->getOriginalText()));
209
210			return $before.$placeholder->getReplacementText().$after;
211			}
212
213			/**
214			* Detects all URLs in the subject string, and tells all placeholders
215			* that are contained in URLs, that they are in an URL.
216			*
217			* @param string $string
218			*/
219			private function analyzeURLs(string $string) : void
220			{
221			$urls = ConvertHelper::createURLFinder($string)->getURLs();
222			$placeholders = $this->getPlaceholders();
223
224			foreach($urls as $url)
225			{
226			foreach($placeholders as $placeholder)
227			{
228			$command = $placeholder->getCommand();
229
230			if(!$command->supportsURLEncoding())
231			{
232			continue;
233			}
234
235			if(strstr($url, $placeholder->getReplacementText()))
236			{
237			$command->setURLEncoding(true);
238			}
239			}
240			}
241			}
242
243			/**
244			* Creates a formatting handler, which can be used to specify
245			* which formattings to use for the commands in the subject string.
246			*
247			* @param Mailcode_StringContainer\|string $subject
248			* @return Mailcode_Parser_Safeguard_Formatting
249			*/
250			public function createFormatting($subject) : Mailcode_Parser_Safeguard_Formatting
251			{
252			if(is_string($subject))
253			{
254			$subject = Mailcode::create()->createString($subject);
255			}
256
257			return new Mailcode_Parser_Safeguard_Formatting($this, $subject);
258			}
259
260			/**
261			* Retrieves all placeholders that have to be added to
262			* the subject text.
263			*
264			* @return \Mailcode\Mailcode_Parser_Safeguard_Placeholder[]
265			*/
266			public function getPlaceholders()
267			{
268			if(isset($this->placeholders))
269			{
270			return $this->placeholders;
271			}
272
273			$this->placeholders = array();
274
275			$cmds = $this->getCollection()->getCommands();
276
277			foreach($cmds as $command)
278			{
279			self::$counter++;
280
281			$this->placeholders[] = new Mailcode_Parser_Safeguard_Placeholder(
282			self::$counter,
283			$command,
284			$this
285			);
286			}
287
288			return $this->placeholders;
289			}
290
291			protected function restore(string $string, bool $partial=false, bool $highlighted=false) : string
292			{
293			if(!$partial)
294			{
295			$this->requireValidCollection();
296			}
297
298			$formatting = $this->createFormatting($string);
299
300			if($partial)
301			{
302			$formatting->makePartial();
303			}
304
305			if($highlighted)
306			{
307			$formatting->replaceWithHTMLHighlighting();
308			}
309			else
310			{
311			$formatting->replaceWithNormalized();
312			}
313
314			return $formatting->toString();
315			}
316
317			/**
318			* Makes the string whole again after transforming or filtering it,
319			* by replacing the command placeholders with the original commands.
320			*
321			* @param string $string
322			* @return string
323			* @throws Mailcode_Exception
324			*
325			* @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
326			*/
327			public function makeWhole(string $string) : string
328			{
329			return $this->restore(
330			$string,
331			false, // partial?
332			false // highlight?
333			);
334			}
335
336			/**
337			* Like `makeWhole()`, but ignores missing command placeholders.
338			*
339			* @param string $string
340			* @return string
341			* @throws Mailcode_Exception
342			*
343			* @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
344			*/
345			public function makeWholePartial(string $string) : string
346			{
347			return $this->restore(
348			$string,
349			true, // partial?
350			false // highlight?
351			);
352			}
353
354			/**
355			* Like `makeWhole()`, but replaces the commands with a syntax
356			* highlighted version, meant for human readable texts only.
357			*
358			* Note: the commands lose their functionality (They cannot be
359			* parsed from that string again).
360			*
361			* @param string $string
362			* @return string
363			* @throws Mailcode_Exception
364			*
365			* @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
366			*/
367			public function makeHighlighted(string $string) : string
368			{
369			return $this->restore(
370			$string,
371			false, // partial?
372			true // highlighted?
373			);
374			}
375
376			/**
377			* Like `makeHighlighted()`, but ignores missing command placeholders.
378			*
379			* @param string $string
380			* @return string
381			* @throws Mailcode_Exception
382			*
383			* @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
384			*/
385			public function makeHighlightedPartial(string $string) : string
386			{
387			return $this->restore(
388			$string,
389			true, // partial?
390			true // highlight?
391			);
392			}
393
394			/**
395			* Retrieves the commands collection contained in the string.
396			*
397			* @return Mailcode_Collection
398			*/
399			public function getCollection() : Mailcode_Collection
400			{
401			if(isset($this->collection))
402			{
403			return $this->collection;
404			}
405
406			$this->collection = $this->parser->parseString($this->originalString);
407
408			return $this->collection;
409			}
410
411			public function isValid() : bool
412			{
413			return $this->getCollection()->isValid();
414			}
415
416			/**
417			* @throws Mailcode_Exception
418			*
419			* @see Mailcode_Parser_Safeguard::ERROR_INVALID_COMMANDS
420			*/
421			protected function requireValidCollection() : void
422			{
423			if($this->getCollection()->isValid())
424			{
425			return;
426			}
427
428			throw new Mailcode_Exception(
429			'Cannot safeguard invalid commands',
430			sprintf(
431			'The collection contains invalid commands. Safeguarding is only allowed with valid commands.'.
432			'Source string: [%s]',
433			$this->originalString
434			),
435			self::ERROR_INVALID_COMMANDS
436			);
437			}
438
439			/**
440			* Retrieves a list of all placeholder IDs used in the text.
441			*
442			* @return string[]
443			*/
444			public function getPlaceholderStrings() : array
445			{
446			if(is_array($this->placeholderStrings))
447			{
448			return $this->placeholderStrings;
449			}
450
451			$placeholders = $this->getPlaceholders();
452
453			$this->placeholderStrings = array();
454
455			foreach($placeholders as $placeholder)
456			{
457			$this->placeholderStrings[] = $placeholder->getReplacementText();
458			}
459
460			return $this->placeholderStrings;
461			}
462
463			public function isPlaceholder(string $subject) : bool
464			{
465			$ids = $this->getPlaceholderStrings();
466
467			return in_array($subject, $ids);
468			}
469
470			/**
471			* Retrieves a placeholder instance by its ID.
472			*
473			* @param int $id
474			* @throws Mailcode_Exception If the placeholder was not found.
475			* @return Mailcode_Parser_Safeguard_Placeholder
476			*/
477			public function getPlaceholderByID(int $id) : Mailcode_Parser_Safeguard_Placeholder
478			{
479			$placeholders = $this->getPlaceholders();
480
481			foreach($placeholders as $placeholder)
482			{
483			if($placeholder->getID() === $id)
484			{
485			return $placeholder;
486			}
487			}
488
489			throw new Mailcode_Exception(
490			'No such safeguard placeholder.',
491			sprintf(
492			'The placeholder ID [%s] is not present in the safeguard instance.',
493			$id
494			),
495			self::ERROR_PLACEHOLDER_NOT_FOUND
496			);
497			}
498
499			/**
500			* Retrieves a placeholder instance by its replacement text.
501			*
502			* @param string $string
503			* @throws Mailcode_Exception
504			* @return Mailcode_Parser_Safeguard_Placeholder
505			*/
506			public function getPlaceholderByString(string $string) : Mailcode_Parser_Safeguard_Placeholder
507			{
508			$placeholders = $this->getPlaceholders();
509
510			foreach($placeholders as $placeholder)
511			{
512			if($placeholder->getReplacementText() === $string)
513			{
514			return $placeholder;
515			}
516			}
517
518			throw new Mailcode_Exception(
519			'No such safeguard placeholder.',
520			sprintf(
521			'The placeholder replacement string [%s] is not present in the safeguard instance.',
522			$string
523			),
524			self::ERROR_PLACEHOLDER_NOT_FOUND
525			);
526			}
527
528			public function hasPlaceholders() : bool
529			{
530			$placeholders = $this->getPlaceholders();
531
532			return !empty($placeholders);
533			}
534			}
535

Mistralys / mailcode

Push — master ( 75ee28...758f58 )

Mailcode_Parser_Safeguard::getPlaceholderStrings() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like