\Pivot\QueueQueuePayload

Generic config needs

Summary

Methods

Properties

Constants

__construct()
setConfig()
getConfig()
getProperty()
addConfig()
serialize()
unserialize()
setPayload()
getPayload()
addPayload()
setData()
getData()
addData()

No public properties found

No constants found

No protected methods found

$configuration

N/A

No private methods found

No private properties found

N/A

File: src/Modules/Queue/src/QueuePayload.php
Package: Default
Class hierarchy: \Pivot\Core\Configuration\Config

\Pivot\Queue\QueuePayload

Properties

$configuration

$configuration : array

The raw configuration var.

Type

array

Methods

__construct()

__construct(array  $array = array())

Setup with an empty array or passed data

Parameters

array

$array

setConfig()

setConfig(array  $array)

Set the config property

Parameters

array

$array

config

getConfig()

getConfig() : array

Get all stored configuration

Returns

array —

config

getProperty()

getProperty(  $prop) : mixed

Get a top-level key value

Parameters

$prop

Returns

mixed —

key value

addConfig()

addConfig(array  $array)

Add configuration to the existing config. This runs a array_replace_recursive

Parameters

array

$array

Config to be added

serialize()

serialize() : \Pivot\Core\Configuration\config

Make sure we can store this object

Returns

\Pivot\Core\Configuration\config —

array

unserialize()

unserialize(array  $data) : void

Make sure we can hydrate this object

Parameters

array

$data

unserialize data

setPayload()

setPayload(array  $array)

Parameters

array

$array

getPayload()

getPayload()

addPayload()

addPayload(array  $array)

Parameters

array

$array

setData()

setData(array  $array)

Parameters

array

$array

getData()

getData()

addData()

addData(array  $array)

Parameters

array

$array