API Documentation

ValidationResult
in package

Table of Contents

Constants

FAILED  = 2
PASSED  = 0
SKIPPED  = 1

Properties

$message  : string
$passed  : bool
$skipped  : bool
$tip  : string

Methods

__construct()  : mixed
fail()  : static
failed()  : bool
formattedMessage()  : string
message()  : string
pass()  : static
passed()  : bool
skip()  : static
skipped()  : bool
statusCode()  : int
tip()  : string|false
withTip()  : static
formatFailed()  : string
formatPassed()  : string
formatResult()  : string
formatSkipped()  : string
formatTimeString()  : string
formatTip()  : string
withMessage()  : static

Constants

Properties

Methods

__construct()

public __construct([string $defaultMessage = 'Generic check' ]) : mixed
Parameters
$defaultMessage : string = 'Generic check'

fail()

public fail([string|null $withMessage = null ]) : static
Parameters
$withMessage : string|null = null
Return values
static

formattedMessage()

public formattedMessage([string|null $withTimeString = null ]) : string
Parameters
$withTimeString : string|null = null
Return values
string

pass()

public pass([string|null $withMessage = null ]) : static
Parameters
$withMessage : string|null = null
Return values
static

skip()

public skip([string|null $withMessage = null ]) : static
Parameters
$withMessage : string|null = null
Return values
static

withTip()

public withTip(string $withTip) : static
Parameters
$withTip : string
Return values
static

formatFailed()

protected formatFailed(string $message) : string
Parameters
$message : string
Return values
string

formatPassed()

protected formatPassed(string $message) : string
Parameters
$message : string
Return values
string

formatResult()

protected formatResult(string $message) : string
Parameters
$message : string
Return values
string

formatSkipped()

protected formatSkipped(string $message) : string
Parameters
$message : string
Return values
string

formatTimeString()

protected formatTimeString(string $time) : string
Parameters
$time : string
Return values
string

formatTip()

protected formatTip(string $tip) : string
Parameters
$tip : string
Return values
string

withMessage()

protected withMessage(string|null $withMessage) : static
Parameters
$withMessage : string|null
Return values
static 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results