StringFormatter/src/Mixin/Builder.php at 113499ae9f211e51abab10f65eb8bc9fc7a0b99f · henriquemoody/StringFormatter · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<?php

/*
 * SPDX-FileCopyrightText: (c) Respect Project Contributors
 * SPDX-License-Identifier: ISC
 * SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
 * SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
 */

declare(strict_types=1);

namespace Respect\StringFormatter\Mixin;

use Respect\StringFormatter\FormatterBuilder;

/** @mixin FormatterBuilder */
interface Builder
{
    public static function area(string $unit): Chain;

    public static function creditCard(): Chain;

    public static function date(string $format = 'Y-m-d H:i:s'): Chain;

    public static function imperialArea(string $unit): Chain;

    public static function imperialLength(string $unit): Chain;

    public static function imperialMass(string $unit): Chain;

    public static function lowercase(): Chain;

    public static function mask(string $range, string $replacement = '*'): Chain;

    public static function mass(string $unit): Chain;

    public static function metric(string $unit): Chain;

    public static function number(
        int $decimals = 0,
        string $decimalSeparator = '.',
        string $thousandsSeparator = ',',
    ): Chain;

    public static function pattern(string $pattern): Chain;

    /** @param array<string, mixed> $parameters */
    public static function placeholder(array $parameters): Chain;

    public static function secureCreditCard(string $maskChar = '*'): Chain;

    public static function time(string $unit): Chain;

    /** @param 'both'|'left'|'right' $side */
    public static function trim(string $side, string|null $characters): Chain;

    public static function uppercase(): Chain;
}