CloudCastle Cli API

Columns
in package

FinalYes

Раскладка списка значений по колонкам с выравниванием по ширине.

Элементы заполняются слева направо, затем сверху вниз; ширина каждой колонки подстраивается под самое длинное значение в ней (по видимым символам).

Table of Contents

Methods

__construct()  : mixed
lines()  : Generator<int, string>
Построчная раскладка по колонкам без материализации результата.
render()  : string
Разложить значения по заданному числу колонок.
renderTo()  : void
Разложить значения по колонкам прямо в приёмник вывода.

Methods

__construct()

public __construct([int $gap = 2 ]) : mixed
Parameters
$gap : int = 2

число пробелов между колонками (≥ 0)

Tags
throws
InvalidArgumentException

если зазор отрицателен

lines()

Построчная раскладка по колонкам без материализации результата.

public lines(array<int, string> $items, int $columns) : Generator<int, string>

Аргументы проверяются сразу, до начала обхода, поэтому некорректное число колонок приводит к исключению в момент вызова, а не при первой итерации.

Parameters
$items : array<int, string>

значения

$columns : int

число колонок (> 0)

Tags
throws
InvalidArgumentException

если число колонок не положительно

Return values
Generator<int, string> —

строки раскладки без перевода строки

render()

Разложить значения по заданному числу колонок.

public render(array<int, string> $items, int $columns) : string
Parameters
$items : array<int, string>

значения

$columns : int

число колонок (> 0)

Tags
throws
InvalidArgumentException

если число колонок не положительно

Return values
string —

выровненная по колонкам раскладка

renderTo()

Разложить значения по колонкам прямо в приёмник вывода.

public renderTo(Writer $writer, array<int, string> $items, int $columns) : void
Parameters
$writer : Writer

приёмник вывода

$items : array<int, string>

значения

$columns : int

число колонок (> 0)

Tags
throws
InvalidArgumentException

если число колонок не положительно

On this page

Search results