Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • AdminHttpViewControllers
  • ApiV2Controllers
  • Authentication
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Strategies
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Storages
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Extensions
    • Customers
    • Emails
    • Helpers
    • Invoices
    • Orders
    • Serializers
    • Templates
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • HttpViewControllers
  • InfoBox
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • Invoice
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • Modules
    • Collections
    • Controllers
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Precheck
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • ClassFinder
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • SharedShoppingCart
    • Interfaces
  • Slider
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • AbstractInvoiceServiceFactory
  • InvoiceArchiveReadService
  • InvoiceArchiveWriteService
  • InvoiceFileEntitler
  • InvoiceListGenerator
  • InvoiceListItem
  • InvoiceListItemCollection
  • InvoiceRepository
  • InvoiceServiceFactory

Class InvoiceArchiveReadService

Class InvoiceListArchiveReadService

InvoiceArchiveReadService implements InvoiceArchiveReadServiceInterface
Package: Invoice
Category: System
Located at Services/Core/Invoice/InvoiceArchiveReadService.inc.php

Methods summary

public
# __construct( InvoiceListGeneratorInterface $invoiceListGenerator, InvoiceServiceSettingsInterface $invoiceServiceSettings )

InvoiceListArchiveReadService constructor.

InvoiceListArchiveReadService constructor.

Parameters

$invoiceListGenerator
$invoiceServiceSettings
public InvoiceListItemCollection
# getInvoiceListByConditions( array $conditions = [], IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )

Returns an invoice list item collection by the given conditions.

Returns an invoice list item collection by the given conditions.

The other arguments helps to control fetched data.

Parameters

$conditions
(Optional) Conditions for tht where clause.
$startIndex
(Optional) Start index for the limit clause.
$maxCount
(Optional) Max count for the limit clause.
$orderBy
(Optional) Sort order of fetched data.

Returns

InvoiceListItemCollection

Implementation of

InvoiceArchiveReadServiceInterface::getInvoiceListByConditions()
public FileDownloadInformation
# getInvoiceFileDownloadInfoByInvoiceId( IdType $invoiceId )

Returns the invoice file download information.

Returns the invoice file download information.

Parameters

$invoiceId
invoice_id of expected entry.

Returns

FileDownloadInformation

Implementation of

InvoiceArchiveReadServiceInterface::getInvoiceFileDownloadInfoByInvoiceId()
public InvoiceListItem
# getInvoiceListItemById( IdType $invoiceId )

Returns the invoice to the given id

Returns the invoice to the given id

Parameters

$invoiceId

Returns

InvoiceListItem

Throws

UnexpectedValueException
if invoice does not exist

Implementation of

InvoiceArchiveReadServiceInterface::getInvoiceListItemById()
public InvoiceListItemCollection
# filterInvoiceList( array $filterParameters, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )

Filter the invoice records with specific conditions.

Filter the invoice records with specific conditions.

Provide the filtering values in the conditions array in order to fetch a filtered result set.

Parameters

$filterParameters

Contains an array of the GET parameters to be used for filtering the order records.

$startIndex
Start index of order list item collections which should be returned.
$maxCount
Maximum amount of collections.
$orderBy
Argument to specify the order.

Returns

InvoiceListItemCollection

Implementation of

InvoiceArchiveReadServiceInterface::filterInvoiceList()
public integer
# filterInvoiceListCount( array $filterParameters )

Get the filtered invoices count.

Get the filtered invoices count.

Parameters

$filterParameters

Returns

integer

Implementation of

InvoiceArchiveReadServiceInterface::filterInvoiceListCount()

Properties summary

protected InvoiceListGeneratorInterface $invoiceListGenerator
#
protected InvoiceServiceSettingsInterface $invoiceServiceSettings
#
API documentation generated by ApiGen