MichaelRubel\Formatters\Collection\MaskStringFormatter

Complexity

Total Complexity

2

Size/Duplication

Total Lines	31
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	format()	0	8	1
A	__construct()	0	7	1

<?php

declare(strict_types=1);

namespace MichaelRubel\Formatters\Collection;

use Illuminate\Support\Str;
use MichaelRubel\Formatters\Formatter;

class MaskStringFormatter implements Formatter
{
    /**
     * @param string|null $string
     * @param string      $character
     * @param int         $index
     * @param int         $length
     * @param string      $encoding
     */
    public function __construct(
        public ?string $string = '',
        public string $character = '*',
        public int $index = 4,
        public int $length = -4,
        public string $encoding = 'UTF-8',
    ) {
    }

    /**
     * Mask the string.
     *
     * @return string
     */
    public function format(): string
    {
        return Str::mask(
            $this->string ?? '',
            $this->character,
            $this->index,
            $this->length,
            $this->encoding
        );
    }
}