System\Console\OctoberUtil

Source: ~/modules/system/console/OctoberUtil.php

Extends:

  • Illuminate\Console\Command
  • Symfony\Component\Console\Command\Command

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.
  • 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.

Protected properties

protected $name

The console command name.

protected $description

The console command description.

Show inherited protected properties

Inherited protected properties

  • protected Illuminate\Contracts\Foundation\Application $laravel - defined in Illuminate\Console\Command. The Laravel application instance.
  • protected Symfony\Component\Console\Input\InputInterface $input - defined in Illuminate\Console\Command. The input interface implementation.
  • protected Illuminate\Console\OutputStyle $output - defined in Illuminate\Console\Command. The output interface implementation.
  • protected string $signature - defined in Illuminate\Console\Command. The name and signature of the console command.
  • protected bool $hidden - defined in Illuminate\Console\Command. Indicates whether the command should be shown in the Artisan command list.
  • protected int $verbosity - defined in Illuminate\Console\Command. The default verbosity of output commands.
  • protected array $verbosityMap - defined in Illuminate\Console\Command. The mapping between human readable verbosity levels and Symfony's OutputInterface.
  • protected static array $macros - defined in Illuminate\Console\Command. The registered string macros.

Public methods

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

Confirm before proceeding with the action.

This method only asks for confirmation in production.

Parameters
  • string $warning
  • Closure|bool|null $callback

public void handle()

Execute the console command.

Show inherited public methods

Inherited public methods

  • public mixed __call(string $method, array $parameters) - defined in Illuminate\Console\Command. Dynamically handle calls to the class.
  • public static mixed __callStatic(string $method, array $parameters) - defined in Illuminate\Console\Command. Dynamically handle calls to the class.
  • public void __construct() - defined in Illuminate\Console\Command. Create a new console command instance.
  • public $this addArgument(string $name, int $mode=NULL, string $description='', mixed $default=NULL) - defined in Symfony\Component\Console\Command\Command. Adds an argument.
  • public $this addOption(string $name, string $shortcut=NULL, int $mode=NULL, string $description='', mixed $default=NULL) - defined in Symfony\Component\Console\Command\Command. Adds an option.
  • public $this addUsage(string $usage) - defined in Symfony\Component\Console\Command\Command. Add a command usage example.
  • public void alert(string $string) - defined in Illuminate\Console\Command. Write a string in an alert box.
  • public string anticipate(string $question, array $choices, string $default=NULL) - defined in Illuminate\Console\Command. Prompt the user for input with auto completion.
  • public string|array argument(string|null $key=NULL) - defined in Illuminate\Console\Command. Get the value of a command argument.
  • public array arguments() - defined in Illuminate\Console\Command. Get all of the arguments passed to the command.
  • public string ask(string $question, string $default=NULL) - defined in Illuminate\Console\Command. Prompt the user for input.
  • public string askWithCompletion(string $question, array $choices, string $default=NULL) - defined in Illuminate\Console\Command. Prompt the user for input with auto completion.
  • public int call(string $command, array $arguments=array()) - defined in Illuminate\Console\Command. Call another console command.
  • public int callSilent(string $command, array $arguments=array()) - defined in Illuminate\Console\Command. Call another console command silently.
  • public string choice(string $question, array $choices, string $default=NULL, mixed $attempts=NULL, bool $multiple=NULL) - defined in Illuminate\Console\Command. Give the user a single choice from an array of answers.
  • public void comment(string $string, null|int|string $verbosity=NULL) - defined in Illuminate\Console\Command. Write a string as comment output.
  • public bool confirm(string $question, bool $default=false) - defined in Illuminate\Console\Command. Confirm a question with the user.
  • public void error(string $string, null|int|string $verbosity=NULL) - defined in Illuminate\Console\Command. Write a string as error output.
  • public array getAliases() - defined in Symfony\Component\Console\Command\Command. Returns the aliases for the command.
  • public Application getApplication() - defined in Symfony\Component\Console\Command\Command. Gets the application instance for this command.
  • public InputDefinition getDefinition() - defined in Symfony\Component\Console\Command\Command. Gets the InputDefinition attached to this Command.
  • public string getDescription() - defined in Symfony\Component\Console\Command\Command. Returns the description for the command.
  • public string getHelp() - defined in Symfony\Component\Console\Command\Command. Returns the help for the command.
  • public mixed getHelper(string $name) - defined in Symfony\Component\Console\Command\Command. Gets a helper instance by name.
  • public HelperSet getHelperSet() - defined in Symfony\Component\Console\Command\Command. Gets the helper set.
  • public Illuminate\Contracts\Foundation\Application getLaravel() - defined in Illuminate\Console\Command. Get the Laravel application instance.
  • public string getName() - defined in Symfony\Component\Console\Command\Command. Returns the command name.
  • public InputDefinition getNativeDefinition() - defined in Symfony\Component\Console\Command\Command. Gets the InputDefinition to be used to create representations of this Command.
  • public Symfony\Component\Console\Output\OutputInterface getOutput() - defined in Illuminate\Console\Command. Get the output implementation.
  • public string getProcessedHelp() - defined in Symfony\Component\Console\Command\Command. Returns the processed help for the command replacing the %command.name% and.
  • public string getSynopsis(bool $short=false) - defined in Symfony\Component\Console\Command\Command. Returns the synopsis for the command.
  • public array getUsages() - defined in Symfony\Component\Console\Command\Command. Returns alternative usages of the command.
  • public bool hasArgument(string|int $name) - defined in Illuminate\Console\Command. Determine if the given argument is present.
  • public static bool hasMacro(string $name) - defined in Illuminate\Console\Command. Checks if macro is registered.
  • public bool hasOption(string $name) - defined in Illuminate\Console\Command. Determine if the given option is present.
  • public void ignoreValidationErrors() - defined in Symfony\Component\Console\Command\Command. Ignores validation errors.
  • public void info(string $string, null|int|string $verbosity=NULL) - defined in Illuminate\Console\Command. Write a string as information output.
  • public bool isEnabled() - defined in Symfony\Component\Console\Command\Command. Checks whether the command is enabled or not in the current environment.
  • public bool isHidden() - defined in Symfony\Component\Console\Command\Command.
  • public void line(string $string, string $style=NULL, null|int|string $verbosity=NULL) - defined in Illuminate\Console\Command. Write a string as standard output.
  • public static void macro(string $name, object|callable $macro) - defined in Illuminate\Console\Command. Register a custom macro.
  • public void mergeApplicationDefinition(bool $mergeArgs=true) - defined in Symfony\Component\Console\Command\Command. Merges the application definition with the command definition.
  • public static void mixin(object $mixin) - defined in Illuminate\Console\Command. Mix another object into the class.
  • public string|array option(string $key=NULL) - defined in Illuminate\Console\Command. Get the value of a command option.
  • public array options() - defined in Illuminate\Console\Command. Get all of the options passed to the command.
  • public void question(string $string, null|int|string $verbosity=NULL) - defined in Illuminate\Console\Command. Write a string as question output.
  • public int run(Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output) - defined in Illuminate\Console\Command. Run the console command.
  • public string secret(string $question, bool $fallback=true) - defined in Illuminate\Console\Command. Prompt the user for input but hide the answer from the console.
  • public $this setAliases(array $aliases) - defined in Symfony\Component\Console\Command\Command. Sets the aliases for the command.
  • public void setApplication(Application $application=NULL) - defined in Symfony\Component\Console\Command\Command. Sets the application instance for this command.
  • public $this setCode(callable $code) - defined in Symfony\Component\Console\Command\Command. Sets the code to execute when running this command.
  • public $this setDefinition(array|InputDefinition $definition) - defined in Symfony\Component\Console\Command\Command. Sets an array of argument and option instances.
  • public $this setDescription(string $description) - defined in Symfony\Component\Console\Command\Command. Sets the description for the command.
  • public $this setHelp(string $help) - defined in Symfony\Component\Console\Command\Command. Sets the help for the command.
  • public void setHelperSet(HelperSet $helperSet) - defined in Symfony\Component\Console\Command\Command. Sets the helper set.
  • public Command setHidden(bool $hidden) - defined in Symfony\Component\Console\Command\Command. Sets Whether or not the command should be hidden from the list of commands
  • public void setLaravel(Illuminate\Contracts\Container\Container $laravel) - defined in Illuminate\Console\Command. Set the Laravel application instance.
  • public $this setName(string $name) - defined in Symfony\Component\Console\Command\Command. Sets the name of the command.
  • public $this setProcessTitle(string $title) - defined in Symfony\Component\Console\Command\Command. Sets the process title of the command.
  • public void table(array $headers, Illuminate\Contracts\Support\Arrayable|array $rows, string $tableStyle='default', array $columnStyles=array()) - defined in Illuminate\Console\Command. Format input to textual table.
  • public void warn(string $string, null|int|string $verbosity=NULL) - defined in Illuminate\Console\Command. Write a string as warning output.

Protected methods

protected array getArguments()

Get the console command arguments.

protected Closure getDefaultConfirmCallback()

Get the default confirmation callback.

protected void getOptions()

Get the console command options.

protected void utilCompileAssets($type=NULL)
Parameters
  • $type

protected void utilCompileJs()

protected void utilCompileLang()

protected void utilCompileLess()

protected void utilCompileScss()

protected void utilGitPull()

This command requires the git binary to be installed.

protected void utilPurgeOrphans()

protected void utilPurgeThumbs()

protected void utilPurgeUploads()

protected void utilSetBuild()

Show inherited protected methods

Inherited protected methods

  • protected void configure() - defined in Symfony\Component\Console\Command\Command. Configures the current command.
  • protected void configureUsingFluentDefinition() - defined in Illuminate\Console\Command. Configure the console command using a fluent definition.
  • protected Symfony\Component\Console\Input\ArrayInput createInputFromArguments(array $arguments) - defined in Illuminate\Console\Command. Create an input instance from the given arguments.
  • protected mixed execute(Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output) - defined in Illuminate\Console\Command. Execute the console command.
  • protected void initialize(InputInterface $input, OutputInterface $output) - defined in Symfony\Component\Console\Command\Command. Initializes the command just after the input has been validated.
  • protected void interact(InputInterface $input, OutputInterface $output) - defined in Symfony\Component\Console\Command\Command. Interacts with the user.
  • protected int parseVerbosity(string|int $level=NULL) - defined in Illuminate\Console\Command. Get the verbosity level in terms of Symfony's OutputInterface level.
  • protected void setVerbosity(string|int $level) - defined in Illuminate\Console\Command. Set the verbosity level.
  • protected void specifyParameters() - defined in Illuminate\Console\Command. Specify the arguments and options on the command.