<?php
/**
 * Copyright 2010-2017 Horde LLC (http://www.horde.org/)
 *
 * This package is ported from Python's Optik (http://optik.sourceforge.net/).
 *
 * See the enclosed file LICENSE for license information (BSD). If you
 * did not receive this file, see http://www.horde.org/licenses/bsd.
 *
 * @author   Chuck Hagenbuch <chuck@horde.org>
 * @author   Mike Naberezny <mike@maintainable.com>
 * @license  http://www.horde.org/licenses/bsd BSD
 * @category Horde
 * @package  Argv
 */

/**
 * Format help with underlined section headers.
 *
 * @category  Horde
 * @package   Argv
 * @author    Chuck Hagenbuch <chuck@horde.org>
 * @author    Mike Naberezny <mike@maintainable.com>
 * @copyright 2010-2017 Horde LLC
 * @license   http://www.horde.org/licenses/bsd BSD
 */
class Horde_Argv_TitledHelpFormatter extends Horde_Argv_HelpFormatter
{
    public function __construct(
        $indent_increment = 0, $max_help_position = 24, $width = null,
        $short_first = false, $color = null
    )
    {
        parent::__construct(
            $indent_increment, $max_help_position, $width, $short_first, $color
        );
    }

    public function formatUsage($usage)
    {
        return sprintf(
            "%s  %s\n",
            $this->formatHeading(Horde_Argv_Translation::t("Usage")),
            $usage
        );
    }

    public function formatHeading($heading)
    {
        $prefix = array('=', '-');
        return $this->highlightHeading(sprintf(
            "%s\n%s\n",
            $heading,
            str_repeat($prefix[$this->level], strlen($heading))
        ));
    }

}
