FieldtypeCheckbox::getMatchQuery() method

Get match query for PageFinder

Possible template method: If overridden, children do not need to call this method if they update the $query themselves.

Note the following additional properties are available from the $query argument:

  • $query->field (Field): Field instance that being referred to match.
  • $query->group (string): Original group of the field in the selector (when applicable).
  • $query->selector (Selector): Original Selector object (matching the $field).
  • $query->selectors (Selectors): Original Selectors object (matching $field and others).
  • $query->parentQuery (DatabaseQuerySelect): Parent database query that $query will be merged into.
  • $query->pageFinder (PageFinder): The PageFinder instance that initiated the query, for additional info.

Usage

$databaseQuery = $fieldtypeCheckbox->getMatchQuery($query, string $table, string $subfield, string $operator, mixed $value);

Arguments

NameType(s)Description
queryPageFinderDatabaseQuerySelect, DatabaseQuerySelect
tablestring

The table name to use

subfieldstring

Name of the subfield (typically 'data', unless selector explicitly specified another)

operatorstring

The comparison operator.

  • This base Fieldtype class accepts only database operators (=, !=, >, >=, <, <=, &).
  • Other Fieldtypes may choose to accept more operators according to need of Fieldtype.
valuemixed

Value to find.

  • If given array, this base Fieldtype class (only) will match via OR condition. (3.0.182+)
  • Other Fieldtypes may choose to interpret array values differently according need of Fieldtype.

Return value

DatabaseQuery DatabaseQuerySelect

$query

Exceptions

Method can throw exceptions on error:

  • WireException


FieldtypeCheckbox methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

  • ProcessWire Weekly #582
    The 582nd issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 5 July 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits