interface DMSCartBackendInterface (View source)

Interface DMSCartBackendInterface represents the contract for a Session Backend

Methods

public
array
getItems()

Get all the DMSRequestItem objects serialized in the cart.

public
getItem(int $id)

Returns a single element from the items list

public
addItem(DMSRequestItem $item)

Add an DMSRequestItem object into the cart.

public
removeItem(DMSRequestItem $item)

Remove a DMSRequestItem object from the cart.

public
removeItemByID(int $itemID)

Removes a DMSRequestItem from the cart by it's id

public
emptyCart()

Flushes the cart

public
setBackUrl(string $backURL)

Set the backURL to be a Session variable for the current Document Cart

public
string
getBackUrl()

Returns the backURL for the current Document Cart

public
setReceiverInfo(array $receiverInfo = array())

Sets the recipients information

public
array
getReceiverInfo()

Retrieves the recipients info

Details

array getItems()

Get all the DMSRequestItem objects serialized in the cart.

Return Value

array

DMSRequestItem|bool getItem(int $id)

Returns a single element from the items list

Parameters

int $id

Return Value

DMSRequestItem|bool

DMSCartBackendInterface addItem(DMSRequestItem $item)

Add an DMSRequestItem object into the cart.

Parameters

DMSRequestItem $item

Return Value

DMSCartBackendInterface

DMSCartBackendInterface removeItem(DMSRequestItem $item)

Remove a DMSRequestItem object from the cart.

Parameters

DMSRequestItem $item

Return Value

DMSCartBackendInterface

DMSCartBackendInterface removeItemByID(int $itemID)

Removes a DMSRequestItem from the cart by it's id

Parameters

int $itemID

Return Value

DMSCartBackendInterface

DMSCartBackendInterface emptyCart()

Flushes the cart

DMSCartBackendInterface setBackUrl(string $backURL)

Set the backURL to be a Session variable for the current Document Cart

Parameters

string $backURL

Return Value

DMSCartBackendInterface

string getBackUrl()

Returns the backURL for the current Document Cart

Return Value

string

DMSCartBackendInterface setReceiverInfo(array $receiverInfo = array())

Sets the recipients information

Parameters

array $receiverInfo

Return Value

DMSCartBackendInterface

array getReceiverInfo()

Retrieves the recipients info

Return Value

array