Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Cursor.php

class Cursor

Same name in this branch
  1. 11.1.x vendor/symfony/var-dumper/Cloner/Cursor.php \Symfony\Component\VarDumper\Cloner\Cursor

@author Pierre du Plessis <pdples@gmail.com>

Hierarchy

  • class \Symfony\Component\Console\Cursor

Expanded class hierarchy of Cursor

2 files declare their use of Cursor
ProgressBar.php in vendor/symfony/console/Helper/ProgressBar.php
QuestionHelper.php in vendor/symfony/console/Helper/QuestionHelper.php

File

vendor/symfony/console/Cursor.php, line 19

Namespace

Symfony\Component\Console
View source
final class Cursor {
    
    /** @var resource */
    private $input;
    
    /**
     * @param resource|null $input
     */
    public function __construct(OutputInterface $output, $input = null) {
        $this->input = $input ?? (\defined('STDIN') ? \STDIN : fopen('php://input', 'r+'));
    }
    
    /**
     * @return $this
     */
    public function moveUp(int $lines = 1) : static {
        $this->output
            ->write(\sprintf("\x1b[%dA", $lines));
        return $this;
    }
    
    /**
     * @return $this
     */
    public function moveDown(int $lines = 1) : static {
        $this->output
            ->write(\sprintf("\x1b[%dB", $lines));
        return $this;
    }
    
    /**
     * @return $this
     */
    public function moveRight(int $columns = 1) : static {
        $this->output
            ->write(\sprintf("\x1b[%dC", $columns));
        return $this;
    }
    
    /**
     * @return $this
     */
    public function moveLeft(int $columns = 1) : static {
        $this->output
            ->write(\sprintf("\x1b[%dD", $columns));
        return $this;
    }
    
    /**
     * @return $this
     */
    public function moveToColumn(int $column) : static {
        $this->output
            ->write(\sprintf("\x1b[%dG", $column));
        return $this;
    }
    
    /**
     * @return $this
     */
    public function moveToPosition(int $column, int $row) : static {
        $this->output
            ->write(\sprintf("\x1b[%d;%dH", $row + 1, $column));
        return $this;
    }
    
    /**
     * @return $this
     */
    public function savePosition() : static {
        $this->output
            ->write("\x1b7");
        return $this;
    }
    
    /**
     * @return $this
     */
    public function restorePosition() : static {
        $this->output
            ->write("\x1b8");
        return $this;
    }
    
    /**
     * @return $this
     */
    public function hide() : static {
        $this->output
            ->write("\x1b[?25l");
        return $this;
    }
    
    /**
     * @return $this
     */
    public function show() : static {
        $this->output
            ->write("\x1b[?25h\x1b[?0c");
        return $this;
    }
    
    /**
     * Clears all the output from the current line.
     *
     * @return $this
     */
    public function clearLine() : static {
        $this->output
            ->write("\x1b[2K");
        return $this;
    }
    
    /**
     * Clears all the output from the current line after the current position.
     */
    public function clearLineAfter() : self {
        $this->output
            ->write("\x1b[K");
        return $this;
    }
    
    /**
     * Clears all the output from the cursors' current position to the end of the screen.
     *
     * @return $this
     */
    public function clearOutput() : static {
        $this->output
            ->write("\x1b[0J");
        return $this;
    }
    
    /**
     * Clears the entire screen.
     *
     * @return $this
     */
    public function clearScreen() : static {
        $this->output
            ->write("\x1b[2J");
        return $this;
    }
    
    /**
     * Returns the current cursor position as x,y coordinates.
     */
    public function getCurrentPosition() : array {
        static $isTtySupported;
        if (!($isTtySupported ??= '/' === \DIRECTORY_SEPARATOR && stream_isatty(\STDOUT))) {
            return [
                1,
                1,
            ];
        }
        $sttyMode = shell_exec('stty -g');
        shell_exec('stty -icanon -echo');
        @fwrite($this->input, "\x1b[6n");
        $code = trim(fread($this->input, 1024));
        shell_exec(\sprintf('stty %s', $sttyMode));
        sscanf($code, "\x1b[%d;%dR", $row, $col);
        return [
            $col,
            $row,
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary
Cursor::$input private property @var resource
Cursor::clearLine public function Clears all the output from the current line.
Cursor::clearLineAfter public function Clears all the output from the current line after the current position.
Cursor::clearOutput public function Clears all the output from the cursors&#039; current position to the end of the screen.
Cursor::clearScreen public function Clears the entire screen.
Cursor::getCurrentPosition public function Returns the current cursor position as x,y coordinates.
Cursor::hide public function
Cursor::moveDown public function
Cursor::moveLeft public function
Cursor::moveRight public function
Cursor::moveToColumn public function
Cursor::moveToPosition public function
Cursor::moveUp public function
Cursor::restorePosition public function
Cursor::savePosition public function
Cursor::show public function
Cursor::__construct public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal