1. interface
  2. Alligator
  3. \
  4. Model
  5. \
  6. OrderBundle
  7. \
  8. Entity
  9. \
  10. AdjustmentInterface

AdjustmentInterface

interface AdjustmentInterface

Interface AdjustmentInterface

Methods

AdjustableInterface
getAdjustable()

Get adjustment subject.

setAdjustable(AdjustableInterface $adjustable = null)

Set adjustable.

string
getLabel()

Get the label.

setLabel(string $label)

Set label.

string
getDescription()

Get short description of adjustment.

setDescription(string $description)

Set short description of adjustment.

int
getAmount()

Get the adjustment amount.

setAmount(int $amount)

Set the amount.

bool
isNeutral()

Is adjustment neutral?

setNeutral(bool $neutral)

Modify the neutrality of the adjustment.

bool
isCharge()

Is charge?

bool
isCredit()

Is credit?

bool
isLocked()

Is adjustment locked?

lock()

Lock the adjustment.

unlock()

Unlock the adjustment.

Details

at line 23
AdjustableInterface getAdjustable()

Get adjustment subject.

Return Value

AdjustableInterface

at line 30
setAdjustable(AdjustableInterface $adjustable = null)

Set adjustable.

Parameters

AdjustableInterface $adjustable

at line 37
string getLabel()

Get the label.

Return Value

string

at line 44
setLabel(string $label)

Set label.

Parameters

string $label

at line 51
string getDescription()

Get short description of adjustment.

Return Value

string

at line 58
setDescription(string $description)

Set short description of adjustment.

Parameters

string $description

at line 65
int getAmount()

Get the adjustment amount.

Return Value

int

at line 72
setAmount(int $amount)

Set the amount.

Parameters

int $amount

at line 79
bool isNeutral()

Is adjustment neutral?

Return Value

bool

at line 86
setNeutral(bool $neutral)

Modify the neutrality of the adjustment.

Parameters

bool $neutral

at line 95
bool isCharge()

Is charge?

Adjustments with amount < 0 are called "charges".

Return Value

bool

at line 104
bool isCredit()

Is credit?

Adjustments with amount > 0 are called "credits".

Return Value

bool

at line 111
bool isLocked()

Is adjustment locked?

Return Value

bool

at line 116
lock()

Lock the adjustment.

at line 121
unlock()

Unlock the adjustment.