VendorPublishCommand

class VendorPublishCommand extends Command (View source)

Properties

protected Application $laravel The Laravel application instance. from Command
protected InputInterface $input The input interface implementation. from Command
protected OutputStyle $output The output interface implementation. from Command
protected string $signature The console command signature.
protected string $name The console command name. from Command
protected string $description The console command description.
protected bool $hidden Indicates whether the command should be shown in the Artisan command list. from Command
protected int $verbosity The default verbosity of output commands. from Command
protected array $verbosityMap The mapping between human readable verbosity levels and Symfony's OutputInterface. from Command
protected Filesystem $files The filesystem instance.

Methods

void __construct(Filesystem $files)

Create a new command instance.

void configureUsingFluentDefinition()

Configure the console command using a fluent definition.

from Command
void specifyParameters()

Specify the arguments and options on the command.

from Command
int run(InputInterface $input, OutputInterface $output)

Run the console command.

from Command
mixed execute(InputInterface $input, OutputInterface $output)

Execute the console command.

from Command
int call(string $command, array $arguments = [])

Call another console command.

from Command
int callSilent(string $command, array $arguments = [])

Call another console command silently.

from Command
bool hasArgument(string|int $name)

Determine if the given argument is present.

from Command
string|array argument(string|null $key = null)

Get the value of a command argument.

from Command
array arguments()

Get all of the arguments passed to the command.

from Command
bool hasOption(string $name)

Determine if the given option is present.

from Command
string|array option(string $key = null)

Get the value of a command option.

from Command
array options()

Get all of the options passed to the command.

from Command
bool confirm(string $question, bool $default = false)

Confirm a question with the user.

from Command
string ask(string $question, string $default = null)

Prompt the user for input.

from Command
string anticipate(string $question, array $choices, string $default = null)

Prompt the user for input with auto completion.

from Command
string askWithCompletion(string $question, array $choices, string $default = null)

Prompt the user for input with auto completion.

from Command
string secret(string $question, bool $fallback = true)

Prompt the user for input but hide the answer from the console.

from Command
string choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null)

Give the user a single choice from an array of answers.

from Command
void table(array $headers, Arrayable|array $rows, string $style = 'default')

Format input to textual table.

from Command
void info(string $string, null|int|string $verbosity = null)

Write a string as information output.

from Command
void line(string $string, string $style = null, null|int|string $verbosity = null)

Write a string as standard output.

from Command
void comment(string $string, null|int|string $verbosity = null)

Write a string as comment output.

from Command
void question(string $string, null|int|string $verbosity = null)

Write a string as question output.

from Command
void error(string $string, null|int|string $verbosity = null)

Write a string as error output.

from Command
void warn(string $string, null|int|string $verbosity = null)

Write a string as warning output.

from Command
void alert(string $string)

Write a string in an alert box.

from Command
void setVerbosity(string|int $level)

Set the verbosity level.

from Command
int parseVerbosity(string|int $level = null)

Get the verbosity level in terms of Symfony's OutputInterface level.

from Command
array getArguments()

Get the console command arguments.

from Command
array getOptions()

Get the console command options.

from Command
OutputInterface getOutput()

Get the output implementation.

from Command
Application getLaravel()

Get the Laravel application instance.

from Command
void setLaravel(Container $laravel)

Set the Laravel application instance.

from Command
void fire()

Execute the console command.

mixed publishTag(string $tag)

Publishes the assets for a tag.

array pathsToPublish(string $tag)

Get all of the paths to publish.

void publishItem(string $from, string $to)

Publish the given item from and to the given location.

void publishFile(string $from, string $to)

Publish the file to the given path.

void publishDirectory(string $from, string $to)

Publish the directory to the given directory.

void moveManagedFiles(MountManager $manager)

Move all the files in the given MountManager.

void createParentDirectory(string $directory)

Create the directory to house the published files if needed.

void status(string $from, string $to, string $type)

Write a status message to the console.

Details

void __construct(Filesystem $files)

Create a new command instance.

Parameters

Filesystem $files

Return Value

void

protected void configureUsingFluentDefinition()

Configure the console command using a fluent definition.

Return Value

void

protected void specifyParameters()

Specify the arguments and options on the command.

Return Value

void

int run(InputInterface $input, OutputInterface $output)

Run the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

protected mixed execute(InputInterface $input, OutputInterface $output)

Execute the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

mixed

int call(string $command, array $arguments = [])

Call another console command.

Parameters

string $command
array $arguments

Return Value

int

int callSilent(string $command, array $arguments = [])

Call another console command silently.

Parameters

string $command
array $arguments

Return Value

int

bool hasArgument(string|int $name)

Determine if the given argument is present.

Parameters

string|int $name

Return Value

bool

string|array argument(string|null $key = null)

Get the value of a command argument.

Parameters

string|null $key

Return Value

string|array

array arguments()

Get all of the arguments passed to the command.

Return Value

array

bool hasOption(string $name)

Determine if the given option is present.

Parameters

string $name

Return Value

bool

string|array option(string $key = null)

Get the value of a command option.

Parameters

string $key

Return Value

string|array

array options()

Get all of the options passed to the command.

Return Value

array

bool confirm(string $question, bool $default = false)

Confirm a question with the user.

Parameters

string $question
bool $default

Return Value

bool

string ask(string $question, string $default = null)

Prompt the user for input.

Parameters

string $question
string $default

Return Value

string

string anticipate(string $question, array $choices, string $default = null)

Prompt the user for input with auto completion.

Parameters

string $question
array $choices
string $default

Return Value

string

string askWithCompletion(string $question, array $choices, string $default = null)

Prompt the user for input with auto completion.

Parameters

string $question
array $choices
string $default

Return Value

string

string secret(string $question, bool $fallback = true)

Prompt the user for input but hide the answer from the console.

Parameters

string $question
bool $fallback

Return Value

string

string choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null)

Give the user a single choice from an array of answers.

Parameters

string $question
array $choices
string $default
mixed $attempts
bool $multiple

Return Value

string

void table(array $headers, Arrayable|array $rows, string $style = 'default')

Format input to textual table.

Parameters

array $headers
Arrayable|array $rows
string $style

Return Value

void

void info(string $string, null|int|string $verbosity = null)

Write a string as information output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

void line(string $string, string $style = null, null|int|string $verbosity = null)

Write a string as standard output.

Parameters

string $string
string $style
null|int|string $verbosity

Return Value

void

void comment(string $string, null|int|string $verbosity = null)

Write a string as comment output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

void question(string $string, null|int|string $verbosity = null)

Write a string as question output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

void error(string $string, null|int|string $verbosity = null)

Write a string as error output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

void warn(string $string, null|int|string $verbosity = null)

Write a string as warning output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

void alert(string $string)

Write a string in an alert box.

Parameters

string $string

Return Value

void

protected void setVerbosity(string|int $level)

Set the verbosity level.

Parameters

string|int $level

Return Value

void

protected int parseVerbosity(string|int $level = null)

Get the verbosity level in terms of Symfony's OutputInterface level.

Parameters

string|int $level

Return Value

int

protected array getArguments()

Get the console command arguments.

Return Value

array

protected array getOptions()

Get the console command options.

Return Value

array

OutputInterface getOutput()

Get the output implementation.

Return Value

OutputInterface

Application getLaravel()

Get the Laravel application instance.

Return Value

Application

void setLaravel(Container $laravel)

Set the Laravel application instance.

Parameters

Container $laravel

Return Value

void

void fire()

Execute the console command.

Return Value

void

protected mixed publishTag(string $tag)

Publishes the assets for a tag.

Parameters

string $tag

Return Value

mixed

protected array pathsToPublish(string $tag)

Get all of the paths to publish.

Parameters

string $tag

Return Value

array

protected void publishItem(string $from, string $to)

Publish the given item from and to the given location.

Parameters

string $from
string $to

Return Value

void

protected void publishFile(string $from, string $to)

Publish the file to the given path.

Parameters

string $from
string $to

Return Value

void

protected void publishDirectory(string $from, string $to)

Publish the directory to the given directory.

Parameters

string $from
string $to

Return Value

void

protected void moveManagedFiles(MountManager $manager)

Move all the files in the given MountManager.

Parameters

MountManager $manager

Return Value

void

protected void createParentDirectory(string $directory)

Create the directory to house the published files if needed.

Parameters

string $directory

Return Value

void

protected void status(string $from, string $to, string $type)

Write a status message to the console.

Parameters

string $from
string $to
string $type

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Foundation/Console/VendorPublishCommand.html