Controller
Class Controller
Table of Contents
Constants
- DESC_AUTH = 'AUTH_ERROR'
- DESC_UNKNOWN_USER = 'UNKNOWN_USER'
- DESC_UNROUTEABLE = 'UNROUTEABLE'
- STATUS_BOUNCED = 'bounced'
- STATUS_DEFERED = 'defered'
- STATUS_DELIVERED = 'delivered'
Methods
- __construct() : mixed
- Controller constructor.
- decreaseLimit() : void
- Decrease limits.
- enableItemErrors() : $this
- Enable item errors.
- getCounters() : array<string|int, mixed>
- Get counters
- giveAnswer() : void
- Give answer.
- isBlacklistable() : bool
- Return true if status descriptions is blacklistable.
- isStatusError() : bool
- Return true if status is error.
- isStatusPermanentError() : bool
- Return true if status is permanent error.
- processItem() : bool
- Process item.
- processList() : void
- Process list.
- run() : void
- Run controller.
Constants
DESC_AUTH
public
mixed
DESC_AUTH
= 'AUTH_ERROR'
DESC_UNKNOWN_USER
public
mixed
DESC_UNKNOWN_USER
= 'UNKNOWN_USER'
DESC_UNROUTEABLE
public
mixed
DESC_UNROUTEABLE
= 'UNROUTEABLE'
STATUS_BOUNCED
public
mixed
STATUS_BOUNCED
= 'bounced'
STATUS_DEFERED
public
mixed
STATUS_DEFERED
= 'defered'
STATUS_DELIVERED
public
mixed
STATUS_DELIVERED
= 'delivered'
Methods
__construct()
Controller constructor.
public
__construct() : mixed
decreaseLimit()
Decrease limits.
public
decreaseLimit() : void
enableItemErrors()
Enable item errors.
public
enableItemErrors() : $this
Return values
$thisgetCounters()
Get counters
public
getCounters() : array<string|int, mixed>
Return values
array<string|int, mixed>giveAnswer()
Give answer.
public
static giveAnswer([bool $isError = false ][, string|array<string|int, mixed>|null $answer = null ]) : void
Parameters
- $isError : bool = false
-
Data.
- $answer : string|array<string|int, mixed>|null = null
-
Answer.
isBlacklistable()
Return true if status descriptions is blacklistable.
public
static isBlacklistable(string $description) : bool
Parameters
- $description : string
-
Description.
Return values
boolisStatusError()
Return true if status is error.
public
static isStatusError(string $status) : bool
Parameters
- $status : string
-
Status.
Return values
boolisStatusPermanentError()
Return true if status is permanent error.
public
static isStatusPermanentError(string $status) : bool
Parameters
- $status : string
-
Status.
Return values
boolprocessItem()
Process item.
public
processItem(array<string|int, mixed> $item) : bool
Parameters
- $item : array<string|int, mixed>
-
Item data.
Tags
Return values
boolprocessList()
Process list.
public
processList(array<string|int, mixed> $list) : void
Parameters
- $list : array<string|int, mixed>
-
List of items.
Tags
run()
Run controller.
public
static run([string $data = null ][, array<string|int, mixed> $parameters = [] ]) : void
Parameters
- $data : string = null
-
Data.
- $parameters : array<string|int, mixed> = []
-
Parameters.