Blesta Source Documentation

API Documentation

Table of Contents

Namespaces

Blesta

Interfaces

MerchantAch Merchant ACH processing interface. Defines all methods that an ACH payment gateway must implement. Note: not all methods are required to be supported.
MerchantAchForm Merchant ACH custom form interface. Defines all methods that an ACH form payment gateway must implement.
MerchantAchOffsite Merchant ACH offsite processing interface. Defines all methods that an ACH offsite payment gateway must implement. Note: not all methods are required to be supported.
MerchantAchVerification Merchant ACH verification processing interface. Defines all methods that an ACH offsite payment gateway must implement if verification is required for the accounts.
MerchantCc Merchant Credit Card processing interface. Defines all methods that a credit card payment gateway must implement. Note: not all methods are required to be supported.
MerchantCcForm Merchant Credit Card custom form interface. Defines all methods that a credit card form payment gateway must implement.
MerchantCcOffsite Merchant Credit Card offsite processing interface. Defines all methods that a credit card offsite payment gateway must implement. Note: not all methods are required to be supported.
ReportInterface Report interface that all reports must implement

Classes

AdminController Admin Parent Controller
ClientController Client Parent Controller
_404 Handle 404 (File not found) Requests
AdminBilling Admin Billing Management
AdminClients Admin Clients Management
AdminClientsService Admin Client's Service Management
AdminCompanyAutomation Admin Company Automation Settings
AdminCompanyBilling Admin Company Billing Settings
AdminCompanyClientoptions Admin Client Options
AdminCompanyCurrencies Admin Company Currency Settings
AdminCompanyElectronicInvoices Admin Company Electronic Invoices Settings
AdminCompanyEmails Admin Company Emails Settings
AdminCompanyFeeds Admin Company Data Feeds Settings
AdminCompanyGateways Admin Company Gateway Settings
AdminCompanyGeneral Admin Company General Settings
AdminCompanyGroups Admin Company Client Group Settings
AdminCompanyLookandfeel Admin Company Look And Feel Settings
AdminCompanyMessengers Admin Company Messenger Settings
AdminCompanyModules Admin Company Module Settings
AdminCompanyPlugins Admin Company Plugin Settings
AdminCompanyTaxes Admin Company Taxes Settings
AdminCompanyThemes Admin Company Theme Settings
AdminDialog Admin Dialog modal boxes
AdminLicense Admin License
AdminLogin Administrative Login
AdminLogout Administrative Logout
AdminMain Admin Main
AdminMyinfo Admin My Info
AdminPackageOptions Admin Package Options Management
AdminPackages Admin Packages Management
AdminReports Admin Reports Management
AdminReportsCustomize Admin Reports Customization
AdminSearch Admin Search. Searches clients, invoices, transactions, services, and plugin events.
AdminSettings Admin Settings
AdminSystemApi Admin System API Settings
AdminSystemAutomation Admin System Automation Settings
AdminSystemBackup Admin System Backup Settings
AdminSystemCompanies Admin System Company Settings
AdminSystemGeneral Admin System General Settings
AdminSystemHelp Admin System Help
AdminSystemMarketplace Admin System Marketplace
AdminSystemStaff Admin System Staff Settings
AdminSystemUpgrade Admin System Upgrade Settings
AdminTheme Adds the CSS for custom themes
AdminTools Admin Tools
AdminUpgrade Allows users to interact with the upgrade process via the web or via command line.
Api A RESTful API system for interacting with the Blesta backend.
Callback Callback controller, handles all callback requests
ClientAccounts Client portal accounts controller
ClientContacts Client portal contacts controller
ClientDialog Client Dialog modal boxes
ClientEmails Client emails controller
ClientInvoices Client portal invoices controller
ClientLogin Client portal login controller
ClientLogout Client portal logout controller
ClientMain Client portal main controller
ClientMaintenance Client maintenance controller
ClientManagers Client portal managers controller
ClientPay Client portal pay controller
ClientQuotations Client portal quotations controller
ClientServices Client portal services controller
ClientTheme Adds the CSS for custom themes
ClientTransactions Client portal transactions controller
ClientVerify Client email verification controller
Cron The Cron controller. Handles all automated tasks that run via a cron job or scheduled task.
Dialog Dialog modal boxes
Feed Call data feed endpoints from an external website
Install Handle the installation process via web or command line
Main Main controller
Uploads Allows access to files uploaded to the uploads directory, which likely resides above a publically accessible directory
Accounts Accounts contain both ACH and Credit Card account information. Permits accounts to be fetched, added, edited, and deleted. Some accounts may require processing with remote gateways when added or edited. In such instances certain account details are not stored within the system, but only off-site on the remote gateway.
Actions Actions
ApiKeys API Key management
Backup Backup
Blacklist Blacklist management
CalendarEvents CalendarEvents
ClientGroups Client group management
Clients Client management
Companies Company management
Contacts Contact management
Countries Countries adhere to ISO 3166-1 and contain English and native country name (when differing from English)
CouponPackageOptions Coupon Package Option management
CouponTerms Coupon term management
Coupons Coupon management
CronTasks Cron Task management
Currencies Currency Management
DataFeeds Data feeds management
ElectronicInvoices Electronic Invoice management
EmailGroups Email Group management
EmailHtmlTemplates Email HTML templates
EmailVerifications Email Verifications management
Emails Email management
Encryption Company Encryption Settings
GatewayManager Gateway manager. Handles installing/uninstalling and configuring payment gateways.
InvoiceTemplateManager Invoice template manager. Handles fetches invoice templates
Invoices Invoice management
Languages Language management. Maintains all languages installed on the system and allows new languages to be installed.
Logs Log System
ManagedAccounts Managed Accounts Model
Marketplace Marketplace
MessageGroups Message Groups
Messages Messages
MessengerManager Messenger manager.
ModuleClientMeta Module Client Meta
ModuleManager Module manager. Handles installing/uninstalling and configuring modules.
ModuleTypes Module Types Management
Navigation Handles navigation.
PackageGroups Package Group management
PackageOptionConditionSets Package Option Condition Set management
PackageOptionConditions Package Option Condition management
PackageOptionGroups Package Option Group management
PackageOptions Package Option management
Packages Package management
PasswordResets Password resets management
Payments Processes payments through remote gateways and records the transactions.
Permissions Permissions management
PluginManager Plugin manager. Handles installing/uninstalling plugins through their respective plugin handlers.
Pricings Pricing management
Quotations Quotations management
ReportManager Report Manager
ServiceChanges Service upgrades/downgrades
ServiceInvoices Service Invoice This is an association between services and the invoices created for adding or renewing them.
Services Service management
Settings System setting management
Staff Staff management
StaffGroups Staff group management
States States adhere to ISO 3166-2, and contain the native state/province/territory name. The format of ISO 3166-2 is [ISO 3166-1 alpha2 country code]-[subdivision code].
SystemEvents Events model
TaxProviders Tax providers management
Taxes Tax rule management
Themes Company Theme Settings
Transactions Transaction management
Users User management
Auth Authentication factory component
Ldap Ldap implementation
Motp Mobile One Time Password generator/validator, based on the http://motp.sourceforge.net specification.
Oath Oath implementation of the OATH specification for both HOTP and TOTP one time passwords (RFC4226 and its extension HOTPTimeBased Internet-Draft, respectively).
Delivery Delivery factory component
DeliveryMethod A delivery method
Interfax Interfax service for sending faxes
PostalMethods PostalMethods service for physically mailing letters
Download Download component
Email A wrapper component for Symfony Mailer.
CurrencyLayer Currency Layer Currency Exchange Rate Processor
ExchangeRate Abstract class that all Currency Exchange Rate Processors must extend
ExchangeRates Currency Exchange Rate factory
Fixer Fixer.io Exchange Rate Processor
OpenExchangeRates Open Exchange Rates Currency Exchange Rate Processor
XRates X-Rates Currency Exchange Rate Processor
GatewayPayments Processes payments through gateways, records their transactions and sends out email notices when payments are successfully processed all according to the client and company settings for the client and company in question
Gateways Factory class for creating Gateway objects
Gateway Abstract class that all Gateways extend through MerchantGateway or NonmerchantGateway
MerchantGateway Abstract class that all Merchant Gateways must extend
NonmerchantGateway Abstract class that all Nonmerchant Gateways must extend
InvoiceDelivery Invoice Delivery component
InvoiceFormat Abstract class that all Invoice Formats must extend
InvoiceFormats Invoice Format factory
Ubl UBL XML Invoice Format
DefaultInvoice Default Invoice Template
DefaultInvoicePdf Default Invoice Template
InvoiceTemplate Abstract class that all Invoice Templates must extend
InvoiceTemplates Invoice Template factory
PerforatedInvoice Perforated Invoice Template
PerforatedInvoicePdf Perforated Invoice Template
QuickbooksInvoice Quickbooks Invoice Template
QuickbooksInvoicePdf Quickbooks Invoice Template
TcpdfWrapper TCPDF Wrapper. Extends the TCPDF library to make it easier to use for building invoices.
AmazonS3 Amazon S3 component that backs up file data.
Http Http component that wraps cURL
Net Networking factory component
NetGeoIp NetGeoIP component that wraps Maxmind's GeoIP system. Requires mbstring extension to be enabled with PHP (due to poor coding standards on MaxMind's part).
NetProtocol A network protocol
Plugin Abstract class that all Plugin handlers extend
Plugins Factory class for creating Plugin handler objects
QuotationDelivery Quotation Delivery component
AgingInvoices AgingInvoices report
ClientDataPortability ClientDataPortability report
ClientRevenue Client Revenue report
ClientsCredits ClientsCredits report
CustomReport Custom Report
InvoiceCreation Invoice Creation report
PackageRevenue Package Revenue report
Report A report
Reports Factory class for creating Report objects
TaxLiability Tax Liability report
TransactionsApplied Transactions Applied report
TransactionsReceived Transactions Received report
Security Security factory that wraps PHPSecLib.
SessionCart Shopping cart session wrapper
SettingsCollection A collection manager of company settings
UpgradeUtil Upgrade Utility that all upgrade objects must extend
Upgrade3_0_0A4 Upgrades to version 3.0.0.a4
Upgrade3_0_0A5 Upgrades to version 3.0.0.a5
Upgrade3_0_0A6 Upgrades to version 3.0.0.a6
Upgrade3_0_0A7 Upgrades to version 3.0.0.a7
Upgrade3_0_0B1 Upgrades to version 3.0.0.b1
Upgrade3_0_0B2 Upgrades to version 3.0.0.b2
Upgrade3_0_0B3 Upgrades to version 3.0.0.b3
Upgrade3_0_0B6 Upgrades to version 3.0.0.b6
Upgrade3_0_0B7 Upgrades to version 3.0.0.b7
Upgrade3_0_2 Upgrades to version 3.0.2
Upgrade3_0_3 Upgrades to version 3.0.3
Upgrade3_0_4 Upgrades to version 3.0.4
Upgrade3_1_0B1 Upgrades to version 3.1.0-b1
Upgrade3_1_1 Upgrades to version 3.1.1
Upgrade3_1_2 Upgrades to version 3.1.2
Upgrade3_2_0B1 Upgrades to version 3.2.0-b1
Upgrade3_2_1 Upgrades to version 3.2.1
Upgrade3_3_0B1 Upgrades to version 3.3.0-b1
Upgrade3_3_0B2 Upgrades to version 3.3.0-b2
Upgrade3_3_2 Upgrades to version 3.3.2
Upgrade3_4_0 Upgrades to version 3.4.0
Upgrade3_4_0B1 Upgrades to version 3.4.0-b1
Upgrade3_4_3 Upgrades to version 3.4.3
Upgrade3_5_0B1 Upgrades to version 3.5.0-b1
Upgrade3_5_0B2 Upgrades to version 3.5.0-b2
Upgrade3_5_0B4 Upgrades to version 3.5.0-b4
Upgrade3_5_1 Upgrades to version 3.5.1
Upgrade3_6_0B1 Upgrades to version 3.6.0-b1
Upgrade3_6_2 Upgrades to version 3.6.2
Upgrade4_0_0B1 Upgrades to version 4.0.0-b1
Upgrade4_0_0B2 Upgrades to version 4.0.0-b2
Upgrade4_0_0B6 Upgrades to version 4.0.0-b6
Upgrade4_10_0B1 Upgrades to version 4.10.0-b1
Upgrade4_11_0B1 Upgrades to version 4.11.0-b1
Upgrade4_12_0B1 Upgrades to version 4.12.0-b1
Upgrade4_12_1 Upgrades to version 4.12.1
Upgrade4_1_0B1 Upgrades to version 4.1.0-b1
Upgrade4_1_1 Upgrades to version 4.1.1
Upgrade4_2_0B1 Upgrades to version 4.2.0-b1
Upgrade4_2_0B2 Upgrades to version 4.2.0-b2
Upgrade4_2_2 Upgrades to version 4.2.2
Upgrade4_3_0B1 Upgrades to version 4.3.0-b1
Upgrade4_4_0B1 Upgrades to version 4.4.0-b1
Upgrade4_5_0B1 Upgrades to version 4.5.0-b1
Upgrade4_6_0 Upgrades to version 4.6.0
Upgrade4_6_0B1 Upgrades to version 4.6.0-b1
Upgrade4_7_0B1 Upgrades to version 4.7.0-b1
Upgrade4_8_0B1 Upgrades to version 4.8.0-b1
Upgrade4_9_0B1 Upgrades to version 4.9.0-b1
Upgrade4_9_1 Upgrades to version 4.9.1
Upgrade5_0_0B1 Upgrades to version 5.0.0-b1
Upgrade5_0_1 Upgrades to version 5.0.1
Upgrade5_0_3 Upgrades to version 5.0.3
Upgrade5_10_0B1 Upgrades to version 5.10.0-b1
Upgrade5_11_0 Upgrades to version 5.11.0
Upgrade5_11_0B1 Upgrades to version 5.11.0-b1
Upgrade5_11_0B3 Upgrades to version 5.11.0-b3
Upgrade5_11_4 Upgrades to version 5.11.4
Upgrade5_12_0B1 Upgrades to version 5.12.0-b1
Upgrade5_12_1 Upgrades to version 5.12.1
Upgrade5_13_0B1 Upgrades to version 5.13.0-b1
Upgrade5_1_0 Upgrades to version 5.1.0
Upgrade5_1_0B1 Upgrades to version 5.1.0-b1
Upgrade5_2_0B1 Upgrades to version 5.2.0-b1
Upgrade5_3_0B1 Upgrades to version 5.3.0-b1
Upgrade5_4_0B1 Upgrades to version 5.4.0-b1
Upgrade5_5_0B1 Upgrades to version 5.5.0-b1
Upgrade5_5_0B2 Upgrades to version 5.5.0-b2
Upgrade5_6_0B1 Upgrades to version 5.6.0-b1
Upgrade5_6_0B2 Upgrades to version 5.6.0-b2
Upgrade5_6_1 Upgrades to version 5.6.1
Upgrade5_7_0B1 Upgrades to version 5.7.0-b1
Upgrade5_8_0B1 Upgrades to version 5.8.0-b1
Upgrade5_8_1 Upgrades to version 5.8.1
Upgrade5_9_0B1 Upgrades to version 5.9.0-b1
Upgrade5_9_1 Upgrades to version 5.9.1
Upgrade5_9_3 Upgrades to version 5.9.3
Upgrades Handles the upgrade process to bring the current database up to the requirements of the installed files.
Upload Upload component
VCard vCard component that creates vCard-formatted address book data
Color Color helper
CurrencyFormat Currency Format Helper
DataStructureArray Array Data Structure helper
DataStructure Factory class for creating Data Structure Helper objects
DataStructureString String Data Structure helper
SettingsProcessor Settings Processor Helper
TextParser Wrapper for text parsers
Widget Simplifies the creation of widget interfaces
WidgetClient Simplifies the creation of widgets for the client interface
AutoCancelServices
AutoCancelSettings
BillingOverviewSettings Billing Overview settings
BillingOverviewStatistics Billing Overview statistics
ClientDocumentsFiles Client Documents Files model
CmsPages CMS Pages
DomainsDomains Domain Manager TLDs Management Model
DomainsTlds Domain Manager TLDs Management Model
DownloadManagerCategories Download Manager Categories
DownloadManagerFiles Download Manager Files
DownloadManagerLogs Download Manager Logs
DownloadManagerUrls Download Manager Files
ExtensionGeneratorExtensions Extension Generator Extension Management
FeedReaderFeeds
ClientexecClients Generic Clientexec Clients Migrator.
ClientexecCoupons Generic Clientexec Coupons Migrator.
ClientexecCurrencies Generic Clientexec Currencies Migrator.
ClientexecInvoices Generic Clientexec Invoices Migrator.
ClientexecKnowledgeBase Generic Clientexec Knowledge Base Migrator.
ClientexecProducts Generic Clientexec Products Migrator.
ClientexecServices Generic Clientexec Services Migrator.
ClientexecSettings Generic Clientexec Settings Migrator.
ClientexecSupportDepartments Generic Clientexec Support Departments Migrator.
ClientexecSupportTickets Generic Clientexec Support tickets Migrator.
ClientexecTaxes Generic Clientexec Taxes Migrator.
ClientexecTransactions Generic Clientexec Transactions Migrator.
ClientexecUsers Generic Clientexec Users Migrator.
CsvParser Generic CSV Parser Migrator.
WhmcsAccounts
WhmcsAdmins
WhmcsAffiliates
WhmcsCalendar
WhmcsClients
WhmcsConfiguration
WhmcsContacts
WhmcsCurrencies
WhmcsEmails
WhmcsInvoices
WhmcsKnowledgeBase WHMCS Knowledge Base
WhmcsProducts Fetch Products, TLDs, Product Pricing, and TLD Pricing
WhmcsServices
WhmcsSupportDepartments
WhmcsSupportTickets
WhmcsTaxes
WhmcsAccounts
WhmcsAdmins
WhmcsAffiliates
WhmcsCalendar
WhmcsClients
WhmcsConfiguration
WhmcsContacts
WhmcsCreditcards
WhmcsCurrencies
WhmcsEmails
WhmcsInvoices
WhmcsKnowledgeBase WHMCS Knowledge Base
WhmcsPaymentGateways
WhmcsProducts Fetch Products, TLDs, Product Pricing, and TLD Pricing
WhmcsServices
WhmcsSupportDepartments
WhmcsSupportTickets
WhmcsTaxes
ImportManagerImporter Import Manager Importer
MassMailerClients MassMailerClients model
MassMailerEmails MassMailerEmails model
MassMailerExports MassMailerExports model
MassMailerJobs MassMailerJobs model
MassMailerSettings Mass Mailer settings
MassMailerTasks MassMailerTasks model
OrderAffiliateCompanySettings Order Affiliate Company Setting Management
OrderAffiliatePaymentMethods Order Affiliate Payment Method Management
OrderAffiliatePayouts Order Affiliate Payout Management
OrderAffiliateReferrals Order Affiliate Referral Management
OrderAffiliateSettings Order Affiliate Setting Management
OrderAffiliateStatistics Order Affiliate Statistics Management
OrderAffiliates Order Affiliate Management
OrderForms Order Form Management
OrderOrders Order Management
OrderSettings Order Settings
OrderStaffSettings Order Staff Settings
PhpidsLogs PHPIDS Logs
PhpidsSettings PHPIDS Settings
ReassignPricingPackages ReassignPricingPackages model
ReassignPricingServices ReassignPricingPackages model
SoftaculousQueuedServices SoftaculousQueuedServices model
SupportManagerDepartments SupportManagerDepartments model
SupportManagerKbArticles SupportManagerKbArticles model
SupportManagerKbCategories SupportManagerKbCategories model
SupportManagerResponses SupportManagerResponses model
SupportManagerSettings SupportManagerSettings model
SupportManagerStaff SupportManagerStaff model
SupportManagerTickets SupportManagerTickets model
SystemOverviewSettings System Overview settings
SystemOverviewStatistics System Overview statistics
SystemOverviewUsers System Overview Users
WebhooksEvents Webhook Events
WebhooksLogs Webhook Logs
WebhooksWebhooks Webhooks

Constants

K_PATH_CACHE
K_PATH_CACHE
VENDORWEBDIR
Constants

VENDORWEBDIR

public mixed VENDORWEBDIR = str_replace('/index.php', '', WEBDIR) . 'vendors/'

        
On this page

Search results