Reference

Core classes

Core classes are the helpers and value types the platform hands you alongside the models: the request, menus, queries, collections, money. Each class page lists its methods and what they return.

Template helpers

Every template receives a set of helper variables without a controller assigning them, among them $_request, $_response, $_url, $_currentSite, $_currentUser, $_siteData and $_string. Templates of the public site also get $_menu, $_query, $_globalComponents, $_forms, $_image and $_search. List views add $_pagination. See Global template variables for how to use them.

Collections and values

A member that returns many records returns a Collection: loop over it, count it, sort it and filter it. Money and Number are value types for prices and exact arithmetic. Money is immutable: arithmetic returns a new amount and checks that the currencies match.

Request and response

The current request and the response being built, with the string and image helpers.

Start with Request Response Str Image

Reading content

Fetch records, menus, global components, site data, forms and search results from any template.

Start with Query Menu GlobalComponents SiteData Form SearchWidget

Site and user

The site being viewed and the person signed in.

Start with Auth\Site Auth\User CurrentUser

Collections and paging

Lists of records, the single record wrapper, and paging through long lists.

Start with Collection Model ReadOnlyCollection Pagination PaginationPage

Values and images

Money and exact numbers, and an image after it has been resized or transformed.

Start with Money Number TransformedImage

API and jobs

A record's layout areas as the API returns them, and the data the actions of a job's loop share.

Start with AreasContent LoopElementRunData

These six groups hold every documented class.

Objects ReferenceGenerated from the platform, so it is always current

API ReferenceEvery REST endpoint, in cURL, PHP, Python and JavaScript