class reclean extends command

Properties

protected user $user from  command
protected driver_interface $db
protected language $language
protected int $processed
protected ProgressBar $progress

Methods

__construct(user $user, driver_interface $db, 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()

Sets the command name and description

int
execute(InputInterface $input, OutputInterface $output)

Executes the command user:reclean

bool|int
reclean_usernames(int $start = 0)

Re-clean user names Only user names that are unclean will be re-cleaned

int
get_count()

Get the count of users in the database

Details

at line 47
__construct(user $user, driver_interface $db, language $language)

Construct method

Parameters

user $user

User instance (mostly for translation)

driver_interface $db
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 60
protected null configure()

Sets the command name and description

Return Value

null

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

Executes the command user:reclean

Cleans user names that are unclean.

Parameters

InputInterface $input

The input stream used to get the options

OutputInterface $output

The output stream, used to print messages

Return Value

int

0 if all is well, 1 if any errors occurred

at line 112
protected bool|int reclean_usernames(int $start = 0)

Re-clean user names Only user names that are unclean will be re-cleaned

Parameters

int $start

An offset index

Return Value

bool|int

Return the next offset index or true if all records have been processed.

at line 150
protected int get_count()

Get the count of users in the database

Return Value

int