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 ()

	startProgress (int $max)

	advanceProgress ()

	stopProgress ()

	inform (string $message)

	confirmOrDeny (string $message)

	confirmExplicit (string $message, string $type_text_to_confirm)

Data Fields
const	LABEL_WIDTH = 75

const	ELLIPSIS = "..."

Protected Member Functions
	shouldSayYes ()

	closeLastObjective ()
	The line of the last objective is complete, output from now on does not belong to it and must not be marked as "[in progress]". More...

	outputInObjective ()

	showLastObjectiveLabel ()

Protected Attributes
InputInterface	$in

OutputInterface	$out

SymfonyStyle	$style

bool	$last_objective_was_notable = false

string	$last_objective_label = ""

bool	$output_in_objective = true
	true as long as there is no line of an objective waiting for its result More...

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 47 of file IOWrapper.php.

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

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

Member Function Documentation

◆ advanceProgress()

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

Implements ILIAS\Setup\AdminInteraction.

Definition at line 60 of file IOWrapper.php.

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

◆ closeLastObjective()

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

protected

The line of the last objective is complete, output from now on does not belong to it and must not be marked as "[in progress]".

Definition at line 181 of file IOWrapper.php.

                                           : void
    {
        $this->output_in_objective = true;
    }

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

Here is the caller graph for this function:

◆ confirmExplicit()

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

Implements ILIAS\Setup\AdminInteraction.

Definition at line 76 of file IOWrapper.php.

                                                                                  : 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;
        }
    }

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

Here is the call graph for this function:

◆ confirmOrDeny()

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

Implements ILIAS\Setup\AdminInteraction.

Definition at line 91 of file IOWrapper.php.

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

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

Here is the call graph for this function:

◆ error()

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

Definition at line 132 of file IOWrapper.php.

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

References $text.

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

Here is the caller graph for this function:

◆ failedLastObjective()

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

Definition at line 164 of file IOWrapper.php.

                                         : 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");
        }
        $this->closeLastObjective();
    }

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

Here is the call graph for this function:

◆ finishedLastObjective()

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

Definition at line 152 of file IOWrapper.php.

                                           : 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");
        }
        $this->closeLastObjective();
    }

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

Here is the call graph for this function:

◆ inform()

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

Implements ILIAS\Setup\AdminInteraction.

Definition at line 70 of file IOWrapper.php.

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

References $message, and 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\runAllMigrations().

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 201 of file IOWrapper.php.

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

◆ outputInObjective()

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

protected

Definition at line 186 of file IOWrapper.php.

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

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

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

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 104 of file IOWrapper.php.

                                         : 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."
        );
    }

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

Here is the call graph for this function:

◆ shouldSayYes()

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

protected

Definition at line 117 of file IOWrapper.php.

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

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

Here is the caller graph for this function:

◆ showLastObjectiveLabel()

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

protected

Definition at line 194 of file IOWrapper.php.

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

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

Here is the caller graph for this function:

◆ startObjective()

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

Definition at line 142 of file IOWrapper.php.

                                                                   : 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));
        }
    }

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

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

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 55 of file IOWrapper.php.

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

◆ stopProgress()

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

Implements ILIAS\Setup\AdminInteraction.

Definition at line 65 of file IOWrapper.php.

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

◆ success()

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

Definition at line 127 of file IOWrapper.php.

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

References $text.

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

Here is the caller graph for this function:

◆ text()

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

Definition at line 137 of file IOWrapper.php.

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

References $text.

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

Here is the caller graph for this function:

◆ title()

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

Definition at line 122 of file IOWrapper.php.

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

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

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 = true

protected

true as long as there is no line of an objective waiting for its result

Definition at line 45 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()

◆ closeLastObjective()

◆ 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