Overview

Packages

  • blesta
    • app
      • controllers
      • models
    • components
      • auth
        • ldap
        • motp
        • oath
      • delivery
        • interfax
        • postal
          • methods
      • download
      • email
      • events
      • exchange
        • rates
          • currency
            • layer
          • fixer
          • open
            • exchange
              • rates
          • x
            • rates
      • gateway
        • payments
      • gateways
      • invoice
        • delivery
        • templates
          • perforated
            • invoice
          • quickbooks
            • invoice
          • templates
            • default
      • modules
      • net
        • amazon
          • s3
        • http
        • net
          • geo
            • ip
      • plugins
      • reports
        • aging
          • invoices
        • client
          • data
            • portability
        • custom
          • report
        • invoice
          • creation
        • package
          • revenue
        • tax
          • liability
        • transactions
          • applied
          • received
      • security
      • session
        • cart
      • settingscollection
      • upgrades
        • tasks
      • upload
      • vcard
    • core
      • Automation
        • Tasks
          • Common
          • Task
        • Type
          • Common
          • Cron
      • Pricing
        • ItemComparator
        • MetaItem
        • Modifier
          • Type
            • Description
              • Type
                • Discount
                • Option
                • Service
                • Tax
            • Discount
            • Price
            • Proration
        • Presenter
          • Build
            • Invoice
            • InvoiceData
            • Options
            • Service
            • ServiceChange
            • ServiceData
          • Collection
          • Format
            • Fields
            • Type
              • Discount
              • Item
              • Option
              • Options
              • Package
              • Pricing
              • Service
              • Tax
          • Items
            • Invoice
            • Service
          • Type
      • ServiceProviders
      • Util
        • Captcha
          • Captchas
          • Common
        • Common
          • Traits
        • Events
          • Common
          • Handlers
          • Observers
        • Filters
          • Common
        • GeoIp
        • Input
          • Fields
            • Common
        • Tax
        • Widgets
    • helpers
      • currency
        • format
      • data
        • structure
          • array
          • string
      • text
        • parser
      • widget
        • client
  • minPHP
    • helpers
      • color
      • data
        • structure
  • None
  • PHP

Classes

  • TransactionsReceived
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class TransactionsReceived

Transactions Received report

TransactionsReceived implements ReportInterface
Package: blesta\components\reports\transactions\received
Copyright: Copyright (c) 2013, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at components/reports/transactions_received/transactions_received.php
Methods summary
public
# __construct( )

Load language

Load language

public string
# getName( )

Retrieves the name of this report

Retrieves the name of this report

Returns

string
The name of the report

Implementation of

ReportInterface::getName()
public string
# getFormats( )

Retrieves a list of formats supported by this report

Retrieves a list of formats supported by this report

Returns

string
The list of formats supported by this report

Implementation of

ReportInterface::getFormats()
public string
# getOptions( integer $company_id, array $vars = [] )

Retrieves the view containing any additional fields to filter on for the report

Retrieves the view containing any additional fields to filter on for the report

Parameters

$company_id
The ID of the company to generate the report from
$vars
list of input vars (optional)

Returns

string
The view

Implementation of

ReportInterface::getOptions()
public array
# getKeyInfo( )

Retrieves a list of data keys included in the report and information about them

Retrieves a list of data keys included in the report and information about them

Returns

array
A list of key/value pairs indicating the field, its name, and any formatting to apply

Implementation of

ReportInterface::getKeyInfo()
public Iterator
# fetchAll( integer $company_id, array $vars )

Execute the report

Execute the report

Parameters

$company_id
The ID of the company to generate the report from
$vars
A list of fields as given as options to the view

Returns

Iterator
An iterable object containing the report data

Implementation of

ReportInterface::fetchAll()
Blesta API documentation generated by ApiGen