Platform Integration

This chapter covers the instantiable classes that connect Zymba to the ZeyOS platform. Unlike the static classes in the Standard Library (accessed with @Class.method()), platform classes are instantiated with new.

ZeyOS platform constants

The @ZeyOS class exposes platform-level constants available in every service:

Constant	Description
@ZeyOS.BASEURL	Base URL of the ZeyOS instance
@ZeyOS.EXTURL	External URL
@ZeyOS.VERSION	ZeyOS version string
@ZeyOS.LICENSEKEY	License key

Platform class overview

Class	Purpose
@ZeyOS	Core platform: database, session, config, logging
@SQL	Query preparation and parameterization (static)
@SQL.Connection	Database operations: fetch, insert, delete, transactions
@ZeyOS.Object	ORM-like access to ZeyOS entities (28 methods)
@ZeyOS.ObjectTransaction	Transaction document management (17 methods)
@ZeyOS.TransactionContext	Database transaction context manager
@ZeyOS.ObjectUser	User management and permissions (19 methods)
@ZeyOS.ExtData	Extended custom fields on entities (12 methods)
@ZeyOS.Tags	Entity tagging (12 methods)
@ZeyOS.NumFormat	Auto-incrementing document numbers (6 methods)
@ZeyOS.BinFile	Binary file storage (6 methods)
@ZeyOS.TempFile	Temporary file management (10 methods)
@ZeyOS.KeyAuth	API key authentication (2 methods)
@Mail.SimpleMessage	Plain text email
@Mail.MultipartMessage	HTML email with attachments
@FTP.Client	FTP operations (30 methods)
@REST.Client	REST API client (6 methods)
@SOAP.Client	SOAP web service client (8 methods)
@ZIP.Archive	ZIP file manipulation (30 methods)

See also

• Database — @ZeyOS core, @SQL static, @SQL.Connection
• Entities — @ZeyOS.Object, @ZeyOS.ObjectTransaction, user management, ext data
• Mail and External Services — mail, FTP, REST/SOAP, ZIP