StringFormatter::format() - Code Metrics - Smoren/string-formatter-php - Measure and Improve Code Quality continuously with Scrutinizer

StringFormatter::format() A
last analyzed 2023-06-15 19:35 UTC

↳ Parent: StringFormatter

Complexity

Conditions	5
Paths	6

Size

Total Lines	31
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
cc	5
eloc	17
c	2
b	1
f	0
nc	6
nop	5
dl	0
loc	31
rs	9.3888

<?php

namespace Smoren\StringFormatter;

use Smoren\Schemator\Components\NestedAccessor;
use Smoren\Schemator\Exceptions\PathNotExistException;

/**
 * StringFormatter class
 */
class StringFormatter
{
    public const DEFAULT_REGEXP = '/\{([A-Za-z0-9\-_\.]+)\}/';
    public const DEFAULT_PATH_DELIMITER = '.';

    /**
     * Formats string with given params
     * @param string $input input string
     * @param array<string, mixed> $params params map
     * @param bool $silent if true don't throw exception with catching errors
     * @param non-empty-string $regexp regular expression for masked params

     * @param non-empty-string $pathDelimiter path delimiter for nested param paths
     * @return string result string with replaced params masks
     * @throws StringFormatterException if not silent and some errors catched
     */
    public static function format(
        string $input,
        array $params,
        bool $silent = false,
        string $regexp = self::DEFAULT_REGEXP,
        string $pathDelimiter = self::DEFAULT_PATH_DELIMITER
    ): string {
        $accessor = new NestedAccessor($params, $pathDelimiter);
        $keyMap = static::findKeys($input, $regexp);

        $notFoundKeys = [];
        foreach($keyMap as $key => &$path) {
            try {
                $path = $accessor->get($path);
            } catch(PathNotExistException $e) {
                $notFoundKeys[] = $path;
                unset($keyMap[$key]);
            }
        }
        unset($path);

        if(!$silent && count($notFoundKeys)) {
            throw new StringFormatterException(
                'some keys not found in params array',
                StringFormatterException::ERROR_KEYS_NOT_FOUND,
                null,
                array_values($notFoundKeys)
            );
        }

        return str_replace(array_keys($keyMap), array_values($keyMap), $input);
    }

    /**
     * Formats string with given params in silent mode
     * @param string $input input string
     * @param array<string, mixed> $params params map
     * @param non-empty-string $regexp regular expression for masked params

     * @param non-empty-string $pathDelimiter path delimiter for nested param paths
     * @return string result string with replaced params masks
     */
    public static function formatSilent(
        string $input,
        array $params,
        string $regexp = self::DEFAULT_REGEXP,
        string $pathDelimiter = self::DEFAULT_PATH_DELIMITER
    ): string {
        return static::format($input, $params, true, $regexp, $pathDelimiter);
    }

    /**
     * Returns map of found keys to replace with params map
     * @param string $input input string
     * @param string $regexp regular expression for masked params
     * @return string[]
     */
    protected static function findKeys(string $input, string $regexp): array
    {
        preg_match_all($regexp, $input, $matches);
        $result = array_combine($matches[0] ?? [], $matches[1] ?? []);
        if(!$result) {

            return [];
        }
        return $result;
    }
}


1			<?php
2
3			namespace Smoren\StringFormatter;
4
5			use Smoren\Schemator\Components\NestedAccessor;
6			use Smoren\Schemator\Exceptions\PathNotExistException;
7
8			/**
9			* StringFormatter class
10			*/
11			class StringFormatter
12			{
13			public const DEFAULT_REGEXP = '/\{([A-Za-z0-9\-_\.]+)\}/';
14			public const DEFAULT_PATH_DELIMITER = '.';
15
16			/**
17			* Formats string with given params
18			* @param string $input input string
19			* @param array<string, mixed> $params params map
20			* @param bool $silent if true don't throw exception with catching errors
21			* @param non-empty-string $regexp regular expression for masked params
			0 ignored issues – show Documentation Bug introduced 2022-11-27 13:33 UTC by Report Bug Copy Issue Report The doc comment `non-empty-string` at position `0` could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string. Loading history...
22			* @param non-empty-string $pathDelimiter path delimiter for nested param paths
23			* @return string result string with replaced params masks
24			* @throws StringFormatterException if not silent and some errors catched
25			*/
26			public static function format(
27			string $input,
28			array $params,
29			bool $silent = false,
30			string $regexp = self::DEFAULT_REGEXP,
31			string $pathDelimiter = self::DEFAULT_PATH_DELIMITER
32			): string {
33			$accessor = new NestedAccessor($params, $pathDelimiter);
34			$keyMap = static::findKeys($input, $regexp);
35
36			$notFoundKeys = [];
37			foreach($keyMap as $key => &$path) {
38			try {
39			$path = $accessor->get($path);
40			} catch(PathNotExistException $e) {
41			$notFoundKeys[] = $path;
42			unset($keyMap[$key]);
43			}
44			}
45			unset($path);
46
47			if(!$silent && count($notFoundKeys)) {
48			throw new StringFormatterException(
49			'some keys not found in params array',
50			StringFormatterException::ERROR_KEYS_NOT_FOUND,
51			null,
52			array_values($notFoundKeys)
53			);
54			}
55
56			return str_replace(array_keys($keyMap), array_values($keyMap), $input);
57			}
58
59			/**
60			* Formats string with given params in silent mode
61			* @param string $input input string
62			* @param array<string, mixed> $params params map
63			* @param non-empty-string $regexp regular expression for masked params
			0 ignored issues – show Documentation Bug introduced 2022-11-27 13:33 UTC by Report Bug Copy Issue Report The doc comment `non-empty-string` at position `0` could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string. Loading history...
64			* @param non-empty-string $pathDelimiter path delimiter for nested param paths
65			* @return string result string with replaced params masks
66			*/
67			public static function formatSilent(
68			string $input,
69			array $params,
70			string $regexp = self::DEFAULT_REGEXP,
71			string $pathDelimiter = self::DEFAULT_PATH_DELIMITER
72			): string {
73			return static::format($input, $params, true, $regexp, $pathDelimiter);
74			}
75
76			/**
77			* Returns map of found keys to replace with params map
78			* @param string $input input string
79			* @param string $regexp regular expression for masked params
80			* @return string[]
81			*/
82			protected static function findKeys(string $input, string $regexp): array
83			{
84			preg_match_all($regexp, $input, $matches);
85			$result = array_combine($matches[0] ?? [], $matches[1] ?? []);
86			if(!$result) {
			0 ignored issues – show Bug Best Practice introduced 2022-11-27 13:13 UTC by Report Bug Copy Issue Report The expression `$result` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
87			return [];
88			}
89			return $result;
90			}
91			}
92

Smoren / string-formatter-php

StringFormatter::format() A last analyzed 2023-06-15 19:35 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

StringFormatter::format() A
last analyzed 2023-06-15 19:35 UTC