W3cubDocs

/Laravel 11

Task

class Task extends Component (View source)

Traits

InteractsWithTime

Properties

protected OutputStyle $output

The output style implementation.

 from Component
protected $mutators

The list of mutators to apply on the view data.

 from Component

Methods

void __construct(OutputStyle $output)

Creates a new component instance.

 from Component
void renderView(string $view, Arrayable|array $data, int $verbosity)

Renders the given view.

 from Component
void compile(string $view, array $data)

Compile the given view contents.

 from Component
array<int,string>|string mutate(array<int,string>|string $data, $mutators)

Mutates the given data with the given set of mutators.

 from Component
mixed usingQuestionHelper(callable $callable)

Eventually performs a question using the component's question helper.

 from Component
int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

 from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

 from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

 from InteractsWithTime
int currentTime()

Get the current system time as a UNIX timestamp.

 from InteractsWithTime
string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

 from InteractsWithTime
render($description, $task = null, $verbosity = OutputInterface::VERBOSITY_NORMAL)

No description

Details

void __construct(OutputStyle $output)

Creates a new component instance.

Parameters

OutputStyle $output

Return Value

void

protected void renderView(string $view, Arrayable|array $data, int $verbosity)

Renders the given view.

Parameters

string $view
Arrayable|array $data
int $verbosity

Return Value

void

protected void compile(string $view, array $data)

Compile the given view contents.

Parameters

string $view
array $data

Return Value

void

protected array<int,string>|string mutate(array<int,string>|string $data, $mutators)

Mutates the given data with the given set of mutators.

Parameters

array<int,string>|string $data
$mutators

Return Value

array<int,string>|string

protected mixed usingQuestionHelper(callable $callable)

Eventually performs a question using the component's question helper.

Parameters

callable $callable

Return Value

mixed

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

Parameters

float $startTime
float $endTime

Return Value

string

render($description, $task = null, $verbosity = OutputInterface::VERBOSITY_NORMAL)

No description

Parameters

$description
$task
$verbosity

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Console/View/Components/Task.html