Part
extends ArrayObject
in package
Message part object class
Tags
Table of Contents
- $data : array<string|int, mixed>
- Array data
- __construct() : mixed
- Constructor
- __get() : mixed
- Get a value
- __isset() : bool
- Is value set
- __set() : ArrayObject
- Set a value
- __unset() : void
- Unset a value
- count() : int
- Method to get the count of the array object
- createFromJson() : ArrayObject
- Create array object from JSON string
- createFromSerialized() : ArrayObject
- Create array object from serialized string
- getIterator() : ArrayIterator
- Method to iterate over the array object
- jsonSerialize() : string
- JSON serialize the array object
- jsonUnserialize() : ArrayObject
- Unserialize a JSON string
- offsetExists() : bool
- ArrayAccess offsetExists
- offsetGet() : mixed
- ArrayAccess offsetGet
- offsetSet() : void
- ArrayAccess offsetSet
- offsetUnset() : void
- ArrayAccess offsetUnset
- parse() : array<string|int, mixed>
- Parse message parts from string
- parseParts() : array<string|int, mixed>
- Parse message parts from array of parts
- serialize() : string
- Serialize the array object
- toArray() : array<string|int, mixed>
- Get the values as an array
- unserialize() : ArrayObject
- Unserialize a string
Properties
$data
Array data
protected
array<string|int, mixed>
$data
= []
Methods
__construct()
Constructor
public
__construct([mixed $data = null ]) : mixed
Instantiate the array object
Parameters
- $data : mixed = null
Tags
Return values
mixed —__get()
Get a value
public
__get(string $name) : mixed
Parameters
- $name : string
Return values
mixed —__isset()
Is value set
public
__isset(string $name) : bool
Parameters
- $name : string
Return values
bool —__set()
Set a value
public
__set(string $name, mixed $value) : ArrayObject
Parameters
- $name : string
- $value : mixed
Return values
ArrayObject —__unset()
Unset a value
public
__unset(string $name) : void
Parameters
- $name : string
Return values
void —count()
Method to get the count of the array object
public
count() : int
Return values
int —createFromJson()
Create array object from JSON string
public
static createFromJson(string $jsonString[, int $depth = 512 ], int $options) : ArrayObject
Parameters
- $jsonString : string
- $depth : int = 512
- $options : int
Return values
ArrayObject —createFromSerialized()
Create array object from serialized string
public
static createFromSerialized(string $string) : ArrayObject
Parameters
- $string : string
Return values
ArrayObject —getIterator()
Method to iterate over the array object
public
getIterator() : ArrayIterator
Return values
ArrayIterator —jsonSerialize()
JSON serialize the array object
public
jsonSerialize(int $options[, int $depth = 512 ]) : string
Parameters
- $options : int
- $depth : int = 512
Return values
string —jsonUnserialize()
Unserialize a JSON string
public
jsonUnserialize(string $jsonString[, int $depth = 512 ], int $options) : ArrayObject
Parameters
- $jsonString : string
- $depth : int = 512
- $options : int
Return values
ArrayObject —offsetExists()
ArrayAccess offsetExists
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
bool —offsetGet()
ArrayAccess offsetGet
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
Return values
mixed —offsetSet()
ArrayAccess offsetSet
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
Return values
void —offsetUnset()
ArrayAccess offsetUnset
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
Return values
void —parse()
Parse message parts from string
public
static parse(mixed $body[, string $boundary = null ]) : array<string|int, mixed>
Parameters
- $body : mixed
- $boundary : string = null
Return values
array<string|int, mixed> —parseParts()
Parse message parts from array of parts
public
static parseParts(array<string|int, mixed> $parts) : array<string|int, mixed>
Parameters
- $parts : array<string|int, mixed>
Return values
array<string|int, mixed> —serialize()
Serialize the array object
public
serialize([bool $self = false ]) : string
Parameters
- $self : bool = false
Return values
string —toArray()
Get the values as an array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —unserialize()
Unserialize a string
public
unserialize(string $string) : ArrayObject
Parameters
- $string : string