\Inhere\Console\Component\FormatterMultiList

Class MultiList

Summary

Methods

Properties

Constants

show()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: src/Component/Formatter/MultiList.php
Package: Component\Formatter
Class hierarchy: \Inhere\Console\Component\MessageFormatter

\Inhere\Console\Component\Formatter\MultiList

Methods

show()

show(array  $data, array  $opts = array())

Format and render multi list

[
  'list1 title' => [
     'name' => 'value text',
     'name2' => 'value text 2',
  ],
  'list2 title' => [
     'name' => 'value text',
     'name2' => 'value text 2',
  ],
  ... ...
]

Parameters

array	$data
array	$opts

<?php declare(strict_types=1);

namespace Inhere\Console\Component\Formatter;

use Inhere\Console\Component\MessageFormatter;
use Inhere\Console\Console;
use function implode;

/**
 * Class MultiList
 *
 * @package Inhere\Console\Component\Formatter
 */
class MultiList extends MessageFormatter
{
    /**
     * Format and render multi list
     *
     * ```php
     * [
     *   'list1 title' => [
     *      'name' => 'value text',
     *      'name2' => 'value text 2',
     *   ],
     *   'list2 title' => [
     *      'name' => 'value text',
     *      'name2' => 'value text 2',
     *   ],
     *   ... ...
     * ]
     * ```
     *
     * @param array $data
     * @param array $opts
     */
    public static function show(array $data, array $opts = []): void
    {
        $stringList  = [];
        $ignoreEmpty = $opts['ignoreEmpty'] ?? true;
        $lastNewline = true;

        $opts['returned'] = true;
        if (isset($opts['lastNewline'])) {
            $lastNewline = $opts['lastNewline'];
            unset($opts['lastNewline']);
        }

        foreach ($data as $title => $list) {
            if ($ignoreEmpty && !$list) {
                continue;
            }

            $stringList[] = SingleList::show($list, (string)$title, $opts);
        }

        Console::write(implode("\n", $stringList), $lastNewline);
    }
}