☰ Browse the reference

Model·Common module

Language

A model in the Common module, with 10 members for templates, 8 API properties and 10 members for admin templates.

Common\Models\Frontend\LanguageCopy Common\Models\Api\LanguageCopy Common\Models\Backend\LanguageCopy Also in Common: Address AddressCustomFieldValue Area Category CategoryCustomFieldValue ClientLlmCredential CollectionElement Component ComponentArea ComponentCollection Content Country Currency CustomField CustomFieldValue CustomUrl EditLock GlobalComponent GlobalComponentRevision GlobalComponentRevisionArea ImportDeduplication InputType InputTypePossibleValue Layout LayoutArea LayoutAreaGroup LayoutCategory LayoutCustomFieldValue SeoSettings SeoSettingsCustomFieldValue Setting SettingValue State Tag TagCustomFieldValue Widget WidgetSetting WidgetSettingValue

View

Templates10 API & Jobs8 Admin10

What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Filter

Templates view

Properties 10

Take no arguments.

# getCountryCode()

string

Returns the country code based on the lcid value (the last part of that value is returned)

# getId()

?int

# getName()

string

# getCode()

string

# getLcid()

string

# isDefault()

bool

Returns if this is the default language for the site.

# isSupported()

bool

Returns if this language is in the site's supported set (the default is always considered supported).

# isNewRecord() Not in API & Jobs

bool

Check if the record is a new record

# isHierarchicalModel() Not in API & Jobs

bool

Check whether a model is a hierarchical model, i.e. can have children

# isVersionedModel() Not in API & Jobs

bool

Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 8

Read-only values on the record.

# countryCode

string

Returns the country code based on the lcid value (the last part of that value is returned)

# id

?int

# name

string

# code

string

# lcid

string

# default

bool

Returns if this is the default language for the site.

# supported

bool

Returns if this language is in the site's supported set (the default is always considered supported).

# displayProperty API & Jobs only

string

Get the display property to use

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 10

Take no arguments.

# getCountryCode()

string

Returns the country code based on the lcid value (the last part of that value is returned)

# getId()

?int

# getName()

string

# getCode()

string

# getLcid()

string

# isDefault()

bool

Returns if this is the default language for the site.

# isSupported()

bool

Returns if this language is in the site's supported set (the default is always considered supported).

# isNewRecord() Not in API & Jobs

bool

Check if the record is a new record

# isHierarchicalModel() Not in API & Jobs

bool

Check whether a model is a hierarchical model, i.e. can have children

# isVersionedModel() Not in API & Jobs

bool

Check whether a model is versioned