LocalizationModel
extends BaseModel
in package
Represents and manages plugin localization files.
Tags
Table of Contents
- $exists : bool
- $language : mixed
- $originalLanguage : mixed
- $strings : mixed
- $fillable : mixed
- $originalStringArray : mixed
- $pluginCodeObj : PluginCode
- $updatedData : mixed
- $validationMessages : mixed
- $validationRules : mixed
- copyStringsFrom() : mixed
- createStringAndSave() : mixed
- deleteModel() : mixed
- fill() : mixed
- getDefaultLanguage() : mixed
- getModelPluginName() : mixed
- getOriginalStringsArray() : mixed
- getPluginCodeObj() : mixed
- getPluginRegistryData() : mixed
- initContent() : mixed
- initModel() : mixed
- isNewModel() : mixed
- languageFileExists() : mixed
- listPluginLanguages() : mixed
- load() : mixed
- save() : mixed
- setPluginCode() : mixed
- Sets a string code of a plugin the model is associated with
- setPluginCodeObj() : mixed
- Sets a code object of a plugin the model is associated with
- validate() : mixed
- checkKeyWritable() : mixed
- convertToSectionsArray() : mixed
- convertToStringsArray() : mixed
- createStringSections() : mixed
- getFilePath() : mixed
- getSanitizedPHPStrings() : mixed
- modelToLanguageFile() : mixed
- validateBeforeCreate() : mixed
- validateFileContents() : mixed
- validateLanguage() : mixed
Properties
$exists
public
bool
$exists
= false
This property is used by the system internally.
$language
public
mixed
$language
$originalLanguage
public
mixed
$originalLanguage
$strings
public
mixed
$strings
$fillable
protected
static mixed
$fillable
= ['strings', 'language']
$originalStringArray
protected
mixed
$originalStringArray
= []
$pluginCodeObj
protected
PluginCode
$pluginCodeObj
= null
The plugin code object the model is associated with.
$updatedData
protected
mixed
$updatedData
= []
$validationMessages
protected
mixed
$validationMessages
= []
$validationRules
protected
mixed
$validationRules
= ['language' => ['required', 'regex:/^[a-z0-9\.\-]+$/i']]
Methods
copyStringsFrom()
public
copyStringsFrom(mixed $destinationText, mixed $sourceLanguageCode) : mixed
Parameters
- $destinationText : mixed
- $sourceLanguageCode : mixed
Return values
mixed —createStringAndSave()
public
createStringAndSave(mixed $stringKey, mixed $stringValue) : mixed
Parameters
- $stringKey : mixed
- $stringValue : mixed
Return values
mixed —deleteModel()
public
deleteModel() : mixed
Return values
mixed —fill()
public
fill(array<string|int, mixed> $attributes) : mixed
Parameters
- $attributes : array<string|int, mixed>
Return values
mixed —getDefaultLanguage()
public
static getDefaultLanguage() : mixed
Return values
mixed —getModelPluginName()
public
getModelPluginName() : mixed
Return values
mixed —getOriginalStringsArray()
public
getOriginalStringsArray() : mixed
Return values
mixed —getPluginCodeObj()
public
getPluginCodeObj() : mixed
Return values
mixed —getPluginRegistryData()
public
static getPluginRegistryData(mixed $pluginCode, mixed $subtype) : mixed
Parameters
- $pluginCode : mixed
- $subtype : mixed
Return values
mixed —initContent()
public
initContent() : mixed
Return values
mixed —initModel()
public
static initModel(mixed $pluginCode, mixed $language) : mixed
Parameters
- $pluginCode : mixed
- $language : mixed
Return values
mixed —isNewModel()
public
isNewModel() : mixed
Return values
mixed —languageFileExists()
public
static languageFileExists(mixed $pluginCode, mixed $language) : mixed
Parameters
- $pluginCode : mixed
- $language : mixed
Return values
mixed —listPluginLanguages()
public
static listPluginLanguages(mixed $pluginCodeObj) : mixed
Parameters
- $pluginCodeObj : mixed
Return values
mixed —load()
public
load(mixed $language) : mixed
Parameters
- $language : mixed
Return values
mixed —save()
public
save() : mixed
Return values
mixed —setPluginCode()
Sets a string code of a plugin the model is associated with
public
setPluginCode(string $code) : mixed
Parameters
- $code : string
-
Specifies the plugin code
Return values
mixed —setPluginCodeObj()
Sets a code object of a plugin the model is associated with
public
setPluginCodeObj(PluginCode $obj) : mixed
Parameters
- $obj : PluginCode
-
Specifies the plugin code object
Return values
mixed —validate()
public
validate() : mixed
Return values
mixed —checkKeyWritable()
protected
checkKeyWritable(mixed $stringKey, mixed $existingStrings, mixed $languagePrefix) : mixed
Parameters
- $stringKey : mixed
- $existingStrings : mixed
- $languagePrefix : mixed
Return values
mixed —convertToSectionsArray()
protected
static convertToSectionsArray(mixed $stringsArray[, mixed $currentKey = '' ]) : mixed
Parameters
- $stringsArray : mixed
- $currentKey : mixed = ''
Return values
mixed —convertToStringsArray()
protected
static convertToStringsArray(mixed $stringsArray, mixed $prefix[, mixed $currentKey = '' ]) : mixed
Parameters
- $stringsArray : mixed
- $prefix : mixed
- $currentKey : mixed = ''
Return values
mixed —createStringSections()
protected
static createStringSections(mixed &$arr, mixed $path, mixed $value) : mixed
Parameters
- $arr : mixed
- $path : mixed
- $value : mixed
Return values
mixed —getFilePath()
protected
getFilePath([mixed $language = null ]) : mixed
Parameters
- $language : mixed = null
Return values
mixed —getSanitizedPHPStrings()
protected
getSanitizedPHPStrings(mixed $strings) : mixed
Parameters
- $strings : mixed
Return values
mixed —modelToLanguageFile()
protected
modelToLanguageFile() : mixed
Return values
mixed —validateBeforeCreate()
protected
validateBeforeCreate() : mixed
Return values
mixed —validateFileContents()
protected
validateFileContents(mixed $path) : mixed
Parameters
- $path : mixed
Return values
mixed —validateLanguage()
protected
validateLanguage(mixed $language) : mixed
Parameters
- $language : mixed