FieldtypeMulti class

Located in file /wire/core/FieldtypeMulti.php

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

Common

Name	Return	Summary
FieldtypeMulti::deletePageFieldRows() FieldtypeMulti::deletePageFieldRows(Page $page, Field $field, $value) FieldtypeMulti::deletePageFieldRows(Page $page, Field $field, $value)	`int`
FieldtypeMulti::getBlankValue() FieldtypeMulti::getBlankValue(Page $page, Field $field) FieldtypeMulti::getBlankValue(Page $page, Field $field)	`WireArray`	Per Fieldtype interface, return a blank value of this Fieldtype
FieldtypeMulti::getCompatibleFieldtypes() FieldtypeMulti::getCompatibleFieldtypes(Field $field) FieldtypeMulti::getCompatibleFieldtypes(Field $field)	`Fieldtypes` `null`	Get an array of Fieldtypes that are compatible with this one (i.e. ones the user may change the type to)
FieldtypeMulti::getDatabaseSchema() FieldtypeMulti::getDatabaseSchema(Field $field) FieldtypeMulti::getDatabaseSchema(Field $field)	`array`	Modify the default schema provided by Fieldtype to include a 'sort' field, and integrate that into the primary key.
FieldtypeMulti::getLoadQueryAutojoin() FieldtypeMulti::getLoadQueryAutojoin(Field $field, DatabaseQuerySelect $query) FieldtypeMulti::getLoadQueryAutojoin(Field $field, DatabaseQuerySelect $query)	`DatabaseQuerySelect` `null`	Return the query used for Autojoining this field (if different from getLoadQuery) or NULL if autojoin not allowed.
FieldtypeMulti::getMatchQuery() FieldtypeMulti::getMatchQuery(PageFinderDatabaseQuerySelect $query, string $table, string $subfield, string $operator, mixed $value) FieldtypeMulti::getMatchQuery(PageFinderDatabaseQuerySelect $query, string $table, string $subfield, string $operator, mixed $value)	`PageFinderDatabaseQuerySelect` `DatabaseQuerySelect`	Get the query that matches a Fieldtype table's data with a given value
FieldtypeMulti::getSelectorInfo() FieldtypeMulti::getSelectorInfo(Field $field) FieldtypeMulti::getSelectorInfo(Field $field, array $data = [])	`array`	Return array with information about what properties and operators can be used with this field
FieldtypeMulti::sanitizeValue() FieldtypeMulti::sanitizeValue(Page $page, Field $field, mixed $value) FieldtypeMulti::sanitizeValue(Page $page, Field $field, mixed $value)	`WireArray`	Per the Fieldtype interface, sanitize the combined value for use in a Page
FieldtypeMulti::savePageField() FieldtypeMulti::savePageField(Page $page, Field $field) FieldtypeMulti::savePageField(Page $page, Field $field)	`bool`	Per the Fieldtype interface, Save the given Field from the given Page to the database
FieldtypeMulti::savePageFieldRows() FieldtypeMulti::savePageFieldRows(Page $page, Field $field, $value) FieldtypeMulti::savePageFieldRows(Page $page, Field $field, $value)	`bool`
FieldtypeMulti::sleepValue() FieldtypeMulti::sleepValue(Page $page, Field $field, WireArray $value) FieldtypeMulti::sleepValue(Page $page, Field $field, WireArray $value)	`array`	Given an 'awake' value, as set by wakeupValue, convert the value back to a basic type for storage in DB.
FieldtypeMulti::wakeupValue() FieldtypeMulti::wakeupValue(Page $page, Field $field, array $value) FieldtypeMulti::wakeupValue(Page $page, Field $field, array $value)	`WireArray`	Process the value to convert it from array to whatever object it needs to be

Loading

Name	Return	Summary
FieldtypeMulti::getLoadQuery() FieldtypeMulti::getLoadQuery(Field $field, DatabaseQuerySelect $query) FieldtypeMulti::getLoadQuery(Field $field, DatabaseQuerySelect $query)	`DatabaseQuerySelect`	Return the query used for loading all parts of the data from this field.
FieldtypeMulti::loadPageField() FieldtypeMulti::loadPageField(Page $page, Field $field) FieldtypeMulti::loadPageField(Page $page, Field $field)	`array` `null`	Load the given page field from the database table and return the value.

Configuration

Name	Return	Summary
FieldtypeMulti::getConfigInputfields() FieldtypeMulti::getConfigInputfields(Field $field) FieldtypeMulti::getConfigInputfields(Field $field)	`InputfieldWrapper`	Get Inputfields for advanced settings of the Field and Fieldtype

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.244

Located in file /wire/core/FieldtypeMulti.php

Common

Loading

Configuration

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news