BlacklistResult
in package
Class BlacklistResult
This class represents the result of a blocklist operation
Table of Contents
Properties
- $blacklisted : bool
- $messages : array<string|int, string>
Methods
- __construct() : mixed
- appendMessage() : mixed
- getMessages() : array<string|int, string>
- isBlacklisted() : bool
- setBlacklisted() : void
- setMessages() : mixed
Properties
$blacklisted
private
bool
$blacklisted
the basic result of the operation
$messages
private
array<string|int, string>
$messages
an array of messages providing extra details
Methods
__construct()
public
__construct([bool $blacklisted = false ][, array<string|int, string>|string $messages = [''] ]) : mixed
Parameters
- $blacklisted : bool = false
- $messages : array<string|int, string>|string = ['']
appendMessage()
public
appendMessage(string $message) : mixed
Parameters
- $message : string
getMessages()
public
getMessages() : array<string|int, string>
Return values
array<string|int, string>isBlacklisted()
public
isBlacklisted() : bool
Return values
boolsetBlacklisted()
public
setBlacklisted(bool $blacklisted) : void
Parameters
- $blacklisted : bool
setMessages()
public
setMessages(array<string|int, string> $messages) : mixed
Parameters
- $messages : array<string|int, string>