AddressGroupPart
extends NameValuePart
in package
Holds a group of addresses and a group name.
Tags
Table of Contents
- $addresses : array<string|int, mixed>
- $canIgnoreSpacesAfter : bool
- $canIgnoreSpacesBefore : bool
- $charsetConverter : MbWrapper
- $children : array<string|int, HeaderPart>
- $isSpace : bool
- True if the part is a space token
- $logger : LoggerInterface
- $name : string
- $value : string
- $errors : array<string|int, mixed>
- $validated : bool
- __construct() : mixed
- Creates an AddressGroupPart out of the passed array of AddressParts/ AddressGroupParts and name.
- __toString() : string
- Returns the value of the part (which is a string).
- addError() : static
- Creates and adds an Error object to this ErrorBag.
- getAddress() : AddressPart|null
- Returns the AddressPart at the passed index or null.
- getAddresses() : array<string|int, AddressPart>
- Return the AddressGroupPart's array of addresses.
- getAllErrors() : array<string|int, Error>
- Returns any errors on this object, and all IErrorBag children of this object at or above the passed PSR log level from Psr\Log\LogLevel (defaulting to LogLevel::ERROR).
- getChildParts() : array<string|int, IHeaderPart>
- Returns the child parts this container part consists of.
- getComments() : array<string|int, CommentPart>
- Returns any CommentParts under this part container.
- getErrorLoggingContextName() : string
- Returns the class name. Override to identify objects in logs.
- getErrors() : array<string|int, Error>
- Returns any local errors this object has at or above the passed PSR log level in Psr\Log\LogLevel (defaulting to LogLevel::ERROR).
- getName() : string
- Returns the name of the name/value part.
- getValue() : string
- Returns the part's representative value after any necessary processing has been performed. For the raw value, call getRawValue().
- hasAnyErrors() : bool
- Returns true if there are errors on this object, or any IErrorBag child of this object at or above the passed PSR log level in Psr\Log\LogLevel (defaulting to LogLevel::ERROR). Note that this will stop after finding the first error and return, so may be slightly more performant if an error actually exists over calling getAllErrors if only interested in whether an error exists.
- hasErrors() : bool
- Returns true if this object has an error in its error bag at or above the passed $minPsrLevel (defaults to ERROR). If $validate is true, additional validation may be performed.
- convertEncoding() : string
- Ensures the encoding of the passed string is set to UTF-8.
- filterIgnoredSpaces() : array<string|int, HeaderPart>
- Filters out ignorable space tokens.
- getErrorBagChildren() : array<string|int, IErrorBag>
- Return any children ErrorBag objects.
- getNameFromParts() : string
- Creates the string 'name' representation of this part constructed from the child name parts passed to it.
- getValueFromParts() : string
- Creates the string value representation of this part constructed from the child parts passed to it.
- validate() : void
Properties
$addresses
protected
array<string|int, mixed>
$addresses
an array of AddressParts
$canIgnoreSpacesAfter
protected
bool
$canIgnoreSpacesAfter
= false
set to true to ignore spaces after this part
$canIgnoreSpacesBefore
protected
bool
$canIgnoreSpacesBefore
= false
set to true to ignore spaces before this part
$charsetConverter
protected
MbWrapper
$charsetConverter
the charset converter used for converting strings in HeaderPart::convertEncoding
$children
protected
array<string|int, HeaderPart>
$children
= []
parts that were used to create this part, collected for proper error reporting and validation.
$isSpace
True if the part is a space token
protected
bool
$isSpace
= false
$logger
protected
LoggerInterface
$logger
$name
protected
string
$name
the name of the part
$value
protected
string
$value
the representative value of the part after any conversion or processing has been done on it (e.g. removing new lines, converting, whatever else).
$errors
private
array<string|int, mixed>
$errors
= []
array of Error objects belonging to this object.
$validated
private
bool
$validated
= false
true once the object has been validated.
Methods
__construct()
Creates an AddressGroupPart out of the passed array of AddressParts/ AddressGroupParts and name.
public
__construct(LoggerInterface $logger, MbWrapper $charsetConverter, array<string|int, HeaderPart> $nameParts, array<string|int, AddressPart>|array<string|int, AddressGroupPart> $addressesAndGroupParts) : mixed
Parameters
- $logger : LoggerInterface
- $charsetConverter : MbWrapper
- $nameParts : array<string|int, HeaderPart>
- $addressesAndGroupParts : array<string|int, AddressPart>|array<string|int, AddressGroupPart>
Return values
mixed —__toString()
Returns the value of the part (which is a string).
public
__toString() : string
Return values
string —the value
addError()
Creates and adds an Error object to this ErrorBag.
public
addError(string $message, string $psrLogLevel[, Throwable|null $exception = null ]) : static
Parameters
- $message : string
- $psrLogLevel : string
- $exception : Throwable|null = null
Return values
static —getAddress()
Returns the AddressPart at the passed index or null.
public
getAddress(int $index) : AddressPart|null
Parameters
- $index : int
-
The 0-based index.
Return values
AddressPart|null —The address.
getAddresses()
Return the AddressGroupPart's array of addresses.
public
getAddresses() : array<string|int, AddressPart>
Return values
array<string|int, AddressPart> —An array of address parts.
getAllErrors()
Returns any errors on this object, and all IErrorBag children of this object at or above the passed PSR log level from Psr\Log\LogLevel (defaulting to LogLevel::ERROR).
public
getAllErrors([bool $validate = false ][, string $minPsrLevel = LogLevel::ERROR ]) : array<string|int, Error>
Care should be taken using this if the intention is to only 'preview' a message without parsing it entirely, since this will cause the whole message to be parsed as it traverses children, and could be slow on messages with large attachments, etc...
If $validate is true, additional validation may be performed on children to check for errors.
Parameters
- $validate : bool = false
- $minPsrLevel : string = LogLevel::ERROR
Return values
array<string|int, Error> —getChildParts()
Returns the child parts this container part consists of.
public
getChildParts() : array<string|int, IHeaderPart>
Return values
array<string|int, IHeaderPart> —getComments()
Returns any CommentParts under this part container.
public
getComments() : array<string|int, CommentPart>
Return values
array<string|int, CommentPart> —getErrorLoggingContextName()
Returns the class name. Override to identify objects in logs.
public
getErrorLoggingContextName() : string
Return values
string —getErrors()
Returns any local errors this object has at or above the passed PSR log level in Psr\Log\LogLevel (defaulting to LogLevel::ERROR).
public
getErrors([bool $validate = false ][, string $minPsrLevel = LogLevel::ERROR ]) : array<string|int, Error>
If $validate is true, additional validation may be performed on the object to check for errors.
Parameters
- $validate : bool = false
- $minPsrLevel : string = LogLevel::ERROR
Return values
array<string|int, Error> —getName()
Returns the name of the name/value part.
public
getName() : string
Return values
string —getValue()
Returns the part's representative value after any necessary processing has been performed. For the raw value, call getRawValue().
public
getValue() : string
Return values
string —The value of the part
hasAnyErrors()
Returns true if there are errors on this object, or any IErrorBag child of this object at or above the passed PSR log level in Psr\Log\LogLevel (defaulting to LogLevel::ERROR). Note that this will stop after finding the first error and return, so may be slightly more performant if an error actually exists over calling getAllErrors if only interested in whether an error exists.
public
hasAnyErrors([bool $validate = false ][, string $minPsrLevel = LogLevel::ERROR ]) : bool
Care should be taken using this if the intention is to only 'preview' a message without parsing it entirely, since this will cause the whole message to be parsed as it traverses children, and could be slow on messages with large attachments, etc...
If $validate is true, additional validation may be performed to check for errors.
Parameters
- $validate : bool = false
- $minPsrLevel : string = LogLevel::ERROR
Return values
bool —hasErrors()
Returns true if this object has an error in its error bag at or above the passed $minPsrLevel (defaults to ERROR). If $validate is true, additional validation may be performed.
public
hasErrors([bool $validate = false ][, string $minPsrLevel = LogLevel::ERROR ]) : bool
The PSR levels are defined in Psr\Log\LogLevel.
Parameters
- $validate : bool = false
- $minPsrLevel : string = LogLevel::ERROR
Return values
bool —convertEncoding()
Ensures the encoding of the passed string is set to UTF-8.
protected
convertEncoding(string $str[, string $from = 'ISO-8859-1' ][, bool $force = false ]) : string
The method does nothing if the passed $from charset is UTF-8 already, or if $force is set to false and mb_check_encoding for $str returns true for 'UTF-8'.
Parameters
- $str : string
- $from : string = 'ISO-8859-1'
- $force : bool = false
Return values
string —utf-8 string
filterIgnoredSpaces()
Filters out ignorable space tokens.
protected
filterIgnoredSpaces(array<string|int, HeaderPart> $parts) : array<string|int, HeaderPart>
Spaces are removed if parts on either side of it have their canIgnoreSpaceAfter/canIgnoreSpaceBefore properties set to true.
Parameters
- $parts : array<string|int, HeaderPart>
Return values
array<string|int, HeaderPart> —getErrorBagChildren()
Return any children ErrorBag objects.
protected
abstract getErrorBagChildren() : array<string|int, IErrorBag>
Return values
array<string|int, IErrorBag> —getNameFromParts()
Creates the string 'name' representation of this part constructed from the child name parts passed to it.
protected
getNameFromParts(array<string|int, HeaderParts> $parts) : string
Parameters
- $parts : array<string|int, HeaderParts>
Return values
string —getValueFromParts()
Creates the string value representation of this part constructed from the child parts passed to it.
protected
getValueFromParts(array<string|int, HeaderParts> $parts) : string
The default implementation filters out ignorable whitespace between parts, and concatenates parts calling 'getValue'.
Parameters
- $parts : array<string|int, HeaderParts>
Return values
string —validate()
protected
validate() : void