Documentation

Warning
in package

Encapsulates warnings produced by the library.

Warnings can be suppressed (individually or all) if required. Also it is possible to override warning handler (which is trigger_error() by default)

Table of Contents

ALL  = 63
WARNING_ASSIGN  = 2
WARNING_CONFIG  = 4
WARNING_CONFIG_DEPRECATION  = 16
WARNING_FULL_SCHEMA_SCAN  = 8
WARNING_NOT_A_TYPE  = 32
$enableWarnings  : int
$warned  : array<string|int, mixed>
$warningHandler  : callable|null
enable()  : void
Re-enable previously suppressed warning by id
setWarningHandler()  : void
Sets warning handler which can intercept all system warnings.
suppress()  : void
Suppress warning by id (has no effect when custom warning handler is set)
warn()  : void
warnOnce()  : void

Constants

WARNING_ASSIGN

public mixed WARNING_ASSIGN = 2

WARNING_CONFIG

public mixed WARNING_CONFIG = 4

WARNING_CONFIG_DEPRECATION

public mixed WARNING_CONFIG_DEPRECATION = 16

WARNING_FULL_SCHEMA_SCAN

public mixed WARNING_FULL_SCHEMA_SCAN = 8

WARNING_NOT_A_TYPE

public mixed WARNING_NOT_A_TYPE = 32

Properties

$enableWarnings

private static int $enableWarnings = self::ALL

$warned

private static array<string|int, mixed> $warned = []

$warningHandler

private static callable|null $warningHandler

Methods

enable()

Re-enable previously suppressed warning by id

public static enable([bool|int $enable = true ]) : void

Usage example: Warning::suppress(Warning::WARNING_NOT_A_TYPE)

When passing true - re-enables all warnings.

Parameters
$enable : bool|int = true
Return values
void —

setWarningHandler()

Sets warning handler which can intercept all system warnings.

public static setWarningHandler([callable|null $warningHandler = null ]) : void

When not set, trigger_error() is used to notify about warnings.

Parameters
$warningHandler : callable|null = null
Return values
void —

suppress()

Suppress warning by id (has no effect when custom warning handler is set)

public static suppress([bool|int $suppress = true ]) : void

Usage example: Warning::suppress(Warning::WARNING_NOT_A_TYPE)

When passing true - suppresses all warnings.

Parameters
$suppress : bool|int = true
Return values
void —

warn()

public static warn(string $errorMessage, int $warningId[, int|null $messageLevel = null ]) : void
Parameters
$errorMessage : string
$warningId : int
$messageLevel : int|null = null
Return values
void —

warnOnce()

public static warnOnce(string $errorMessage, int $warningId[, int|null $messageLevel = null ]) : void
Parameters
$errorMessage : string
$warningId : int
$messageLevel : int|null = null
Return values
void —

Search results