Wrapper around symfonies input and output facilities to provide just the functionality required for the ILIAS-setup. More...

Inheritance diagram for ILIAS\Setup\CLI\IOWrapper:

Collaboration diagram for ILIAS\Setup\CLI\IOWrapper:

Public Member Functions
	__construct (InputInterface $in, OutputInterface $out)

	startProgress (int $max)

	advanceProgress ()

	stopProgress ()

	inform (string $message)

	confirmExplicit (string $message, string $type_text_to_confirm)

	confirmOrDeny (string $message)

	printLicenseMessage ()

	title (string $title)

	success (string $text)

	error (string $text)

	text (string $text)

	startObjective (string $label, bool $is_notable)

	finishedLastObjective ()

	failedLastObjective ()

	isVerbose ()

Data Fields
const	LABEL_WIDTH = 75

const	ELLIPSIS = "..."

Protected Member Functions
	shouldSayYes ()

	outputInObjective ()

	showLastObjectiveLabel ()

Protected Attributes
InputInterface	$in

OutputInterface	$out

SymfonyStyle	$style

bool	$last_objective_was_notable = false

string	$last_objective_label = ""

bool	$output_in_objective = false

Detailed Description

Wrapper around symfonies input and output facilities to provide just the functionality required for the ILIAS-setup.

Definition at line 32 of file IOWrapper.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Setup\CLI\IOWrapper::__construct	(	InputInterface	$in,
		OutputInterface	$out
	)

Definition at line 44 of file IOWrapper.php.

References ILIAS\Setup\CLI\IOWrapper\$in, and ILIAS\Setup\CLI\IOWrapper\$out.

     {
         $this->in = $in;
         $this->out = $out;
         $this->style = new SymfonyStyle($in, $out);
     }

Member Function Documentation

◆ advanceProgress()

ILIAS\Setup\CLI\IOWrapper::advanceProgress ( )

Implements ILIAS\Setup\AdminInteraction.

Definition at line 57 of file IOWrapper.php.

                                      : void
     {
         $this->style->progressAdvance();
     }

◆ confirmExplicit()

ILIAS\Setup\CLI\IOWrapper::confirmExplicit	(	string	$message,
		string	$type_text_to_confirm
	)

Implements ILIAS\Setup\AdminInteraction.

Definition at line 73 of file IOWrapper.php.

References ILIAS\Setup\CLI\IOWrapper\inform(), ILIAS\Setup\CLI\IOWrapper\outputInObjective(), and ILIAS\Setup\CLI\IOWrapper\shouldSayYes().

                                                                                   : bool
     {
         $this->outputInObjective();
         if (!$this->shouldSayYes()) {
             return $this->style->ask(
                 $message,
                 null,
                 fn (string $input): bool => $type_text_to_confirm === $input
             );
         } else {
             $this->inform("Automatically confirmed:\n\n$message");
             return true;
         }
     }

Here is the call graph for this function:

◆ confirmOrDeny()

ILIAS\Setup\CLI\IOWrapper::confirmOrDeny ( string $message )

Implements ILIAS\Setup\AdminInteraction.

Definition at line 88 of file IOWrapper.php.

References ILIAS\Setup\CLI\IOWrapper\inform(), ILIAS\Setup\CLI\IOWrapper\outputInObjective(), and ILIAS\Setup\CLI\IOWrapper\shouldSayYes().

                                                   : bool
     {
         $this->outputInObjective();
         if (!$this->shouldSayYes()) {
             return $this->style->confirm($message, false);
         } else {
             $this->inform("Automatically confirmed:\n\n$message");
             return true;
         }
     }

Here is the call graph for this function:

◆ error()

ILIAS\Setup\CLI\IOWrapper::error ( string $text )

Definition at line 129 of file IOWrapper.php.

Referenced by ILIAS\Setup\CLI\AchieveCommand\executeAchieveObjective(), and ILIAS\Setup\CLI\MigrateCommand\runMigration().

                                        : void
     {
         $this->style->error($text);
     }

Here is the caller graph for this function:

◆ failedLastObjective()

ILIAS\Setup\CLI\IOWrapper::failedLastObjective ( )

Definition at line 160 of file IOWrapper.php.

References ILIAS\Setup\CLI\IOWrapper\showLastObjectiveLabel(), and ILIAS\Setup\CLI\IOWrapper\startObjective().

                                          : void
     {
         // Always show label of failed objectives.
         if ($this->output_in_objective || !$this->last_objective_was_notable) {
             $this->startObjective($this->last_objective_label, true);
         }
 
         if ($this->showLastObjectiveLabel()) {
             $this->style->write("[<fg=red>FAILED</>]\n");
         }
     }

Here is the call graph for this function:

◆ finishedLastObjective()

ILIAS\Setup\CLI\IOWrapper::finishedLastObjective ( )

Definition at line 149 of file IOWrapper.php.

References ILIAS\Setup\CLI\IOWrapper\showLastObjectiveLabel(), and ILIAS\Setup\CLI\IOWrapper\startObjective().

                                            : void
     {
         if ($this->output_in_objective) {
             $this->startObjective($this->last_objective_label, $this->last_objective_was_notable);
         }
 
         if ($this->showLastObjectiveLabel()) {
             $this->style->write("[<fg=green>OK</>]\n");
         }
     }

Here is the call graph for this function:

◆ inform()

ILIAS\Setup\CLI\IOWrapper::inform ( string $message )

Implements ILIAS\Setup\AdminInteraction.

Definition at line 67 of file IOWrapper.php.

References ILIAS\Setup\CLI\IOWrapper\outputInObjective().

Referenced by ILIAS\Setup\CLI\IOWrapper\confirmExplicit(), ILIAS\Setup\CLI\IOWrapper\confirmOrDeny(), ILIAS\Setup\CLI\MigrateCommand\listMigrations(), and ILIAS\Setup\CLI\MigrateCommand\runMigration().

                                            : void
     {
         $this->outputInObjective();
         $this->style->note($message);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isVerbose()

ILIAS\Setup\CLI\IOWrapper::isVerbose ( )

Definition at line 187 of file IOWrapper.php.

                                : bool
     {
         return $this->out->isVerbose();
     }

◆ outputInObjective()

ILIAS\Setup\CLI\IOWrapper::outputInObjective ( )

protected

Definition at line 172 of file IOWrapper.php.

References ILIAS\Setup\CLI\IOWrapper\showLastObjectiveLabel().

Referenced by ILIAS\Setup\CLI\IOWrapper\confirmExplicit(), ILIAS\Setup\CLI\IOWrapper\confirmOrDeny(), and ILIAS\Setup\CLI\IOWrapper\inform().

                                           : void
     {
         if (!$this->output_in_objective && $this->showLastObjectiveLabel()) {
             $this->output_in_objective = true;
             $this->style->write("[in progress]\n");
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printLicenseMessage()

ILIAS\Setup\CLI\IOWrapper::printLicenseMessage ( )

Definition at line 101 of file IOWrapper.php.

References ILIAS\Setup\CLI\IOWrapper\shouldSayYes(), and ILIAS\Setup\CLI\IOWrapper\text().

                                          : void
     {
         if ($this->shouldSayYes() || ($this->in->hasOption("no-interaction") && $this->in->getOption("no-interaction"))) {
             return;
         }
         $this->text(
             "   ILIAS Copyright (C) 1998-2019 ILIAS Open Source e.V. - GPLv3\n\n" .
             "This program comes with ABSOLUTELY NO WARRANTY. This is free software,\n" .
             "and you are welcome to redistribute it under certain conditions. Look\n" .
             "into the LICENSE file for details."
         );
     }

Here is the call graph for this function:

◆ shouldSayYes()

ILIAS\Setup\CLI\IOWrapper::shouldSayYes ( )

protected

Definition at line 114 of file IOWrapper.php.

Referenced by ILIAS\Setup\CLI\IOWrapper\confirmExplicit(), ILIAS\Setup\CLI\IOWrapper\confirmOrDeny(), and ILIAS\Setup\CLI\IOWrapper\printLicenseMessage().

                                      : bool
     {
         return $this->in->getOption("yes") ?? false;
     }

Here is the caller graph for this function:

◆ showLastObjectiveLabel()

ILIAS\Setup\CLI\IOWrapper::showLastObjectiveLabel ( )

protected

Definition at line 180 of file IOWrapper.php.

Referenced by ILIAS\Setup\CLI\IOWrapper\failedLastObjective(), ILIAS\Setup\CLI\IOWrapper\finishedLastObjective(), ILIAS\Setup\CLI\IOWrapper\outputInObjective(), and ILIAS\Setup\CLI\IOWrapper\startObjective().

                                                : bool
     {
         return $this->last_objective_was_notable
             || $this->out->isVeryVerbose()
             || $this->out->isDebug();
     }

Here is the caller graph for this function:

◆ startObjective()

ILIAS\Setup\CLI\IOWrapper::startObjective	(	string	$label,
		bool	$is_notable
	)

Definition at line 139 of file IOWrapper.php.

References ILIAS\Setup\CLI\IOWrapper\showLastObjectiveLabel().

Referenced by ILIAS\Setup\CLI\IOWrapper\failedLastObjective(), and ILIAS\Setup\CLI\IOWrapper\finishedLastObjective().

                                                                    : void
     {
         $this->last_objective_was_notable = $is_notable;
         $this->last_objective_label = $label;
         $this->output_in_objective = false;
         if ($this->showLastObjectiveLabel()) {
             $this->style->write(str_pad($label . "...", self::LABEL_WIDTH));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ startProgress()

ILIAS\Setup\CLI\IOWrapper::startProgress ( int $max )

Implements ILIAS\Setup\AdminInteraction.

Definition at line 52 of file IOWrapper.php.

                                            : void
     {
         $this->style->progressStart($max);
     }

◆ stopProgress()

ILIAS\Setup\CLI\IOWrapper::stopProgress ( )

Implements ILIAS\Setup\AdminInteraction.

Definition at line 62 of file IOWrapper.php.

                                   : void
     {
         $this->style->progressFinish();
     }

◆ success()

ILIAS\Setup\CLI\IOWrapper::success ( string $text )

Definition at line 124 of file IOWrapper.php.

Referenced by ILIAS\Setup\CLI\AchieveCommand\executeAchieveObjective().

                                          : void
     {
         $this->style->success($text);
     }

Here is the caller graph for this function:

◆ text()

ILIAS\Setup\CLI\IOWrapper::text ( string $text )

Definition at line 134 of file IOWrapper.php.

Referenced by ILIAS\Setup\CLI\MigrateCommand\listMigrations(), ILIAS\Setup\CLI\IOWrapper\printLicenseMessage(), and ILIAS\Setup\CLI\MigrateCommand\runMigration().

                                       : void
     {
         $this->style->text($text);
     }

Here is the caller graph for this function:

◆ title()

ILIAS\Setup\CLI\IOWrapper::title ( string $title )

Definition at line 119 of file IOWrapper.php.

Referenced by ILIAS\Setup\CLI\AchieveCommand\executeAchieveObjective(), and ILIAS\Setup\CLI\AchieveCommand\executeListNamedObjectives().

                                         : void
     {
         $this->style->title($title);
     }

Here is the caller graph for this function:

Field Documentation

◆ $in

InputInterface ILIAS\Setup\CLI\IOWrapper::$in

protected

Definition at line 37 of file IOWrapper.php.

Referenced by ILIAS\Setup\CLI\IOWrapper\__construct().

◆ $last_objective_label

string ILIAS\Setup\CLI\IOWrapper::$last_objective_label = ""

protected

Definition at line 41 of file IOWrapper.php.

◆ $last_objective_was_notable

bool ILIAS\Setup\CLI\IOWrapper::$last_objective_was_notable = false

protected

Definition at line 40 of file IOWrapper.php.

◆ $out

OutputInterface ILIAS\Setup\CLI\IOWrapper::$out

protected

Definition at line 38 of file IOWrapper.php.

Referenced by ILIAS\Setup\CLI\IOWrapper\__construct().

◆ $output_in_objective

bool ILIAS\Setup\CLI\IOWrapper::$output_in_objective = false

protected

Definition at line 42 of file IOWrapper.php.

◆ $style

SymfonyStyle ILIAS\Setup\CLI\IOWrapper::$style

protected

Definition at line 39 of file IOWrapper.php.

◆ ELLIPSIS

const ILIAS\Setup\CLI\IOWrapper::ELLIPSIS = "..."

Definition at line 35 of file IOWrapper.php.

◆ LABEL_WIDTH

const ILIAS\Setup\CLI\IOWrapper::LABEL_WIDTH = 75

Definition at line 34 of file IOWrapper.php.

Referenced by ILIAS\Setup\CLI\AchieveCommand\executeListNamedObjectives().

The documentation for this class was generated from the following file:

components/ILIAS/Setup/src/CLI/IOWrapper.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ advanceProgress()

◆ confirmExplicit()

◆ confirmOrDeny()

◆ error()

◆ failedLastObjective()

◆ finishedLastObjective()

◆ inform()

◆ isVerbose()

◆ outputInObjective()

◆ printLicenseMessage()

◆ shouldSayYes()

◆ showLastObjectiveLabel()

◆ startObjective()

◆ startProgress()

◆ stopProgress()

◆ success()

◆ text()

◆ title()

Field Documentation

◆ $in

◆ $last_objective_label

◆ $last_objective_was_notable

◆ $out

◆ $output_in_objective

◆ $style

◆ ELLIPSIS

◆ LABEL_WIDTH