CoolCMS API

OrderGift extends BaseEntity
in package
implements IdentifiableInterface uses IdentifiableTrait

AbstractYes

Snapshot of a gift on an order: only name and amount; it does not enter `total_price`. The gift is a reference only (`SET NULL`).

Tags
template
Attributes
#[MappedSuperclass]
#[TableAlias]
$alias: 'orderGift'

Table of Contents

Interfaces

IdentifiableInterface
Entity with a simple integer primary key. Most entities have one (often via {@see \App\Core\Traits\Shared\Models\Entities\IdentifiableTrait}); texts and links with a composite key do not, which is why `getId()` is not on {@see \App\Core\Base\BaseEntity}. Code that needs the id of a generic entity asks for this interface (parameter type, template bound, `instanceof`).

Properties

$amount  : int
$gift  : TGift|null
$id  : int|null
$name  : string
$order  : TOrder|null

Methods

__construct()  : mixed
callInitMethods()  : void
Calls `init{TraitName}()` for every used trait that defines such a method.
getAllTraits()  : array<string, string>
Returns all traits the class uses, including those used by parent classes and nested traits.
getAmount()  : int
getGift()  : TGift|null
getId()  : int|null
getName()  : string
getOrder()  : TOrder|null
isPersisted()  : bool
setAmount()  : $this
setGift()  : $this
setId()  : $this
setName()  : $this
setOrder()  : $this
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

$amount

protected int $amount = 1
Attributes
#[Column]
$name: 'amount'
$type: 'integer'
$options: ['unsigned' => true]

$id

protected int|null $id = null
Attributes
#[Column]
$name: 'order_gift_id'
$type: 'bigint'
$options: ['unsigned' => true]
#[GeneratedValue]
#[Id]

$name

protected string $name = ''
Attributes
#[Column]
$name: 'name'
$type: 'string'
$length: 255

Methods

__construct()

public __construct([int|null $id = null ][, mixed $order = null ][, mixed $gift = null ][, string $name = '' ][, int $amount = 1 ]) : mixed
Parameters
$id : int|null = null
$order : mixed = null
$gift : mixed = null
$name : string = ''
$amount : int = 1

callInitMethods()

Calls `init{TraitName}()` for every used trait that defines such a method.

public callInitMethods() : void

getAllTraits()

Returns all traits the class uses, including those used by parent classes and nested traits.

public getAllTraits() : array<string, string>
Return values
array<string, string>

getAmount()

public getAmount() : int
Return values
int

getGift()

public getGift() : TGift|null
Return values
TGift|null

getName()

public getName() : string
Return values
string

getOrder()

public getOrder() : TOrder|null
Return values
TOrder|null

setAmount()

public setAmount(int $amount) : $this
Parameters
$amount : int
Return values
$this

setGift()

public setGift(TGift|null $gift) : $this
Parameters
$gift : TGift|null
Return values
$this

setId()

public setId(int|null $id) : $this
Parameters
$id : int|null
Return values
$this

setName()

public setName(string $name) : $this
Parameters
$name : string
Return values
$this

setOrder()

public setOrder(TOrder|null $order) : $this
Parameters
$order : TOrder|null
Return values
$this

getTraitsRecursive()

Walks the trait list recursively and collects nested traits too.

private static getTraitsRecursive(array<string, string> $traits) : array<string, string>
Parameters
$traits : array<string, string>
Return values
array<string, string>
On this page

Search results