LanguagesPageFieldValue class

Serves as a multi-language value placeholder for field values that contain a value in more than one language.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the LanguagesPageFieldValue class also inherits all the methods and properties of: Wire.

Common
For hooks

Common

Name	Return	Summary
LanguagesPageFieldValue::getArray() LanguagesPageFieldValue::getArray() LanguagesPageFieldValue::getArray()	`array`	Get array of language values stored in here
LanguagesPageFieldValue::getDefaultValue() LanguagesPageFieldValue::getDefaultValue() LanguagesPageFieldValue::getDefaultValue()	`string`	Returns the value in the default language
LanguagesPageFieldValue::getField() LanguagesPageFieldValue::getField() LanguagesPageFieldValue::getField()	`Field` `null`	Get field that value is for
LanguagesPageFieldValue::getHash() LanguagesPageFieldValue::getHash() LanguagesPageFieldValue::getHash(bool $verbose = false)	`string`	Get hash of all language values stored in here
LanguagesPageFieldValue::getIterator() LanguagesPageFieldValue::getIterator() LanguagesPageFieldValue::getIterator()	`ArrayObject`	Allows iteration of the languages values
LanguagesPageFieldValue::getLanguageValue() LanguagesPageFieldValue::getLanguageValue($languageID) LanguagesPageFieldValue::getLanguageValue($languageID)	`string` `mixed`	Given a language, returns the value in that language
LanguagesPageFieldValue::getNonEmptyValue() LanguagesPageFieldValue::getNonEmptyValue() LanguagesPageFieldValue::getNonEmptyValue(string $failValue = '')	`string`	Get non-empty value in this order: current lang, default lang, other lang, failValue
LanguagesPageFieldValue::getPage() LanguagesPageFieldValue::getPage() LanguagesPageFieldValue::getPage()	`Page` `null`	Get page that value is for
LanguagesPageFieldValue::setField() LanguagesPageFieldValue::setField(Field $field) LanguagesPageFieldValue::setField(Field $field)	None	Set field that value is for
LanguagesPageFieldValue::setFromInputfield() LanguagesPageFieldValue::setFromInputfield(Inputfield $inputfield) LanguagesPageFieldValue::setFromInputfield(Inputfield $inputfield)	None	Grab language values from Inputfield and populate to this object
LanguagesPageFieldValue::setLanguageValue() LanguagesPageFieldValue::setLanguageValue($languageID, mixed $value) LanguagesPageFieldValue::setLanguageValue($languageID, mixed $value)	`$this`	Sets the value for a given language
LanguagesPageFieldValue::setLanguageValues() LanguagesPageFieldValue::setLanguageValues(array $values) LanguagesPageFieldValue::setLanguageValues(array $values, bool $reset = false)	`self`	Set multiple language values at once
LanguagesPageFieldValue::setPage() LanguagesPageFieldValue::setPage(Page $page) LanguagesPageFieldValue::setPage(Page $page)	None	Set page that value is for
LanguagesPageFieldValue::setToInputfield() LanguagesPageFieldValue::setToInputfield(Inputfield $inputfield) LanguagesPageFieldValue::setToInputfield(Inputfield $inputfield)	None	Populate language values from this object to given Inputfield
LanguagesPageFieldValue::wired() LanguagesPageFieldValue::wired() LanguagesPageFieldValue::wired()	None	Wired to API

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
LanguagesPageFieldValue::getStringValue() LanguagesPageFieldValue::getStringValue() LanguagesPageFieldValue::getStringValue()	`string`	Get string value (for hooks)

Additional methods and properties

In addition to the methods and properties above, LanguagesPageFieldValue also inherits the methods and properties of these classes:

Wire

API reference based on ProcessWire core version 3.0.251