FieldtypeCheckbox class

This Fieldtype stores an ON/OFF toggle via a single checkbox. The ON value is 1 and OFF value is 0.

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

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
FieldtypeCheckbox::getBlankValue(Page $page, Field $field)
int

Get blank value for field

 
FieldtypeCheckbox::getCompatibleFieldtypes(Field $field)
Fieldtypes null

Get an array of Fieldtypes that are compatible with this one

FieldtypeCheckbox::getDatabaseSchema(Field $field)
array

Get database schema for field

 
FieldtypeCheckbox::getInputfield(Page $page, Field $field)
InputfieldCheckbox

Get Inputfield for field

 
FieldtypeCheckbox::getMatchQuery($query, string $table, string $subfield, string $operator, mixed $value)
DatabaseQuery DatabaseQuerySelect

Get match query for PageFinder

 
FieldtypeCheckbox::getSelectorInfo(Field $field)
array

Return array with information about what properties and operators can be used with this field

FieldtypeCheckbox::markupValue(Page $page, Field $field)
string

Get markup value for field

FieldtypeCheckbox::sanitizeValue(Page $page, Field $field, mixed $value)
int

Sanitize value for field

 

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.252