\FAA\Obj\GenericBillServiceParent

Summary

Methods

Properties

Constants

__construct()
Currency()
MainProject()
AddEventEntry()
GetLastKnownEvent()
GeneralSearchFields()
Name()
SearchFields()
DateFormatted()
PriceList()
FullPrice()
FullPriceNet()
FullTax()
ToPlainReducedObject()
GetCompany()
GetCompanyExtra()
GetCompanyObject()

No public properties found

No constants found

No protected methods found

$root
$project
$prices
$company

N/A

No private methods found

No private properties found

N/A

Properties

$root

$root :string

The root storage folder starting at %DATA%/folder/

Type

string

$project

$project :\FAA\Obj\Generic\Project

In project context A reference to another overlaying project

Type

\FAA\Obj\Generic\Project—A project object

$prices

$prices :array<mixed,\FAA\Obj\Sys\RowPrice>

Buffer prices Storage for row prices as resolved object list.

Type

array<mixed,\FAA\Obj\Sys\RowPrice>—A list of row prices

$company

$company :null|\FAA\Obj\Generic\Company

The linked company object

Type

null|\FAA\Obj\Generic\Company

Methods

__construct()

__construct(string  $type,null|integer  $id = null,null|string  $language = null)

Base type constructor.

Parameters

string	$type	Subtype
null\|integer	$id	The bill id
null\|string	$language	The local language or null

Currency()

Currency(): string

Returns

string

MainProject()

MainProject(\FAA\Obj\Generic\Project|null  $project = null): \FAA\Obj\Generic\Project|null|void

Resolve the main project of this service/bill

Parameters

\FAA\Obj\Generic\Project|null

$project

Returns

\FAA\Obj\Generic\Project|null|void

AddEventEntry()

AddEventEntry(  $event)

Parameters

$event

GetLastKnownEvent()

GetLastKnownEvent(  $type): \FAA\Obj\Sys\Event|null

Get newest event of type

Iterate of elements list and return the newest entry

Parameters

$type

Returns

\FAA\Obj\Sys\Event|null

GeneralSearchFields()

GeneralSearchFields()

Name()

Name()

SearchFields()

SearchFields(): array

Return search indexer fields Convert instance to search indexer values

Returns

array —

The search indexer fields

DateFormatted()

DateFormatted(mixed|string  $time_zone = FAA_TIMEZONE,string  $format = 'd.m.Y H:i'): string

Get the formatted date range

Parameters

mixed\|string	$time_zone
string	$format

Returns

string

PriceList()

PriceList(): array<mixed,\FAA\Obj\Sys\RowPrice>

Price list Resolve the prices list to row price objects. This method is cached.

Returns

array<mixed,\FAA\Obj\Sys\RowPrice> —

A list of row price objects

FullPrice()

FullPrice(boolean  $format = false): float|string

Get price Get the full gross price of this project

Parameters

boolean

$format

When true as formatted string

Returns

float|string —

Either a formatted output or, the raw value

FullPriceNet()

FullPriceNet(boolean  $format = false): float|string

Get price Get the full gross price of this project (without tax)

Parameters

boolean

$format

When true as formatted string

Returns

float|string —

Either a formatted output or, the raw value

FullTax()

FullTax(boolean  $format = false): float|string

Get tax price Get the full gross price of this project

Parameters

boolean

$format

When true as formatted string

Returns

float|string —

Either a formatted output or, the raw value

ToPlainReducedObject()

ToPlainReducedObject(array  $fields,string  $language = null): Object|\stdClass

To plain object Convert to simplified plain object

Parameters

array	$fields	List of fields
string	$language	The language to parse in

Returns

Object|\stdClass —

A php object

GetCompany()

GetCompany(): integer

Get company id Get the company id from content

Returns

integer —

The content id

GetCompanyExtra()

GetCompanyExtra(): string|null

Get the assignment extra

Returns

string|null

GetCompanyObject()

GetCompanyObject(): \FAA\Obj\Generic\Company

Get company

Get the main company from content

Returns

\FAA\Obj\Generic\Company —

A company object or null when list is empty