SetaFramework API Reference

Index

\com\setasign\SetaFramework
1. Helper

com\setasign\SetaFramework\Helper

ConsoleHelper Class ArrayHelper

File: /SetaFramework/src/Helper/ConsoleHelper.php

Class hierarchy

ConsoleHelper

Summary

Static Methods

format()

Constants

ANSI_RESET
BACKGROUND_BLACK
BACKGROUND_BLUE
BACKGROUND_CYAN
BACKGROUND_GREEN
BACKGROUND_PURPLE
BACKGROUND_RED
BACKGROUND_WHITE
BACKGROUND_YELLOW
FOREGROUND_BLACK
FOREGROUND_BLUE
FOREGROUND_CYAN
FOREGROUND_GREEN
FOREGROUND_PURPLE
FOREGROUND_RED
FOREGROUND_WHITE
FOREGROUND_YELLOW

Constants

ANSI_RESET

public const ConsoleHelper::ANSI_RESET = '[0m'

BACKGROUND_BLACK

public const ConsoleHelper::BACKGROUND_BLACK = 40

BACKGROUND_BLUE

public const ConsoleHelper::BACKGROUND_BLUE = 44

BACKGROUND_CYAN

public const ConsoleHelper::BACKGROUND_CYAN = 46

BACKGROUND_GREEN

public const ConsoleHelper::BACKGROUND_GREEN = 42

BACKGROUND_PURPLE

public const ConsoleHelper::BACKGROUND_PURPLE = 45

BACKGROUND_RED

public const ConsoleHelper::BACKGROUND_RED = 41

BACKGROUND_WHITE

public const ConsoleHelper::BACKGROUND_WHITE = 47

BACKGROUND_YELLOW

public const ConsoleHelper::BACKGROUND_YELLOW = 43

FOREGROUND_BLACK

public const ConsoleHelper::FOREGROUND_BLACK = 30

FOREGROUND_BLUE

public const ConsoleHelper::FOREGROUND_BLUE = 34

FOREGROUND_CYAN

public const ConsoleHelper::FOREGROUND_CYAN = 36

FOREGROUND_GREEN

public const ConsoleHelper::FOREGROUND_GREEN = 32

FOREGROUND_PURPLE

public const ConsoleHelper::FOREGROUND_PURPLE = 35

FOREGROUND_RED

public const ConsoleHelper::FOREGROUND_RED = 31

FOREGROUND_WHITE

public const ConsoleHelper::FOREGROUND_WHITE = 37

FOREGROUND_YELLOW

public const ConsoleHelper::FOREGROUND_YELLOW = 33

Static Methods

format()

public static ConsoleHelper::format (

string $output,
?int<\30, \37> $foreground = null,
?int<\40, \47> $background = null,
bool $ignoreColorSupport = false

): string

Parameters

$output : string
$foreground : ?int<\30, \37>
$background : ?int<\40, \47>
$ignoreColorSupport : bool: If true - it'll always color the text.