1. Documentation
  2. API
  3. System
  4. Console
  5. OctoberUtil

System\Console\OctoberUtil

Overview

OctoberUtil is a console command for other utility commands

This provides functionality that doesn't quite deserve its own dedicated console class. It is used mostly developer tools and maintenance tasks.

Currently supported commands:

  • purge thumbs: Deletes all thumbnail files in the uploads directory.
  • purge orphans: Deletes files in "system_files" that do not belong to any other model.
  • purge uploads: Deletes files in the uploads directory that do not exist in the "system_files" table.
  • git pull: Perform "git pull" on all plugins and themes.
  • compile assets: Compile registered Language, LESS and JS files.
  • compile js: Compile registered JS files only.
  • compile less: Compile registered LESS files only.
  • compile scss: Compile registered SCSS files only.
  • compile lang: Compile registered Language files only.
  • set build: Pull the latest stable build number from the update gateway and set it as the current build number.

Available patch versions:

  • patch 2.0
Extends
  • Illuminate\Console\Command
  • Symfony\Component\Console\Command\Command

Protected Properties

protected $name

The console command name.

protected $description

The console command description.

protected string $refitFinalMessage

Show inherited protected properties

Inherited Protected Properties

  • $laravel - The Laravel application instance. (defined in Illuminate\Console\Command)
  • $signature - The name and signature of the console command. (defined in Illuminate\Console\Command)
  • $help - The console command help text. (defined in Illuminate\Console\Command)
  • $hidden - Indicates whether the command should be shown in the Artisan command list. (defined in Illuminate\Console\Command)
  • $defaultName - The default command name. (defined in Symfony\Component\Console\Command\Command)
  • $defaultDescription - The default command description. (defined in Symfony\Component\Console\Command\Command)
  • $components - The console components factory. (defined in Illuminate\Console\Command)
  • $input - The input interface implementation. (defined in Illuminate\Console\Command)
  • $output - The output interface implementation. (defined in Illuminate\Console\Command)
  • $verbosity - The default verbosity of output commands. (defined in Illuminate\Console\Command)
  • $verbosityMap - The mapping between human readable verbosity levels and Symfony's OutputInterface. (defined in Illuminate\Console\Command)
  • $signals - The signal registrar instance. (defined in Illuminate\Console\Command)
  • $macros - The registered string macros. (defined in Illuminate\Console\Command)

Public Methods

public confirmToProceed()

public confirmToProceed(
    string $warning = 'Application In Production',
    Closure|bool|null $callback = null
): bool

Confirm before proceeding with the action.

This method only asks for confirmation in production.

public handle()

public handle(): void

Execute the console command.

Show inherited public methods

Inherited Public Methods

  • __call() - Dynamically handle calls to the class. (defined in Illuminate\Console\Command)
  • __callStatic() - Dynamically handle calls to the class. (defined in Illuminate\Console\Command)
  • __construct() - Create a new console command instance. (defined in Illuminate\Console\Command)
  • addArgument() - Adds an argument. (defined in Symfony\Component\Console\Command\Command)
  • addOption() - Adds an option. (defined in Symfony\Component\Console\Command\Command)
  • addUsage() - Add a command usage example, it'll be prefixed with the command name. (defined in Symfony\Component\Console\Command\Command)
  • alert() - Write a string in an alert box. (defined in Illuminate\Console\Command)
  • anticipate() - Prompt the user for input with auto completion. (defined in Illuminate\Console\Command)
  • argument() - Get the value of a command argument. (defined in Illuminate\Console\Command)
  • arguments() - Get all of the arguments passed to the command. (defined in Illuminate\Console\Command)
  • ask() - Prompt the user for input. (defined in Illuminate\Console\Command)
  • askWithCompletion() - Prompt the user for input with auto completion. (defined in Illuminate\Console\Command)
  • call() - Call another console command. (defined in Illuminate\Console\Command)
  • callSilent() - Call another console command without output. (defined in Illuminate\Console\Command)
  • callSilently() - Call another console command without output. (defined in Illuminate\Console\Command)
  • choice() - Give the user a single choice from an array of answers. (defined in Illuminate\Console\Command)
  • comment() - Write a string as comment output. (defined in Illuminate\Console\Command)
  • complete() - Adds suggestions to $suggestions for the current completion input (e.g. option or argument). (defined in Symfony\Component\Console\Command\Command)
  • confirm() - Confirm a question with the user. (defined in Illuminate\Console\Command)
  • error() - Write a string as error output. (defined in Illuminate\Console\Command)
  • flushMacros() - Flush the existing macros. (defined in Illuminate\Console\Command)
  • getAliases() - Returns the aliases for the command. (defined in Symfony\Component\Console\Command\Command)
  • getApplication() - Gets the application instance for this command. (defined in Symfony\Component\Console\Command\Command)
  • getDefaultDescription() - (defined in Symfony\Component\Console\Command\Command)
  • getDefaultName() - (defined in Symfony\Component\Console\Command\Command)
  • getDefinition() - Gets the InputDefinition attached to this Command. (defined in Symfony\Component\Console\Command\Command)
  • getDescription() - Returns the description for the command. (defined in Symfony\Component\Console\Command\Command)
  • getHelp() - Returns the help for the command. (defined in Symfony\Component\Console\Command\Command)
  • getHelper() - Gets a helper instance by name. (defined in Symfony\Component\Console\Command\Command)
  • getHelperSet() - Gets the helper set. (defined in Symfony\Component\Console\Command\Command)
  • getLaravel() - Get the Laravel application instance. (defined in Illuminate\Console\Command)
  • getName() - Returns the command name. (defined in Symfony\Component\Console\Command\Command)
  • getNativeDefinition() - Gets the InputDefinition to be used to create representations of this Command. (defined in Symfony\Component\Console\Command\Command)
  • getOutput() - Get the output implementation. (defined in Illuminate\Console\Command)
  • getProcessedHelp() - Returns the processed help for the command replacing the %command.name% and. (defined in Symfony\Component\Console\Command\Command)
  • getSynopsis() - Returns the synopsis for the command. (defined in Symfony\Component\Console\Command\Command)
  • getUsages() - Returns alternative usages of the command. (defined in Symfony\Component\Console\Command\Command)
  • hasArgument() - Determine if the given argument is present. (defined in Illuminate\Console\Command)
  • hasMacro() - Checks if macro is registered. (defined in Illuminate\Console\Command)
  • hasOption() - Determine if the given option is present. (defined in Illuminate\Console\Command)
  • ignoreValidationErrors() - Ignores validation errors. (defined in Symfony\Component\Console\Command\Command)
  • info() - Write a string as information output. (defined in Illuminate\Console\Command)
  • isEnabled() - Checks whether the command is enabled or not in the current environment. (defined in Symfony\Component\Console\Command\Command)
  • isHidden() - {@inheritdoc}. (defined in Illuminate\Console\Command)
  • line() - Write a string as standard output. (defined in Illuminate\Console\Command)
  • macro() - Register a custom macro. (defined in Illuminate\Console\Command)
  • mergeApplicationDefinition() - Merges the application definition with the command definition. (defined in Symfony\Component\Console\Command\Command)
  • mixin() - Mix another object into the class. (defined in Illuminate\Console\Command)
  • newLine() - Write a blank line. (defined in Illuminate\Console\Command)
  • option() - Get the value of a command option. (defined in Illuminate\Console\Command)
  • options() - Get all of the options passed to the command. (defined in Illuminate\Console\Command)
  • question() - Write a string as question output. (defined in Illuminate\Console\Command)
  • run() - Run the console command. (defined in Illuminate\Console\Command)
  • secret() - Prompt the user for input but hide the answer from the console. (defined in Illuminate\Console\Command)
  • setAliases() - Sets the aliases for the command. (defined in Symfony\Component\Console\Command\Command)
  • setApplication() - (defined in Symfony\Component\Console\Command\Command)
  • setCode() - Sets the code to execute when running this command. (defined in Symfony\Component\Console\Command\Command)
  • setDefinition() - Sets an array of argument and option instances. (defined in Symfony\Component\Console\Command\Command)
  • setDescription() - Sets the description for the command. (defined in Symfony\Component\Console\Command\Command)
  • setHelp() - Sets the help for the command. (defined in Symfony\Component\Console\Command\Command)
  • setHelperSet() - (defined in Symfony\Component\Console\Command\Command)
  • setHidden() - {@inheritdoc}. (defined in Illuminate\Console\Command)
  • setInput() - Set the input interface implementation. (defined in Illuminate\Console\Command)
  • setLaravel() - Set the Laravel application instance. (defined in Illuminate\Console\Command)
  • setName() - Sets the name of the command. (defined in Symfony\Component\Console\Command\Command)
  • setOutput() - Set the output interface implementation. (defined in Illuminate\Console\Command)
  • setProcessTitle() - Sets the process title of the command. (defined in Symfony\Component\Console\Command\Command)
  • table() - Format input to textual table. (defined in Illuminate\Console\Command)
  • trap() - Define a callback to be run when the given signal(s) occurs. (defined in Illuminate\Console\Command)
  • untrap() - Untrap signal handlers set within the command's handler. (defined in Illuminate\Console\Command)
  • warn() - Write a string as warning output. (defined in Illuminate\Console\Command)
  • withProgressBar() - Execute a given callback while advancing a progress bar. (defined in Illuminate\Console\Command)

Protected Methods

protected getArguments()

protected getArguments(): array

Get the console command arguments.

protected getAvailableCommands()

protected getAvailableCommands(): array

protected getDefaultConfirmCallback()

protected getDefaultConfirmCallback(): void

getDefaultConfirmCallback specifies the default confirmation callback

protected getOptions()

protected getOptions(): void

Get the console command options.

protected refitLangFindLocales()

protected refitLangFindLocales(): void

protected refitLangInternal()

protected refitLangInternal($input, $rewrite = true): void

protected refitLangJsonDelete()

protected refitLangJsonDelete($basePath, $lang, $key): void

refitLangJsonDelete will delete the JSON lang key and rewrite the file

protected refitLangJsonEncode()

protected refitLangJsonEncode($newArr): void

protected refitLangKeyRewrite()

protected refitLangKeyRewrite($basePath, $lang, $key, $fileName = null): void

refitLangKeyRewrite will add the php lang to the json lang

protected refitLangPhpDelete()

protected refitLangPhpDelete($basePath, $lang, $key, $fileName = null): void

refitLangPhpDelete will delete the php lang key and rewrite the file

protected refitVarExportShort()

protected refitVarExportShort($data, $return = true): void

protected utilCompileAssets()

protected utilCompileAssets($type = null): void

protected utilCompileJs()

protected utilCompileJs(): void

protected utilCompileLang()

protected utilCompileLang(): void

protected utilCompileLess()

protected utilCompileLess(): void

protected utilCompileScss()

protected utilCompileScss(): void

protected utilGitPull()

protected utilGitPull(): void

utilGitPull requires the git binary to be installed

protected utilImportCrowdin()

protected utilImportCrowdin(): void

utilImportCrowdin excepts a directory above the root called "crowdin" with the export data

protected utilPatch2Point0()

protected utilPatch2Point0(): void

utilPatch2Point0 october:util patch2.0

protected utilPurgeOrphans()

protected utilPurgeOrphans(): void

utilPurgeOrphans deletes files in "system_files" that do not belong to any other model

protected utilPurgeResizer()

protected utilPurgeResizer(): void

utilPurgeResizer deletes all resizer files in the resources directory

protected utilPurgeThumbs()

protected utilPurgeThumbs(): void

utilPurgeThumbs deletes all thumbnail files in the uploads directory

protected utilPurgeUploads()

protected utilPurgeUploads(): void

utilPurgeUploads deletes files in the uploads directory that do not exist in the "system_files" table

protected utilRefitLang()

protected utilRefitLang(): void

protected utilSetBuild()

protected utilSetBuild(): void

protected utilWipeLang()

protected utilWipeLang(): void

utilLangWipe

protected utilWipeLangJson()

protected utilWipeLangJson(): void

utilLangWipeJson

Show inherited protected methods

Inherited Protected Methods

  • afterPromptingForMissingArguments() - Perform actions after the user was prompted for missing arguments. (defined in Illuminate\Console\Command)
  • commandIsolationMutex() - Get a command isolation mutex instance for the command. (defined in Illuminate\Console\Command)
  • configure() - Configures the current command. (defined in Symfony\Component\Console\Command\Command)
  • configureIsolation() - Configure the console command for isolation. (defined in Illuminate\Console\Command)
  • configureUsingFluentDefinition() - Configure the console command using a fluent definition. (defined in Illuminate\Console\Command)
  • context() - Get all of the context passed to the command. (defined in Illuminate\Console\Command)
  • createInputFromArguments() - Create an input instance from the given arguments. (defined in Illuminate\Console\Command)
  • didReceiveOptions() - Whether the input contains any options that differ from the default values. (defined in Illuminate\Console\Command)
  • execute() - Execute the console command. (defined in Illuminate\Console\Command)
  • initialize() - Initializes the command after the input has been bound and before the input. (defined in Symfony\Component\Console\Command\Command)
  • interact() - Interact with the user before validating the input. (defined in Illuminate\Console\Command)
  • parseVerbosity() - Get the verbosity level in terms of Symfony's OutputInterface level. (defined in Illuminate\Console\Command)
  • promptForMissingArguments() - Prompt the user for any missing arguments. (defined in Illuminate\Console\Command)
  • promptForMissingArgumentsUsing() - Prompt for missing input arguments using the returned questions. (defined in Illuminate\Console\Command)
  • resolveCommand() - Resolve the console command instance for the given command. (defined in Illuminate\Console\Command)
  • runCommand() - Run the given the console command. (defined in Illuminate\Console\Command)
  • setVerbosity() - Set the verbosity level. (defined in Illuminate\Console\Command)
  • specifyParameters() - Specify the arguments and options on the command. (defined in Illuminate\Console\Command)