Helper Term

1Présentation

Ce helper facilité la gestion des terminaux (TTY) lors de l'écriture de scripts en ligne de commande.

L'objet \Temma\Utils\Term propose des méthodes statiques.

2input()

Cette méthode statique permet de récupérer un texte saisi par l'utilisateur.

Signature de la méthode :

input() : string

Exemple :

use \Temma\Utils\Term as TµTerm;

print("Quel est ton nom ?\n");
$nom = TµTerm::input();
print("Bonjour '$nom'\n");

3password()

Cette méthode statique permet de récupérer un texte saisi par l'utilisateur, sans que le texte n'apparaisse à l'écran.

Signature de la méthode :

password() : string

Exemple :

use \Temma\Utils\Term as TµTerm;

print("Veuillez saisir votre mot de passe\n");
$pwd = TµTerm::input();
if (mb_strlen($pwd) < 12)
    print("Votre mot de passe est trop court\n");

4clear()

Efface l'écran.

Signature de la méthode :

clear() : void

Exemple :

\Temma\Utils\Term::clear();

5clearFromcursor()

Efface l'écran à partir de la position du curseur.

Signature de la méthode :

clearFromCursor() : void

Exemple :

\Temma\Utils\Term::clearFromCursor();

6reset()

Efface l'écran et réinitialise sa configuration. L'historique d'affichage est perdu.

Signature de la méthode :

reset() : void

Exemple :

\Temma\Utils\Term::reset();

7clearLine()

Efface la ligne sur laquelle le curseur est positionné. Le curseur est repositionné au début de la ligne.

Signature de la méthode :

clearLine() : void

Exemple :

\Temma\Utils\Term::clearLine();

8clearLineFromCursor()

Efface la ligne courante après le curseur.

Signature de la méthode :

clearLineFromCursor() : void

Exemple :

\Temma\Utils\Term::clearLineFromCursor();

9hideCursor()

Cache le curseur.

Signature de la méthode :

hideCursor() : void

Exemple :

\Temma\Utils\Term::hideCursor();

10showCursor()

Affiche le curseur.

Signature de la méthode :

showCursor() : void

Exemple :

\Temma\Utils\Term::showCursor();

11saveCursor()

Sauvegarde la position du curseur (pour pouvoir la restaurer plus tard avec la méthode restoreCursor()).

Signature de la méthode :

saveCursor() : void

Exemple :

\Temma\Utils\Term::saveCursor();

12restoreCursor()

Restaure la position du curseur qui a été préalablement sauvegardée avec la méthode saveCursor().

Signature de la méthode :

restoreCursor() : void

Exemple :

\Temma\Utils\Term::restoreCursor();

13moveCursorHome()

Déplace le curseur dans le coin en haut à gauche (position 0,0) du terminal.

Signature de la méthode :

moveCursorHome() : void

Exemple :

\Temma\Utils\Term::moveCursorHome();

14moveCursorTo()

Déplace le curseur aux coordonnées passées en paramètre.

Signature de la méthode :

moveCursorTo(int $x, int $y) : void

Exemple :

\Temma\Utils\Term::moveCursorTo(17, 4);

15moveCursorLineStart()

Déplace le curseur au début de la ligne courante.

Signature de la méthode :

moveCursorLineStart() : void

Exemple :

\Temma\Utils\Term::moveCursorLineStart();

16moveCursorUp()

Déplace le curseur vers le haut du nombre de lignes passé en paramètre (1 ligne par défaut).

Signature de la méthode :

moveCursorUp(int $nbrLines=1) : void

Exemple :

use \Temma\Utils\Term as TµTerm;

// déplace d'une ligne vers le haut
TµTerm::moveCursorUp();
// déplace de trois lignes vers le haut
TµTerm::moveCursorUp(3);

17moveCursorDown()

Déplace le curseur vers le bas du nombre de lignes passé en paramètre (1 ligne par défaut).

Signature de la méthode :

moveCursorDown(int $nbrLines=1) : void

Exemple :

use \Temma\Utils\Term as TµTerm;

// déplace d'une ligne vers le bas
TµTerm::moveCursorDown();
// déplace de trois lignes vers le bas
TµTerm::moveCursorDown(3);

18moveCursorRight()

Déplace le curseur vers la droite du nombre de colonnes passé en paramètre (1 colonne par défaut).

Signature de la méthode :

moveCursorRight(int $nbrColumns=1) : void

Exemple :

use \Temma\Utils\Term as TµTerm;

// déplace d'une colonne vers la droite
TµTerm::moveCursorRight();
// déplace de trois colonnes vers la droite
TµTerm::moveCursorRight(3);

19moveCursorLeft()

Déplace le curseur vers la gauche du nombre de colonnes passé en paramètre (1 colonne par défaut).

Signature de la méthode :

moveCursorLeft(int $nbrColumns=1) : void

Exemple :

use \Temma\Utils\Term as TµTerm;

// déplace d'une colonne vers la gauche
TµTerm::moveCursorLeft();
// déplace de trois colonnes vers la gauche
TµTerm::moveCursorLeft(3);

20getCursorPosition()

Cette méthode retourne la position actuelle du curseur.

Signature de la méthode :

getCursorPosition() : array

Exemple :

use \Temma\Utils\Term as TµTerm;

[$x, $y] = TµTerm::getCursorPosition();

21getScreenSize()

Cette méthode retourne la taille de l'écran (le nombre de colonnes et de lignes).

Signature de la méthode :

getScreenSize(bool $force=false) : array

Paramètre :

$force : true pour forcer la récupération (sans utiliser le cache). Inutile la plupart du temps, car l'objet met à jour les valeurs en cache lorsque le terminal est redimensionné.

Exemple :

use \Temma\Utils\Term as TµTerm;

[$width, $height] = TµTerm::getScreenSize();