1. Documentation
  2. API
  3. Library
  4. Scaffold
  5. Console
  6. CreateFormWidget

October\Rain\Scaffold\Console\CreateFormWidget

Extends:

Protected properties

protected string $name

name of console command

protected string $description

description of the console command

protected string $type

type of class being generated

protected array $stubs

stubs is a mapping of stub to generated file

Show inherited protected properties

Inherited protected properties

  • protected October\Rain\Filesystem\Filesystem $files - defined in October\Rain\Scaffold\GeneratorCommand. files is the filesystem instance.
  • protected array $vars - defined in October\Rain\Scaffold\GeneratorCommand. vars to use in stubs.
  • protected Illuminate\Contracts\Foundation\Application $laravel - defined in Illuminate\Console\Command. The Laravel application instance.
  • protected string $signature - defined in Illuminate\Console\Command. The name and signature of the console command.
  • protected string|null $help - defined in Illuminate\Console\Command. The console command help text.
  • protected bool $hidden - defined in Illuminate\Console\Command. Indicates whether the command should be shown in the Artisan command list.
  • protected static string|null $defaultName - defined in Symfony\Component\Console\Command\Command. The default command name.
  • 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 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

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 October\Rain\Scaffold\GeneratorCommand. __construct creates a new controller creator command instance.
  • public $this addArgument(string $name, int|null $mode=NULL, string $description='', array $default=NULL) - defined in Symfony\Component\Console\Command\Command. Adds an argument.
  • public $this addOption(string $name, string|array|null $shortcut=NULL, int|null $mode=NULL, string $description='', array $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 mixed anticipate(string $question, array|callable $choices, string|null $default=NULL) - defined in Illuminate\Console\Command. Prompt the user for input with auto completion.
  • public string|array|null 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 mixed ask(string $question, string|null $default=NULL) - defined in Illuminate\Console\Command. Prompt the user for input.
  • public mixed askWithCompletion(string $question, array|callable $choices, string|null $default=NULL) - defined in Illuminate\Console\Command. Prompt the user for input with auto completion.
  • public int call(Symfony\Component\Console\Command\Command|string $command, array $arguments=array()) - defined in Illuminate\Console\Command. Call another console command.
  • public int callSilent(Symfony\Component\Console\Command\Command|string $command, array $arguments=array()) - defined in Illuminate\Console\Command. Call another console command silently.
  • public string choice(string $question, array $choices, string|null $default=NULL, mixed|null $attempts=NULL, bool|null $multiple=NULL) - defined in Illuminate\Console\Command. Give the user a single choice from an array of answers.
  • public void comment(string $string, int|string|null $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, int|string|null $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|null getApplication() - defined in Symfony\Component\Console\Command\Command. Gets the application instance for this command.
  • public static string|null getDefaultName() - defined in Symfony\Component\Console\Command\Command. Returns the default command name or null when no default name is set
  • 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|null 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|null 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 Illuminate\Console\OutputStyle 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 void handle() - defined in October\Rain\Scaffold\GeneratorCommand. handle executes the console 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, int|string|null $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 void isHidden() - defined in Illuminate\Console\Command. {@inheritdoc}.
  • public void line(string $string, string|null $style=NULL, int|string|null $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 makeStub($stubName) - defined in October\Rain\Scaffold\GeneratorCommand. makeStub makes a single stub.
  • public void makeStubs() - defined in October\Rain\Scaffold\GeneratorCommand. makeStubs makes all stubs.
  • 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, bool $replace=true) - defined in Illuminate\Console\Command. Mix another object into the class.
  • public string|array|bool|null option(string|null $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, int|string|null $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 mixed 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=NULL) - defined in Symfony\Component\Console\Command\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) - defined in Symfony\Component\Console\Command\Command.
  • public void setHidden($hidden) - defined in Illuminate\Console\Command. {@inheritdoc}.
  • public void setInput(Symfony\Component\Console\Input\InputInterface $input) - defined in Illuminate\Console\Command. Set the input interface implementation.
  • 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 void setOutput(Illuminate\Console\OutputStyle $output) - defined in Illuminate\Console\Command. Set the output interface implementation.
  • 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, int|string|null $verbosity=NULL) - defined in Illuminate\Console\Command. Write a string as warning output.

Protected methods

protected void getArguments()

getArguments get the console command arguments

protected void getOptions()

getOptions get the console command options

protected void prepareVars()

prepareVars prepares variables for stubs

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 array context() - defined in Illuminate\Console\Command. Get all of the context passed to the command.
  • 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 getDestinationPath() - defined in October\Rain\Scaffold\GeneratorCommand. getDestinationPath gets the plugin path from the input.
  • protected void getPluginInput() - defined in October\Rain\Scaffold\GeneratorCommand. getPluginInput gets the desired plugin name from the input.
  • protected void getSourcePath() - defined in October\Rain\Scaffold\GeneratorCommand. getSourcePath gets the source file path.
  • protected void initialize($input, $output) - defined in Symfony\Component\Console\Command\Command. Initializes the command after the input has been bound and before the input.
  • protected void interact($input, $output) - defined in Symfony\Component\Console\Command\Command. Interacts with the user.
  • protected void makeDirectory($path) - defined in October\Rain\Scaffold\GeneratorCommand. makeDirectory builds the directory for the class if necessary.
  • protected void modifyString($type, $string) - defined in October\Rain\Scaffold\GeneratorCommand. modifyString is an internal helper that handles modify a string, with extra logic.
  • protected int parseVerbosity(string|int|null $level=NULL) - defined in Illuminate\Console\Command. Get the verbosity level in terms of Symfony's OutputInterface level.
  • protected void processVars($vars) - defined in October\Rain\Scaffold\GeneratorCommand. processVars converts all variables to available modifier and case formats.
  • protected Symfony\Component\Console\Command\Command resolveCommand(Symfony\Component\Console\Command\Command|string $command) - defined in Illuminate\Console\Command. Resolve the console command instance for the given command.
  • protected int runCommand(Symfony\Component\Console\Command\Command|string $command, array $arguments, Symfony\Component\Console\Output\OutputInterface $output) - defined in Illuminate\Console\Command. Run the given the console command.
  • 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.