Arikaim CMS

Translations

Translations trait

Table of Contents

Properties

$currentLanguage  : string|null
Current language

Methods

bootTranslations()  : void
Boot trait.
findTranslation()  : Model|null
Find Translation
getCurrentLanguage()  : string
Get current language
getTranslatedAttributes()  : array<string|int, mixed>
Get translation attributes
getTranslationModelClass()  : string|null
Get translation miodel class
getTranslationReferenceAttributeName()  : string|null
Get translation refernce attribute name
getTranslationsQuery()  : Builder
Get translations query
removeTranslation()  : bool
Delete translation
removeTranslations()  : bool
Delete all translations
saveTranslation()  : Model|false
Create or update translation
setLanguage()  : void
Set language
translateAttribute()  : string|null
Return translated value
translateAttributes()  : bool
Translate attributes
translation()  : Model|false
Get translation model
translations()  : Relation|null
HasMany relation

Properties

$currentLanguage

Current language

protected string|null $currentLanguage

Methods

bootTranslations()

Boot trait.

public static bootTranslations() : void

findTranslation()

Find Translation

public findTranslation(string $attributeName, mixed $value[, string|null $language = null ]) : Model|null
Parameters
$attributeName : string
$value : mixed
$language : string|null = null
Return values
Model|null

getCurrentLanguage()

Get current language

public getCurrentLanguage() : string
Return values
string

getTranslatedAttributes()

Get translation attributes

public getTranslatedAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTranslationModelClass()

Get translation miodel class

public getTranslationModelClass() : string|null
Return values
string|null

getTranslationReferenceAttributeName()

Get translation refernce attribute name

public getTranslationReferenceAttributeName() : string|null
Return values
string|null

getTranslationsQuery()

Get translations query

public getTranslationsQuery([string|null $language = null ]) : Builder
Parameters
$language : string|null = null
Return values
Builder

removeTranslation()

Delete translation

public removeTranslation([string|int|null $id = null ][, string|null $language = null ]) : bool
Parameters
$id : string|int|null = null
$language : string|null = null
Return values
bool

removeTranslations()

Delete all translations

public removeTranslations([string|int|null $id = null ]) : bool
Parameters
$id : string|int|null = null
Return values
bool

saveTranslation()

Create or update translation

public saveTranslation(array<string|int, mixed> $data[, string|null $language = null ][, string|int|null $id = null ]) : Model|false
Parameters
$data : array<string|int, mixed>
$language : string|null = null
$id : string|int|null = null
Return values
Model|false

setLanguage()

Set language

public setLanguage(string|null $language) : void
Parameters
$language : string|null

translateAttribute()

Return translated value

public translateAttribute(string $attribute[, string|null $language = null ]) : string|null
Parameters
$attribute : string
$language : string|null = null
Return values
string|null

translateAttributes()

Translate attributes

public translateAttributes(string $language) : bool
Parameters
$language : string
Return values
bool

translation()

Get translation model

public translation([string|null $language = null ][, bool $query = false ]) : Model|false
Parameters
$language : string|null = null
$query : bool = false
Return values
Model|false

translations()

HasMany relation

public translations() : Relation|null
Return values
Relation|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results