PHP Class app\models\Invoice

Inheritance: extends app\models\Model
显示文件 Open project: hillelcoren/invoice-ninja Class Usage Examples

Public Properties

Property Type Description
$fieldAmount string
$fieldDueDate string
$fieldInvoiceDate string
$fieldInvoiceNumber string
$fieldNotes string
$fieldPaid string
$fieldTerms string
$patternFields array

Protected Properties

Property Type Description
$casts array
$dates array
$fillable array
$presenter string

Public Methods

Method Description
account ( ) : BelongsTo
affectsBalance ( ) : boolean
calcLink ( $invoice ) : string
canBePaid ( )
client ( ) : mixed
documents ( ) : mixed
expenses ( ) : mixed
frequency ( ) : BelongsTo
getAdjustment ( ) : float | integer
getAmountPaid ( boolean $calculate = false ) : integer | mixed
getAutoBillEnabled ( ) : boolean
getCurrencyCode ( ) : string
getDisplayName ( ) : mixed
getDueDate ( null $invoice_date = null ) : mixed | null
getEntityType ( ) : mixed
getFileName ( ) : string
getImportColumns ( ) : array
getImportMap ( ) : array
getInvitationLink ( $type = 'view', $forceOnsite = false )
getItemTaxable ( $invoiceItem, $invoiceTotal ) : float | integer
getLink ( ) : string
getName ( ) : mixed
getNextSendDate ( ) : null
getPDFPath ( ) : string
getPDFString ( ) : boolean | string
getPrettySchedule ( integer $min = 1, integer $max = 10 ) : null
getRequestedAmount ( ) : mixed
getRoute ( ) : string
getSchedule ( ) : boolean | Recurr\RecurrenceCollection
getTaxable ( ) : float | integer | mixed
getTaxes ( boolean $calculatePaid = false ) : array
hasDocuments ( ) : boolean
hasExpenseDocuments ( ) : boolean
hidePrivateFields ( )
invitations ( ) : mixed
invoice_design ( ) : BelongsTo
invoice_items ( ) : mixed
invoice_status ( ) : BelongsTo
isChanged ( ) : boolean
isInvoice ( ) : boolean
isOverdue ( ) : boolean
isPaid ( ) : boolean
isPartial ( ) : boolean
isQuote ( ) : boolean
isSent ( ) : boolean
isType ( $typeId ) : boolean
isViewed ( ) : boolean
markApproved ( )
markInvitationSent ( $invitation, boolean $messageId = false, boolean $notify = true )
markInvitationsSent ( boolean $notify = false )
markViewed ( )
parentTrashed ( )
payments ( ) : Illuminate\Database\Eloquent\Relations\HasMany
recurring_invoice ( ) : BelongsTo
recurring_invoices ( ) : Illuminate\Database\Eloquent\Relations\HasMany
scopeInvoiceType ( $query, $typeId ) : mixed
scopeInvoices ( $query ) : mixed
scopeQuotes ( $query ) : mixed
shouldSendToday ( ) : boolean
subEntityType ( )
trashed ( ) : boolean
updateBalances ( $balanceAdjustment, integer $partial )
updatePaidStatus ( boolean $save = true )
user ( ) : mixed

Private Methods

Method Description
calculateTax ( &$taxes, $name, $rate, $amount, $paid )
getRawAdjustment ( ) : float
getRecurrenceRule ( ) : string

Method Details

account() public method

public account ( ) : BelongsTo
return Illuminate\Database\Eloquent\Relations\BelongsTo

affectsBalance() public method

public affectsBalance ( ) : boolean
return boolean

canBePaid() public method

public canBePaid ( )

client() public method

public client ( ) : mixed
return mixed

documents() public method

public documents ( ) : mixed
return mixed

expenses() public method

public expenses ( ) : mixed
return mixed

frequency() public method

public frequency ( ) : BelongsTo
return Illuminate\Database\Eloquent\Relations\BelongsTo

getAdjustment() public method

public getAdjustment ( ) : float | integer
return float | integer

getAmountPaid() public method

public getAmountPaid ( boolean $calculate = false ) : integer | mixed
$calculate boolean
return integer | mixed

getAutoBillEnabled() public method

public getAutoBillEnabled ( ) : boolean
return boolean

getCurrencyCode() public method

public getCurrencyCode ( ) : string
return string

getDisplayName() public method

public getDisplayName ( ) : mixed
return mixed

getDueDate() public method

public getDueDate ( null $invoice_date = null ) : mixed | null
$invoice_date null
return mixed | null

getEntityType() public method

public getEntityType ( ) : mixed
return mixed

getFileName() public method

public getFileName ( ) : string
return string

getImportColumns() public static method

public static getImportColumns ( ) : array
return array

getImportMap() public static method

public static getImportMap ( ) : array
return array

getItemTaxable() public method

public getItemTaxable ( $invoiceItem, $invoiceTotal ) : float | integer
$invoiceItem
$invoiceTotal
return float | integer

getName() public method

public getName ( ) : mixed
return mixed

getNextSendDate() public method

public getNextSendDate ( ) : null
return null

getPDFPath() public method

public getPDFPath ( ) : string
return string

getPDFString() public method

public getPDFString ( ) : boolean | string
return boolean | string

getPrettySchedule() public method

public getPrettySchedule ( integer $min = 1, integer $max = 10 ) : null
$min integer
$max integer
return null

getRequestedAmount() public method

public getRequestedAmount ( ) : mixed
return mixed

getRoute() public method

public getRoute ( ) : string
return string

getSchedule() public method

public getSchedule ( ) : boolean | Recurr\RecurrenceCollection
return boolean | Recurr\RecurrenceCollection

getTaxable() public method

public getTaxable ( ) : float | integer | mixed
return float | integer | mixed

getTaxes() public method

public getTaxes ( boolean $calculatePaid = false ) : array
$calculatePaid boolean
return array

hasDocuments() public method

public hasDocuments ( ) : boolean
return boolean

hasExpenseDocuments() public method

public hasExpenseDocuments ( ) : boolean
return boolean

hidePrivateFields() public method

public hidePrivateFields ( )

invitations() public method

public invitations ( ) : mixed
return mixed

invoice_design() public method

public invoice_design ( ) : BelongsTo
return Illuminate\Database\Eloquent\Relations\BelongsTo

invoice_items() public method

public invoice_items ( ) : mixed
return mixed

invoice_status() public method

public invoice_status ( ) : BelongsTo
return Illuminate\Database\Eloquent\Relations\BelongsTo

isChanged() public method

public isChanged ( ) : boolean
return boolean

isInvoice() public method

public isInvoice ( ) : boolean
return boolean

isOverdue() public method

public isOverdue ( ) : boolean
return boolean

isPaid() public method

public isPaid ( ) : boolean
return boolean

isPartial() public method

public isPartial ( ) : boolean
return boolean

isQuote() public method

public isQuote ( ) : boolean
return boolean

isSent() public method

public isSent ( ) : boolean
return boolean

isType() public method

public isType ( $typeId ) : boolean
$typeId
return boolean

isViewed() public method

public isViewed ( ) : boolean
return boolean

markApproved() public method

public markApproved ( )

markInvitationSent() public method

public markInvitationSent ( $invitation, boolean $messageId = false, boolean $notify = true )
$invitation
$messageId boolean
$notify boolean

markInvitationsSent() public method

public markInvitationsSent ( boolean $notify = false )
$notify boolean

markViewed() public method

public markViewed ( )

parentTrashed() public method

public parentTrashed ( )

payments() public method

public payments ( ) : Illuminate\Database\Eloquent\Relations\HasMany
return Illuminate\Database\Eloquent\Relations\HasMany

recurring_invoice() public method

public recurring_invoice ( ) : BelongsTo
return Illuminate\Database\Eloquent\Relations\BelongsTo

recurring_invoices() public method

public recurring_invoices ( ) : Illuminate\Database\Eloquent\Relations\HasMany
return Illuminate\Database\Eloquent\Relations\HasMany

scopeInvoiceType() public method

public scopeInvoiceType ( $query, $typeId ) : mixed
$query
$typeId
return mixed

scopeInvoices() public method

public scopeInvoices ( $query ) : mixed
$query
return mixed

scopeQuotes() public method

public scopeQuotes ( $query ) : mixed
$query
return mixed

shouldSendToday() public method

public shouldSendToday ( ) : boolean
return boolean

subEntityType() public method

public subEntityType ( )

trashed() public method

public trashed ( ) : boolean
return boolean

updateBalances() public method

public updateBalances ( $balanceAdjustment, integer $partial )
$balanceAdjustment
$partial integer

updatePaidStatus() public method

public updatePaidStatus ( boolean $save = true )
$save boolean

user() public method

public user ( ) : mixed
return mixed

Property Details

$casts protected_oe property

protected array $casts
return array

$dates protected_oe property

protected array $dates
return array

$fieldAmount public_oe static_oe property

public static string $fieldAmount
return string

$fieldDueDate public_oe static_oe property

public static string $fieldDueDate
return string

$fieldInvoiceDate public_oe static_oe property

public static string $fieldInvoiceDate
return string

$fieldInvoiceNumber public_oe static_oe property

public static string $fieldInvoiceNumber
return string

$fieldNotes public_oe static_oe property

public static string $fieldNotes
return string

$fieldPaid public_oe static_oe property

public static string $fieldPaid
return string

$fieldTerms public_oe static_oe property

public static string $fieldTerms
return string

$fillable protected_oe property

protected array $fillable
return array

$patternFields public_oe static_oe property

public static array $patternFields
return array

$presenter protected_oe property

protected string $presenter
return string