Skip to content

api-reference.md

Latest commit

 

History

History
23 lines (18 loc) · 848 Bytes

api-reference.md

File metadata and controls

23 lines (18 loc) · 848 Bytes

API reference

Reference for the classes and helpers used in the examples, grouped by topic.

Topics

  • Registration: the acp/data-sources/register hook, DataSource, DataSourceId, DataSourceRegistry, Entry, and the Facade\DataSource / Facade\Entry shortcuts.
  • Tables: resolving a database table and filtering which columns it exposes (Facade\Table, Resolver, Filter\Name).
  • Columns: configuring columns (Config\Columns), label resolvers, column types (TextType, DateTimeType, ...), and ToggleOptions.
  • Relations: joining two Data Sources (Facade\Relation\Table, Facade\Relation\Attribute, Facade\Relations).

Conventions

Methods that return self are immutable. They return a cloned instance with the change applied.