Command Text Util

Text Utils is one of the many powerful features offered by Luminova's Framework command-line interface. With this versatile class, you can enhance the appearance of your output text, taking your CLI tool to a new level of elegance and professionalism. Whether you're aiming to beautify your output for end users or simply improve readability during development, Text Utils provides functions to help you achieve your goals with ease.

• Class namespace: \Luminova\Command\TextUtils

Constants

Methods

padStart

Pads string left

public static padStart(string $text, int $length, string $char = ' '): string

Parameters:

padEnd

Pads string right

public static padEnd(string $text, int $max, string $char = ' '): string

Parameters:

border

Create a border around text.

public static border(string $text, ?int $padding = null): string

Parameters:

Return Value:

string - Return text with border round.

center

Create a centered text

public static center(string $text, int|null $padding = null): string

Parameters:

Return Value:

string - Return centered text.

padding

Pads string both left and right.

public static padding(string $text, int $max, string $char = ' ', int $padd = STR_PAD_BOTH): string

Parameters:

fit

Pads string to fit same length

public static fit(string $text, int $max, int $extra = 2, int $indent): string

Parameters:

strlen

Get the length of characters in a string and ignore styles

public static strlen(string $string = null, string $encoding = 'UTF-8'): int

Parameters:

Return Value:

int - The number of characters in the string

style

Apply style format on text string

public static style(string $text, int|null $format = null, bool $formatted = true): string

Parameters:

Return Value:

string - A style formatted ansi string

hasAnsi

Check if text already has ANSI method in place

public static hasAnsi(string $text): bool

Parameters:

Return Value:

bool - true or false

largest

Get the largest line from text.

public static largest(string $text): array<int,mixed>

Parameters:

Return Value:

array<int,mixed> - Return largest line from text and it length.