: str_replace(): Passing null to parameter #2 ($replace) of type array|string is deprecated in
namespace AmpProject\Cli;
use AmpProject\Exception\Cli\InvalidColumnFormat;
* This file is adapted from the splitbrain\php-cli library, which is authored by Andreas Gohr <andi@splitbrain.org> and
* licensed under the MIT license.
* Source: https://github.com/splitbrain/php-cli/blob/8c2c001b1b55d194402cf18aad2757049ac6d575/src/TableFormatter.php
* Output text in multiple columns.
* @package ampproject/amp-toolbox
* Border between columns.
* The terminal width in characters.
* Falls back to 74 characters if it cannot be detected.
protected $maxWidth = 74;
* Instance of the Colors helper object.
* TableFormatter constructor.
* @param Colors|null $colors Optional. Instance of the Colors helper object.
public function __construct(Colors $colors = null)
// Try to get terminal width.
$width = $this->getTerminalWidth();
$this->maxWidth = $width - 1;
$this->colors = $colors instanceof Colors ? $colors : new Colors();
* The currently set border.
public function getBorder()
* The border is set between each column. Its width is added to the column widths.
* @param string $border Border to set.
public function setBorder($border)
* Width of the terminal in characters.
* Initially auto-detected, with a fallback of 74 characters.
public function getMaxWidth()
* Set the width of the terminal to assume (in characters).
* @param int $maxWidth Terminal width in characters.
public function setMaxWidth($maxWidth)
$this->maxWidth = $maxWidth;
* Displays text in multiple word wrapped columns.
* @param array<int|string> $columns List of column widths (in characters, percent or '*').
* @param array<string> $texts List of texts for each column.
* @param array<string> $colors Optional. A list of color names to use for each column. Use empty string within
* the array for default. Defaults to an empty array.
* @return string Adapted text.
public function format($columns, $texts, $colors = [])
$columns = $this->calculateColumnWidths($columns);
foreach ($columns as $column => $width) {
$wrapped[$column] = explode("\n", $this->wordwrap($texts[$column], $width, "\n", true));
$length = count($wrapped[$column]);
if ($length > $maxLength) {
$last = count($columns) - 1;
for ($index = 0; $index < $maxLength; $index++) {
foreach ($columns as $column => $width) {
if (isset($wrapped[$column][$index])) {
$value = $wrapped[$column][$index];
$chunk = $this->pad($value, $width);
if (isset($colors[$column]) && $colors[$column]) {
$chunk = $this->colors->wrap($chunk, $colors[$column]);
// Add border in-between columns.
$output .= $this->border;
* Tries to figure out the width of the terminal.
* @return int Terminal width, 0 if unknown.
protected function getTerminalWidth()
if (isset($_SERVER['COLUMNS'])) {
return (int)$_SERVER['COLUMNS'];
$width = (int)stream_get_contents($pipes[1]);
* Takes an array with dynamic column width and calculates the correct widths.
* Column width can be given as fixed char widths, percentages and a single * width can be given
* for taking the remaining available space. When mixing percentages and fixed widths, percentages
* refer to the remaining space after allocating the fixed width.
* @param array $columns Columns to calculate the widths for.
* @return int[] Array of calculated column widths.
* @throws InvalidColumnFormat If the column format is not valid.
protected function calculateColumnWidths($columns)
$border = $this->strlen($this->border);
$fixed = (count($columns) - 1) * $border; // Borders are used already.
// First pass for format check and fixed columns.
foreach ($columns as $index => $column) {
if ((string)intval($column) === (string)$column) {
// Check if other columns are using proper units.
if (substr($column, -1) === '%') {
throw InvalidColumnFormat::forMultipleFluidColumns();
throw InvalidColumnFormat::forUnknownColumnFormat($column);
$remain = $this->maxWidth - $allocated;
// Second pass to handle percentages.
foreach ($columns as $index => $column) {
if (substr($column, -1) !== '%') {
$percent = floatval($column);
$real = (int)floor(($percent * $remain) / 100);
$columns[$index] = $real;
$remain = $this->maxWidth - $allocated;
throw InvalidColumnFormat::forExceededMaxWidth();
// Assign remaining space.
$columns[$index] += ($remain); // Add to last column.
$columns[$fluid] = $remain;
* Pad the given string to the correct length.
* @param string $string String to pad.
* @param int $length Length to pad the string to.
* @return string Padded string.
protected function pad($string, $length)
$strlen = $this->strlen($string);
$pad = $length - $strlen;
return $string . str_pad('', $pad, ' ');
* Measures character length in UTF-8 when possible.
* @param string $string String to measure the character length of.
* @return int Count of characters.
protected function strlen($string)
// Don't count color codes.
$string = preg_replace("/\33\\[\\d+(;\\d+)?m/", '', $string);
if (function_exists('mb_strlen')) {
return mb_strlen($string, 'utf-8');
* Extract a substring in UTF-8 if possible.
* @param string $string String to extract a substring out of.
* @param int $start Optional. Starting index to extract from. Defaults to 0.
* @param int|null $length Optional. Length to extract. Set to null to use the remainder of the string (default).
* @return string Extracted substring.
protected function substr($string, $start = 0, $length = null)
if (function_exists('mb_substr')) {
return mb_substr($string, $start, $length);
// mb_substr() treats $length differently than substr().
return substr($string, $start, $length);
return substr($string, $start);
* Wrap words of a string into a requested width.
* @param string $string String to wrap.
* @param int $width Optional. Width to warp the string into. Defaults to 75.
* @param string $break Optional. Character to use for wrapping. Defaults to a newline character. Defaults to the
* @param bool $cut Optional. Whether to cut longer words to enforce the width. Defaults to false.
* @return string Word-wrapped string.
* @link http://stackoverflow.com/a/4988494
protected function wordwrap($string, $width = 75, $break = "\n", $cut = false)
$lines = explode($break, $string);
foreach ($lines as &$line) {
if ($this->strlen($line) <= $width) {
$words = explode(' ', $line);
foreach ($words as $word) {
if ($this->strlen($actual . $word) <= $width) {
$line .= rtrim($actual) . $break;
while ($this->strlen($actual) > $width) {
$line .= $this->substr($actual, 0, $width) . $break;
$actual = $this->substr($actual, $width);
return implode($break, $lines);
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
