Alert
in package
uses
MessageTrait
Console alert class
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- Instantiate the alert object
- alert() : string
- Build a colored alert box
- alertBox() : string
- Build a colorless alert outline box
- alertDanger() : string
- Build a "danger" alert box
- alertDark() : string
- Build a "dark" alert box
- alertInfo() : string
- Build an "info" alert box
- alertLight() : string
- Build a "light" alert box
- alertPrimary() : string
- Build a "primary" alert box
- alertSecondary() : string
- Build a "secondary" alert box
- alertSuccess() : string
- Build a "success" alert box
- alertWarning() : string
- Build a "warning" alert box
- buildAlignedMessageLines() : array<string|int, mixed>
- Word-wrap and align a message into padded lines of $size width
- calculatePad() : int
- Calculate string pad
- resolveSize() : int|string
- Resolve an explicit/auto/null $size against the given wrap/width/margin
Properties
$indent
protected
string
$indent
= ''
$margin
protected
int|null
$margin
= null
$width
protected
int
$width
= 0
$wrap
protected
int|null
$wrap
= null
Methods
__construct()
Instantiate the alert object
public
__construct([string $indent = '' ][, int|null $wrap = null ][, int $width = 0 ][, int|null $margin = null ]) : mixed
Parameters
- $indent : string = ''
- $wrap : int|null = null
- $width : int = 0
- $margin : int|null = null
alert()
Build a colored alert box
public
alert(string $message, int $fg, int $bg[, int|string|null $size = null ][, string $align = 'center' ][, int $innerPad = 4 ][, bool $newline = true ]) : string
Parameters
- $message : string
- $fg : int
- $bg : int
- $size : int|string|null = null
- $align : string = 'center'
- $innerPad : int = 4
- $newline : bool = true
Return values
stringalertBox()
Build a colorless alert outline box
public
alertBox(string $message[, string $h = '-' ][, string|null $v = '|' ][, int|string|null $size = null ][, string $align = 'center' ][, int $innerPad = 4 ][, bool $newline = true ]) : string
Parameters
- $message : string
- $h : string = '-'
- $v : string|null = '|'
- $size : int|string|null = null
- $align : string = 'center'
- $innerPad : int = 4
- $newline : bool = true
Return values
stringalertDanger()
Build a "danger" alert box
public
alertDanger(string $message[, int|string|null $size = null ][, string $align = 'center' ][, int $innerPad = 4 ][, bool $newline = true ]) : string
Parameters
- $message : string
- $size : int|string|null = null
- $align : string = 'center'
- $innerPad : int = 4
- $newline : bool = true
Return values
stringalertDark()
Build a "dark" alert box
public
alertDark(string $message[, int|string|null $size = null ][, string $align = 'center' ][, int $innerPad = 4 ][, bool $newline = true ]) : string
Parameters
- $message : string
- $size : int|string|null = null
- $align : string = 'center'
- $innerPad : int = 4
- $newline : bool = true
Return values
stringalertInfo()
Build an "info" alert box
public
alertInfo(string $message[, int|string|null $size = null ][, string $align = 'center' ][, int $innerPad = 4 ][, bool $newline = true ]) : string
Parameters
- $message : string
- $size : int|string|null = null
- $align : string = 'center'
- $innerPad : int = 4
- $newline : bool = true
Return values
stringalertLight()
Build a "light" alert box
public
alertLight(string $message[, int|string|null $size = null ][, string $align = 'center' ][, int $innerPad = 4 ][, bool $newline = true ]) : string
Parameters
- $message : string
- $size : int|string|null = null
- $align : string = 'center'
- $innerPad : int = 4
- $newline : bool = true
Return values
stringalertPrimary()
Build a "primary" alert box
public
alertPrimary(string $message[, int|string|null $size = null ][, string $align = 'center' ][, int $innerPad = 4 ][, bool $newline = true ]) : string
Parameters
- $message : string
- $size : int|string|null = null
- $align : string = 'center'
- $innerPad : int = 4
- $newline : bool = true
Return values
stringalertSecondary()
Build a "secondary" alert box
public
alertSecondary(string $message[, int|string|null $size = null ][, string $align = 'center' ][, int $innerPad = 4 ][, bool $newline = true ]) : string
Parameters
- $message : string
- $size : int|string|null = null
- $align : string = 'center'
- $innerPad : int = 4
- $newline : bool = true
Return values
stringalertSuccess()
Build a "success" alert box
public
alertSuccess(string $message[, int|string|null $size = null ][, string $align = 'center' ][, int $innerPad = 4 ][, bool $newline = true ]) : string
Parameters
- $message : string
- $size : int|string|null = null
- $align : string = 'center'
- $innerPad : int = 4
- $newline : bool = true
Return values
stringalertWarning()
Build a "warning" alert box
public
alertWarning(string $message[, int|string|null $size = null ][, string $align = 'center' ][, int $innerPad = 4 ][, bool $newline = true ]) : string
Parameters
- $message : string
- $size : int|string|null = null
- $align : string = 'center'
- $innerPad : int = 4
- $newline : bool = true
Return values
stringbuildAlignedMessageLines()
Word-wrap and align a message into padded lines of $size width
protected
buildAlignedMessageLines(string $message, int $size, string $align, int $innerPad) : array<string|int, mixed>
Parameters
- $message : string
- $size : int
- $align : string
- $innerPad : int
Return values
array<string|int, mixed>calculatePad()
Calculate string pad
protected
calculatePad(string $string, int $size[, string $align = 'center' ]) : int
Parameters
- $string : string
- $size : int
- $align : string = 'center'
Return values
intresolveSize()
Resolve an explicit/auto/null $size against the given wrap/width/margin
protected
resolveSize(string $text, int|string|null $size, int|null $wrap, int $width, int|null $margin[, int $fallbackPadding = 0 ]) : int|string
Parameters
- $text : string
- $size : int|string|null
- $wrap : int|null
- $width : int
- $margin : int|null
- $fallbackPadding : int = 0