\Charcoal\SourceOrderInterface

Summary

Methods

Constants

setData()
setProperty()
property()
setMode()
mode()
setValues()
values()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

setData()

setData(array  $data) : \Charcoal\Source\Order

Parameters

array

$data

The order data.

Returns

\Charcoal\Source\Order —

Chainable

setProperty()

setProperty(string  $property) : \Charcoal\Source\Order

Parameters

string

$property

The property to order with.

Returns

\Charcoal\Source\Order —

(Chainable)

property()

property() : string

Returns

string

setMode()

setMode(string  $mode) : \Charcoal\Source\Order

Parameters

string

$mode

The order mode.

Returns

\Charcoal\Source\Order —

Chainable

mode()

mode() : string

Returns

string

setValues()

setValues(string|array  $values) : \Charcoal\Source\Order

Set the values.

Values are ignored if the mode is not "values"

If the $values argument is a string, it will be split by ",". If it is an array, the values will be used as is. Otherwise, the function will throw an error

Parameters

string|array

$values

The order values.

Returns

\Charcoal\Source\Order —

(Chainable)

values()

values() : array

Returns

array