ShellOutput.php
View Options

	<?php

	/*
	* This file is part of Psy Shell.
	*
	* (c) 2012-2023 Justin Hileman
	*
	* For the full copyright and license information, please view the LICENSE
	* file that was distributed with this source code.
	*/

	namespace Psy\Output;

	use Symfony\Component\Console\Formatter\OutputFormatter;
	use Symfony\Component\Console\Formatter\OutputFormatterInterface;
	use Symfony\Component\Console\Output\ConsoleOutput;

	/**
	* A ConsoleOutput subclass specifically for Psy Shell output.
	*/
	class ShellOutput extends ConsoleOutput
	{
	const NUMBER_LINES = 128;

	private int $paging = 0;
	private OutputPager $pager;
	private Theme $theme;

	/**
	* Construct a ShellOutput instance.
	*
	* @param mixed $verbosity (default: self::VERBOSITY_NORMAL)
	* @param bool\|null $decorated (default: null)
	* @param OutputFormatterInterface\|null $formatter (default: null)
	* @param string\|OutputPager\|null $pager (default: null)
	*/
	public function __construct($verbosity = self::VERBOSITY_NORMAL, $decorated = null, ?OutputFormatterInterface $formatter = null, $pager = null, $theme = null)
	{
	parent::__construct($verbosity, $decorated, $formatter);

	$this->theme = $theme ?? new Theme('modern');
	$this->initFormatters();

	if ($pager === null) {
	$this->pager = new PassthruPager($this);
	} elseif (\is_string($pager)) {
	$this->pager = new ProcOutputPager($this, $pager);
	} elseif ($pager instanceof OutputPager) {
	$this->pager = $pager;
	} else {
	throw new \InvalidArgumentException('Unexpected pager parameter: '.$pager);
	}
	}

	/**
	* Page multiple lines of output.
	*
	* The output pager is started
	*
	* If $messages is callable, it will be called, passing this output instance
	* for rendering. Otherwise, all passed $messages are paged to output.
	*
	* Upon completion, the output pager is flushed.
	*
	* @param string\|array\|\Closure $messages A string, array of strings or a callback
	* @param int $type (default: 0)
	*/
	public function page($messages, int $type = 0)
	{
	if (\is_string($messages)) {
	$messages = (array) $messages;
	}

	if (!\is_array($messages) && !\is_callable($messages)) {
	throw new \InvalidArgumentException('Paged output requires a string, array or callback');
	}

	$this->startPaging();

	if (\is_callable($messages)) {
	$messages($this);
	} else {
	$this->write($messages, true, $type);
	}

	$this->stopPaging();
	}

	/**
	* Start sending output to the output pager.
	*/
	public function startPaging()
	{
	$this->paging++;
	}

	/**
	* Stop paging output and flush the output pager.
	*/
	public function stopPaging()
	{
	$this->paging--;
	$this->closePager();
	}

	/**
	* Writes a message to the output.
	*
	* Optionally, pass `$type \| self::NUMBER_LINES` as the $type parameter to
	* number the lines of output.
	*
	* @throws \InvalidArgumentException When unknown output type is given
	*
	* @param string\|array $messages The message as an array of lines or a single string
	* @param bool $newline Whether to add a newline or not
	* @param int $type The type of output
	*/
	public function write($messages, $newline = false, $type = 0): void
	{
	if ($this->getVerbosity() === self::VERBOSITY_QUIET) {
	return;
	}

	$messages = (array) $messages;

	if ($type & self::NUMBER_LINES) {
	$pad = \strlen((string) \count($messages));
	$template = $this->isDecorated() ? "<aside>%{$pad}s</aside>: %s" : "%{$pad}s: %s";

	if ($type & self::OUTPUT_RAW) {
	$messages = \array_map([OutputFormatter::class, 'escape'], $messages);
	}

	foreach ($messages as $i => $line) {
	$messages[$i] = \sprintf($template, $i, $line);
	}

	// clean this up for super.
	$type = $type & ~self::NUMBER_LINES & ~self::OUTPUT_RAW;
	}

	parent::write($messages, $newline, $type);
	}

	/**
	* Writes a message to the output.
	*
	* Handles paged output, or writes directly to the output stream.
	*
	* @param string $message A message to write to the output
	* @param bool $newline Whether to add a newline or not
	*/
	public function doWrite($message, $newline): void
	{
	// @todo Update OutputPager interface to require doWrite
	if ($this->paging > 0 && $this->pager instanceof ProcOutputPager) {
	$this->pager->doWrite($message, $newline);
	} else {
	parent::doWrite($message, $newline);
	}
	}

	/**
	* Set the output Theme.
	*/
	public function setTheme(Theme $theme)
	{
	$this->theme = $theme;
	$this->initFormatters();
	}

	/**
	* Flush and close the output pager.
	*/
	private function closePager()
	{
	if ($this->paging <= 0) {
	$this->pager->close();
	}
	}

	/**
	* Initialize output formatter styles.
	*/
	private function initFormatters()
	{
	$useGrayFallback = !$this->grayExists();
	$this->theme->applyStyles($this->getFormatter(), $useGrayFallback);
	$this->theme->applyErrorStyles($this->getErrorOutput()->getFormatter(), $useGrayFallback);
	}

	/**
	* Checks if the "gray" color exists on the output.
	*/
	private function grayExists(): bool
	{
	try {
	$this->write('<fg=gray></>');
	} catch (\InvalidArgumentException $e) {
	return false;
	}

	return true;
	}
	}

File Metadata

Mime Type: text/x-php
Expires: Sat, Oct 3, 21:10 (1 w, 1 d ago)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: dc/51/b974459c4ad5335f007ee92267eb
Default Alt Text: ShellOutput.php (5 KB)

ShellOutput.php
No OneTemporary
Actions

ShellOutput.php
View Options

File Metadata

Event Timeline

ShellOutput.phpNo OneTemporaryActions

ShellOutput.phpView Options

File Metadata

Event Timeline

ShellOutput.php
No OneTemporary
Actions

ShellOutput.php
View Options