laravel-audit

CheckResult
in package

Result returned from the check, used to construct the report.

Table of Contents

Properties

$group  : string|null
$message  : string|null
$name  : string|null
$state  : CheckState

Methods

__construct()  : mixed
fatal()  : self
Creates a result that has the state fatal with a description.
group()  : self
Creates a new result and replaces the group.
info()  : self
Creates a result that has the state info with a description.
message()  : self
Creates a new result and replaces the message.
name()  : self
Creates a new result and replaces the name.
state()  : self
Creates a new result and replaces the state.
success()  : self
Creates a result that has the state success.
warning()  : self
Creates a result that has the state warning with a description.

Properties

Methods

__construct()

public __construct(CheckState $state[, string|null $message = null ][, string|null $name = null ][, string|null $group = null ]) : mixed
Parameters
$state : CheckState

state that describes the urgency to change something

$message : string|null = null

additional information

$name : string|null = null

name of the check

$group : string|null = null

group of the check

fatal()

Creates a result that has the state fatal with a description.

public static fatal(string $message) : self
Parameters
$message : string
Return values
self

group()

Creates a new result and replaces the group.

public group(string $group) : self
Parameters
$group : string
Return values
self

info()

Creates a result that has the state info with a description.

public static info(string $message) : self
Parameters
$message : string
Return values
self

message()

Creates a new result and replaces the message.

public message(string $message) : self
Parameters
$message : string
Return values
self

name()

Creates a new result and replaces the name.

public name(string $name) : self
Parameters
$name : string
Return values
self

success()

Creates a result that has the state success.

public static success() : self
Return values
self

warning()

Creates a result that has the state warning with a description.

public static warning(string $message) : self
Parameters
$message : string
Return values
self

        
On this page

Search results