CoolCMS API

DTO

Table of Contents

Classes

EmailRecipientDTO
One recipient of a bulk email. Each recipient has an own language, template values, reply-to addresses and attachments; the message always leaves from the server `from` address, but replies may go to a different address.
GeocodingCacheEntry
One row of `cms_system_geocoding_cache`.
GeocodingCacheKey
Key of a `cms_system_geocoding_cache` row: `query_hash = sha1(country | normalized address)`, unique.
GeocodingLookup
Result of a query to the external geocoder or to `cms_system_geocoding_cache`.
GeocodingMiss
No coordinates were produced when saving an advert: the caller keeps the old values and writes a row to `log/geocoding-miss.log`.
GeocodingRequest
Input of the advert coordinates calculation on save.
GeocodingResult
A point and where it came from. The source serves tests and the harness. When no point was produced, Api `GeocodingManager::resolveForAddress()` returns {@see GeocodingMiss} instead (the reason goes to the log).
GeocodingSearchRequest
Input of the "within X km of" filter point calculation.
GeoCoordinates
Geographic point (WGS84): a municipality center from `cms_system_regions`, a Google result or a cache hit.
MetaDataDTO
OgDataDTO
OgImageDTO
RegionLocality
Data of one region node needed to validate a selection and to split an advert address into city / postcode / country on save.
RegionSuggestItem
One item of the municipality/postcode suggester. Plain data: it crosses the bridge as an array ({@see toArray()} / {@see fromArray()}); `Result::data` must not carry an entity.
RegionSuggestQuery
Query of the municipality/postcode suggester.
RegionSuggestResult
Result of the suggester: items plus a flag that Api rejected the query by rate limit (the calling signal then returns HTTP 429 instead of an empty list).
On this page

Search results