InvoiceArchiveReadService
in package
implements
InvoiceArchiveReadServiceInterface
Class InvoiceListArchiveReadService
Tags
Interfaces, Classes and Traits
- InvoiceArchiveReadServiceInterface
- Interface InvoiceFileEntitlerInterface
Table of Contents
- $invoiceListGenerator : InvoiceListGeneratorInterface
- $invoiceServiceSettings : InvoiceServiceSettingsInterface
- __construct() : mixed
- InvoiceListArchiveReadService constructor.
- filterInvoiceList() : InvoiceListItemCollection
- Filter the invoice records with specific conditions.
- filterInvoiceListCount() : int
- Get the filtered invoices count.
- getInvoiceFileDownloadInfoByInvoiceId() : FileDownloadInformation
- Returns the invoice file download information.
- getInvoiceListByConditions() : InvoiceListItemCollection
- Returns an invoice list item collection by the given conditions.
- getInvoiceListItemById() : InvoiceListItem
- Returns the invoice to the given id
Properties
$invoiceListGenerator
protected
InvoiceListGeneratorInterface
$invoiceListGenerator
$invoiceServiceSettings
protected
InvoiceServiceSettingsInterface
$invoiceServiceSettings
Methods
__construct()
InvoiceListArchiveReadService constructor.
public
__construct(InvoiceListGeneratorInterface $invoiceListGenerator, InvoiceServiceSettingsInterface $invoiceServiceSettings) : mixed
Parameters
- $invoiceListGenerator : InvoiceListGeneratorInterface
- $invoiceServiceSettings : InvoiceServiceSettingsInterface
Return values
mixed —filterInvoiceList()
Filter the invoice records with specific conditions.
public
filterInvoiceList(array<string|int, mixed> $filterParameters[, IntType $startIndex = null ][, IntType $maxCount = null ][, StringType $orderBy = null ]) : InvoiceListItemCollection
Provide the filtering values in the conditions array in order to fetch a filtered result set.
Parameters
- $filterParameters : array<string|int, mixed>
-
Contains an array of the GET parameters to be used for filtering the order records.
- $startIndex : IntType = null
-
Start index of order list item collections which should be returned.
- $maxCount : IntType = null
-
Maximum amount of collections.
- $orderBy : StringType = null
-
Argument to specify the order.
Return values
InvoiceListItemCollection —filterInvoiceListCount()
Get the filtered invoices count.
public
filterInvoiceListCount(array<string|int, mixed> $filterParameters) : int
Parameters
- $filterParameters : array<string|int, mixed>
Return values
int —getInvoiceFileDownloadInfoByInvoiceId()
Returns the invoice file download information.
public
getInvoiceFileDownloadInfoByInvoiceId(IdType $invoiceId) : FileDownloadInformation
Parameters
- $invoiceId : IdType
-
invoice_id of expected entry.
Return values
FileDownloadInformation —getInvoiceListByConditions()
Returns an invoice list item collection by the given conditions.
public
getInvoiceListByConditions([array<string|int, mixed> $conditions = [] ][, IntType|null $startIndex = null ][, IntType|null $maxCount = null ][, StringType|null $orderBy = null ]) : InvoiceListItemCollection
The other arguments helps to control fetched data.
Parameters
- $conditions : array<string|int, mixed> = []
-
(Optional) Conditions for tht where clause.
- $startIndex : IntType|null = null
-
(Optional) Start index for the limit clause.
- $maxCount : IntType|null = null
-
(Optional) Max count for the limit clause.
- $orderBy : StringType|null = null
-
(Optional) Sort order of fetched data.
Return values
InvoiceListItemCollection —getInvoiceListItemById()
Returns the invoice to the given id
public
getInvoiceListItemById(IdType $invoiceId) : InvoiceListItem
Parameters
- $invoiceId : IdType