CoolCMS API

InvoiceVoucher extends BaseEntity
in package
implements IdentifiableInterface uses IdentifiableTrait

AbstractYes
Attributes
#[MappedSuperclass]
#[TableAlias]
$alias: 'invoiceVoucher'

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

$code  : string|null
$currencyId  : int|null
$id  : int|null
$invoiceId  : int|null
$name  : string|null
$percents  : int|null
$price  : string|null
$priceWithVat  : string|null
$relatedInvoiceVoucherId  : int|null
$vat  : float|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.
getCode()  : string|null
getCurrencyId()  : int|null
getId()  : int|null
getInvoiceId()  : int|null
getName()  : string|null
getPercents()  : int|null
getPrice()  : string|null
getPriceWithVat()  : string|null
getRelatedInvoiceVoucherId()  : int|null
getVat()  : float|null
isPersisted()  : bool
setCode()  : $this
setCurrencyId()  : $this
setId()  : $this
setInvoiceId()  : $this
setName()  : $this
setPercents()  : $this
setPrice()  : $this
setPriceWithVat()  : $this
setRelatedInvoiceVoucherId()  : $this
setVat()  : $this
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

$code

protected string|null $code = null
Attributes
#[Column]
$name: 'code'
$type: 'string'
$length: 255
$nullable: true

$currencyId

protected int|null $currencyId = null
Attributes
#[Column]
$name: 'cms_system_currencies_currency_id'
$type: 'integer'
$nullable: true
$options: ['unsigned' => true]

$id

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

$invoiceId

protected int|null $invoiceId = null
Attributes
#[Column]
$name: 'cms_mod_invoicer_invoices_invoice_id'
$type: 'integer'
$insertable: false
$updatable: false
$nullable: true
$options: ['unsigned' => true]

$name

protected string|null $name = null
Attributes
#[Column]
$name: 'name'
$type: 'string'
$length: 45
$nullable: true

$percents

protected int|null $percents = null
Attributes
#[Column]
$name: 'percents'
$type: 'integer'
$nullable: true

$price

protected string|null $price = null
Attributes
#[Column]
$name: 'price'
$type: 'decimal'
$precision: 10
$scale: 3
$nullable: true

$priceWithVat

protected string|null $priceWithVat = null
Attributes
#[Column]
$name: 'price_with_vat'
$type: 'decimal'
$precision: 10
$scale: 3
$nullable: true

$relatedInvoiceVoucherId

protected int|null $relatedInvoiceVoucherId = null
Attributes
#[Column]
$name: 'related_invoice_voucher_id'
$type: 'integer'
$nullable: true
$options: ['unsigned' => true]
#[ExternalReadonly]

$vat

protected float|null $vat = null
Attributes
#[Column]
$name: 'vat'
$type: 'float'
$nullable: true

Methods

__construct()

public __construct([int|null $id = null ][, int|null $invoiceId = null ][, int|null $currencyId = null ][, string|null $code = null ][, string|null $name = null ][, int|null $percents = null ][, string|null $price = null ][, string|null $priceWithVat = null ][, float|null $vat = null ][, int|null $relatedInvoiceVoucherId = null ]) : mixed
Parameters
$id : int|null = null
$invoiceId : int|null = null
$currencyId : int|null = null
$code : string|null = null
$name : string|null = null
$percents : int|null = null
$price : string|null = null
$priceWithVat : string|null = null
$vat : float|null = null
$relatedInvoiceVoucherId : int|null = null

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>

getCode()

public getCode() : string|null
Return values
string|null

getCurrencyId()

public getCurrencyId() : int|null
Return values
int|null

getInvoiceId()

public getInvoiceId() : int|null
Return values
int|null

getName()

public getName() : string|null
Return values
string|null

getPercents()

public getPercents() : int|null
Return values
int|null

getPrice()

public getPrice() : string|null
Return values
string|null

getPriceWithVat()

public getPriceWithVat() : string|null
Return values
string|null

getRelatedInvoiceVoucherId()

public getRelatedInvoiceVoucherId() : int|null
Return values
int|null

setCode()

public setCode(string|null $code) : $this
Parameters
$code : string|null
Return values
$this

setCurrencyId()

public setCurrencyId(int|null $currencyId) : $this
Parameters
$currencyId : int|null
Return values
$this

setId()

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

setInvoiceId()

public setInvoiceId(int|null $invoiceId) : $this
Parameters
$invoiceId : int|null
Return values
$this

setName()

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

setPercents()

public setPercents(int|null $percents) : $this
Parameters
$percents : int|null
Return values
$this

setPrice()

public setPrice(string|null $price) : $this
Parameters
$price : string|null
Return values
$this

setPriceWithVat()

public setPriceWithVat(string|null $priceWithVat) : $this
Parameters
$priceWithVat : string|null
Return values
$this

setRelatedInvoiceVoucherId()

public setRelatedInvoiceVoucherId(int|null $relatedInvoiceVoucherId) : $this
Parameters
$relatedInvoiceVoucherId : int|null
Return values
$this

setVat()

public setVat(float|null $vat) : $this
Parameters
$vat : float|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