1. class
  2. Illuminate
  3. \
  4. Foundation
  5. \
  6. Console
  7. \
  8. CliDumper

CliDumper

class CliDumper extends CliDumper (View source)

Traits

ResolvesDumpSource

Properties

protected array<string, string> $editorHrefs

All of the href formats for common editors.

 from  ResolvesDumpSource
static protected array<string, int> $adjustableTraces

Files that require special trace handling and their levels.

 from  ResolvesDumpSource
static protected callable(): array{0: string, 1: string, 2: int|null}|null|null|false $dumpSourceResolver

The source resolver.

 from  ResolvesDumpSource
protected string $basePath

The base path of the application.
protected OutputInterface $output

The output instance.
protected string $compiledViewPath

The compiled view path for the application.
protected bool $dumping

If the dumper is currently dumping.

Methods

array{0: string, 1: string, 2: int|null}|null
resolveDumpSource()

Resolve the source of the dump call.

from  ResolvesDumpSource
bool
isCompiledViewFile(string $file)

Determine if the given file is a view compiled.

from  ResolvesDumpSource
string
getOriginalFileForCompiledView(string $file)

Get the original view compiled file by the given compiled file.

from  ResolvesDumpSource
string|null
resolveSourceHref(string $file, int|null $line)

Resolve the source href, if possible.

from  ResolvesDumpSource
static void
resolveDumpSourceUsing(callable(): array{0: string, 1: string, 2: int|null}|null|null $callable)

Set the resolver that resolves the source of the dump call.

from  ResolvesDumpSource
static void
dontIncludeSource()

Don't include the location / file of the dump in dumps.

from  ResolvesDumpSource
void
__construct(OutputInterface $output, string $basePath, string $compiledViewPath)

Create a new CLI dumper instance.

static void
register(string $basePath, string $compiledViewPath)

Create a new CLI dumper instance and register it as the default dumper.

void
dumpWithSource(Data $data)

Dump a variable with its source file / line.

string
getDumpSourceContent()

Get the dump's source console content.

bool
supportsColors()

{@inheritDoc}

Details

in ResolvesDumpSource at line 55
array{0: string, 1: string, 2: int|null}|null resolveDumpSource()

Resolve the source of the dump call.

Return Value

array{0: string, 1: string, 2: int|null}|null

in ResolvesDumpSource at line 120
protected bool isCompiledViewFile(string $file)

Determine if the given file is a view compiled.

Parameters

string $file

Return Value

bool

in ResolvesDumpSource at line 131
protected string getOriginalFileForCompiledView(string $file)

Get the original view compiled file by the given compiled file.

Parameters

string $file

Return Value

string

in ResolvesDumpSource at line 149
protected string|null resolveSourceHref(string $file, int|null $line)

Resolve the source href, if possible.

Parameters

string $file
int|null $line

Return Value

string|null

in ResolvesDumpSource at line 182
static void resolveDumpSourceUsing(callable(): array{0: string, 1: string, 2: int|null}|null|null $callable)

Set the resolver that resolves the source of the dump call.

Parameters

callable(): array{0: string, 1: string, 2: int|null}|null|null $callable

Return Value

void

in ResolvesDumpSource at line 192
static void dontIncludeSource()

Don't include the location / file of the dump in dumps.

Return Value

void

at line 53
void __construct(OutputInterface $output, string $basePath, string $compiledViewPath)

Create a new CLI dumper instance.

Parameters

OutputInterface $output
string $basePath
string $compiledViewPath

Return Value

void

at line 71
static void register(string $basePath, string $compiledViewPath)

Create a new CLI dumper instance and register it as the default dumper.

Parameters

string $basePath
string $compiledViewPath

Return Value

void

at line 86
void dumpWithSource(Data $data)

Dump a variable with its source file / line.

Parameters

Data $data

Return Value

void

at line 111
protected string getDumpSourceContent()

Get the dump's source console content.

Return Value

string

at line 132
protected bool supportsColors()

{@inheritDoc}

Return Value

bool

Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.