\Inhere\Console\Component\FormatterSingleList

Class SingleList - Format and render a single list

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/SingleList.php
Package: Component\Formatter
Class hierarchy: \Inhere\Console\Component\MessageFormatter

\Inhere\Console\Component\Formatter\SingleList

Methods

show()

show(array  $data, string  $title = 'Information', array  $opts = array()) : integer|string

Format and render a single list

$title = 'list title';
$data = [
     'name'  => 'value text',
     'name2' => 'value text 2',
];

Parameters

array	$data
string	$title
array	$opts	More {@see FormatUtil::spliceKeyValue()}

Returns

integer|string

<?php declare(strict_types=1);

namespace Inhere\Console\Component\Formatter;

use Inhere\Console\Component\MessageFormatter;
use Inhere\Console\Console;
use Inhere\Console\Util\FormatUtil;
use Toolkit\Cli\ColorTag;
use function array_merge;
use function trim;
use function ucwords;
use const PHP_EOL;

/**
 * Class SingleList - Format and render a single list
 *
 * @package Inhere\Console\Component\Formatter
 */
class SingleList extends MessageFormatter
{
    /**
     * Format and render a single list
     *
     * ```php
     * $title = 'list title';
     * $data = [
     *      'name'  => 'value text',
     *      'name2' => 'value text 2',
     * ];
     * ```
     *
     * @param array  $data
     * @param string $title
     * @param array  $opts More {@see FormatUtil::spliceKeyValue()}
     *
     * @return int|string
     */
    public static function show($data, string $title = 'Information', array $opts = [])
    {
        $string = '';
        $opts   = array_merge([
            'leftChar'    => '  ',
            // 'sepChar' => '  ',
            'keyStyle'    => 'info',
            'keyMinWidth' => 8,
            'titleStyle'  => 'comment',
            'returned'    => false,
            'lastNewline' => true,
        ], $opts);

        // title
        if ($title) {
            $title  = ucwords(trim($title));
            $string .= ColorTag::wrap($title, $opts['titleStyle']) . PHP_EOL;
        }

        // handle item list
        $string .= FormatUtil::spliceKeyValue((array)$data, $opts);

        // return formatted string.
        if ($opts['returned']) {
            return $string;
        }

        return Console::write($string, $opts['lastNewline']);
    }
}