class EntryLanguageApi

package api.backend

implements SwitchContext

@:directlyUsed@:build(api.macro.PHPInterface.build())@:autoBuild(api.macro.PHPInterface.build())@:build(safety.macro.SafeAst.build())@:keep

Contains entry information for a certain language. Field data can be found in its versions.

Constructor

@:keepnew (lang:EntryLanguage)

Variables

@:keepread onlyfull_path:String

Full url slug based on parent paths

@:keepread onlyhasPublishedVersion:Bool

Check if this language has a published version

@:keepread onlylanguageKey:String

The language key (eg. "en")

@:keepread onlypath:String

Url slug based on the title

@:keepread onlytitle:String

The entry title for this language, is derived from the currently published version

@:keepread onlyversions:Array<EntryVersionApi>

Get all versions for this language

Methods

@:value({ empty : false })@:keepcreateNewVersion (empty:Bool = false):EntryVersionApi

Create a new version for this language. Use the EntryVersionApi methods to change the version data, afterwards save and publish the version.

If empty is true, the new version holds no data. If false, the new version's data is populated from the currently published version for this language.

@:keepgetPublishedVersion ():EntryVersionApi

Get the currently published version

@:keepgetVersion (id:Int):EntryVersionApi

Get a version by its ID

@:value({ removeEntryIfLast : false })@:keepremove (removeEntryIfLast:Bool = false):Void

Remove this language