class check extends command

Properties

protected user $user from  command
protected config $config
protected ContainerInterface $phpbb_container

Methods

__construct(user $user, config $config, ContainerInterface $phpbb_container, language $language)

Construct method

ProgressBar
create_progress_bar(int $max, SymfonyStyle $io, OutputInterface $output, bool $message = false)

Create a styled progress bar

from  command
null
configure()

Configures the service.

int
execute(InputInterface $input, OutputInterface $output)

Executes the command.

int
check_ext(InputInterface $input, SymfonyStyle $io, string $stability, bool $recheck, string $ext_name)

Check if a given extension is up to date

int
check_core(InputInterface $input, SymfonyStyle $io, string $stability, bool $recheck)

Check if the core is up to date

int
check_all_ext(SymfonyStyle $io, string $stability, bool $recheck)

Check if all the available extensions are up to date

display_versions(SymfonyStyle $io, array $updates_available)

Display the details of the available updates

Details

at line 44
__construct(user $user, config $config, ContainerInterface $phpbb_container, language $language)

Construct method

Parameters

user $user

User instance (mostly for translation)

config $config
ContainerInterface $phpbb_container
language $language

in command at line 45
ProgressBar create_progress_bar(int $max, SymfonyStyle $io, OutputInterface $output, bool $message = false)

Create a styled progress bar

Parameters

int $max

Max value for the progress bar

SymfonyStyle $io

Symfony style output decorator

OutputInterface $output

The output stream, used to print messages

bool $message

Should we display message output under the progress bar?

Return Value

ProgressBar

at line 62
protected null configure()

Configures the service.

Sets the name and description of the command.

Return Value

null

at line 85
protected int execute(InputInterface $input, OutputInterface $output)

Executes the command.

Checks if an update is available. If at least one is available, a message is printed and if verbose mode is set the list of possible updates is printed. If their is none, nothing is printed unless verbose mode is set.

Parameters

InputInterface $input

Input stream, used to get the options.

OutputInterface $output

Output stream, used to print messages.

Return Value

int

0 if the board is up to date, 1 if it is not and 2 if an error occurred.

Exceptions

RuntimeException

at line 134
protected int check_ext(InputInterface $input, SymfonyStyle $io, string $stability, bool $recheck, string $ext_name)

Check if a given extension is up to date

Parameters

InputInterface $input

Input stream, used to get the options.

SymfonyStyle $io

IO handler, for formatted and unified IO

string $stability

Force a given stability

bool $recheck

Disallow the use of the cache

string $ext_name

The extension name

Return Value

int

at line 188
protected int check_core(InputInterface $input, SymfonyStyle $io, string $stability, bool $recheck)

Check if the core is up to date

Parameters

InputInterface $input

Input stream, used to get the options.

SymfonyStyle $io

IO handler, for formatted and unified IO

string $stability

Force a given stability

bool $recheck

Disallow the use of the cache

Return Value

int

at line 232
protected int check_all_ext(SymfonyStyle $io, string $stability, bool $recheck)

Check if all the available extensions are up to date

Parameters

SymfonyStyle $io

IO handler, for formatted and unified IO

string $stability

Stability specifier string

bool $recheck

Disallow the use of the cache

Return Value

int

at line 305
protected display_versions(SymfonyStyle $io, array $updates_available)

Display the details of the available updates

Parameters

SymfonyStyle $io

IO handler, for formatted and unified IO

array $updates_available

The list of the available updates