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

  • AbstractOptions

Interfaces

  • OptionsInterface
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Interface OptionsInterface

Interface for options

Direct known implementers

Blesta\Core\Pricing\Presenter\Build\Options\AbstractOptions

Indirect known implementers

Blesta\Core\Pricing\Presenter\Build\Invoice\AbstractInvoiceBuilder, Blesta\Core\Pricing\Presenter\Build\Invoice\InvoiceBuilder, Blesta\Core\Pricing\Presenter\Build\InvoiceData\AbstractInvoiceDataBuilder, Blesta\Core\Pricing\Presenter\Build\InvoiceData\InvoiceDataBuilder, Blesta\Core\Pricing\Presenter\Build\Service\AbstractServiceBuilder, Blesta\Core\Pricing\Presenter\Build\Service\ServiceBuilder, Blesta\Core\Pricing\Presenter\Build\ServiceChange\AbstractServiceChangeBuilder, Blesta\Core\Pricing\Presenter\Build\ServiceChange\ServiceChangeBuilder, Blesta\Core\Pricing\Presenter\Build\ServiceData\AbstractServiceDataBuilder, Blesta\Core\Pricing\Presenter\Build\ServiceData\ServiceDataBuilder
Namespace: Blesta\Core\Pricing\Presenter\Build\Options
Package: blesta\core\Pricing\Presenter\Build\Options
Copyright: Copyright (c) 2019, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at core/Pricing/Presenter/Build/Options/OptionsInterface.php
Methods summary
public
# settings( array $settings )

Sets a list of settings

Sets a list of settings

Parameters

$settings
An array containing all client and company settings as key/value pairs
public
# options( array $options )

Sets any key/value custom options

Sets any key/value custom options

Parameters

$options

An array of custom options:

  • recur Boolean true/false. Whether the pricing items are recurring, or if they are being added for the first time (default false)
public
# taxes( array $taxes )

Sets all tax rules

Sets all tax rules

Parameters

$taxes

An array of stdClass objects representing each tax rule that applies, containing:

  • id The tax ID
  • company_id The company ID
  • level The tax level
  • name The name of the tax
  • amount The tax amount
  • type The tax type (inclusive, exclusive)
  • status The tax status
public
# discounts( array $discounts )

Sets all discounts

Sets all discounts

Parameters

$discounts

An array of stdClass objects representing each coupon that applies, containing:

  • id The coupon ID
  • code The coupon code
  • used_qty The number of times the coupon has been used
  • max_qty The max number of coupon uses
  • start_date The date the coupon begins
  • end_date The date the coupon ends
  • status The coupon status
  • type The type of coupon as it applies to packages (exclusive, inclusive)
  • recurring 1 or 0, whether the coupon applies to recurring services
  • limit_recurring 1 or 0, whether the coupon limitations apply to recurring services
  • apply_package_options 1 or 0, whether the coupon applies to a service's package options
  • amounts An array of stdClass objects representing each coupon amount, containing:
    • coupon_id The coupon ID
    • currency The coupon amount currency
    • amount The coupon amount
    • type The coupon amount type (percent, amount)
  • packages An array of stdClass objects representing each assigned coupon package, containing:
    • coupon_id The coupon ID
    • package_id The assigned package ID
Blesta API documentation generated by ApiGen