Documentation

MessageTrait

Console message sizing/alignment trait, shared by Header and Alert

Tags
category

Pop

author

Nick Sagona, III nick@popphp.org

copyright

Copyright (c) 2009-2026 Nick Sagona, III

license

https://www.popphp.org/license New BSD License

version
5.0.0

Table of Contents

Methods

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

Methods

buildAlignedMessageLines()

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
int

resolveSize()

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
Return values
int|string

        
On this page

Search results