A tri-state boolean from a field of a potentially left-joined table. More...

Inherits MediaWiki\RecentChanges\ChangesListQuery\ChangesListConditionBase.

Collaboration diagram for MediaWiki\RecentChanges\ChangesListQuery\BooleanJoinFieldCondition:

[legend]

Public Member Functions

__construct (private string $fieldName, private string $tableName)

evaluate (stdClass $row, $value)

Evaluate the filter condition against a row, determining whether it is true or false.Ignore the values set with require() and exclude(), use only the value passed as a parameter.To ensure that $row has the required fields present, capture() must be called before evaluate(). This will signal to prepareQuery() that the fields should be added.

Parameters

stdClass	$row
mixed	$value	The validated value

Returns: bool

validateValue ( $value)

Validate a value and return its normalized form.

Parameters

mixed $value

Returns: mixed

Public Member Functions inherited from MediaWiki\RecentChanges\ChangesListQuery\ChangesListConditionBase

capture ()

Set a flag indicating that evaluate() will be called with rows from the query result.

isCaptured ()

Check whether capture() has been called.

Returns: bool

Public Member Functions inherited from MediaWiki\RecentChanges\ChangesListQuery\ChangesListCondition

exclude ( $value)

Add a value to the set of excluded values.

prepareQuery (IReadableDatabase $dbr, QueryBackend $query)

Add conditions and joins to the query in order to implement require() and exclude().

Protected Member Functions

prepareCapture (IReadableDatabase $dbr, QueryBackend $query)

prepareConds (IReadableDatabase $dbr, QueryBackend $query)

Add conditions to the query according to the values passed to require() and exclude().Subclasses may use getUniqueValuesWithUnion() to get the required and excluded values.

Parameters

IReadableDatabase	$dbr
QueryBackend	$query

Additional Inherited Members
Public Attributes inherited from MediaWiki\RecentChanges\ChangesListQuery\ChangesListConditionBase
	function

Public Attributes inherited from MediaWiki\RecentChanges\ChangesListQuery\ChangesListCondition
	function
	Add a value to the set of required values.

Protected Attributes inherited from MediaWiki\RecentChanges\ChangesListQuery\ChangesListConditionBase
array	$excluded = []

array	$required = []

Detailed Description

A tri-state boolean from a field of a potentially left-joined table.

May be either true, false or null.

Access: internal: For use by ChangesListQuery

Since: 1.45

Definition at line 16 of file BooleanJoinFieldCondition.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\RecentChanges\ChangesListQuery\BooleanJoinFieldCondition::__construct	(	private string	$fieldName,
		private string	$tableName )

Definition at line 17 of file BooleanJoinFieldCondition.php.

Member Function Documentation

◆ evaluate()

MediaWiki\RecentChanges\ChangesListQuery\BooleanJoinFieldCondition::evaluate	(	stdClass	$row,
			$value )

Evaluate the filter condition against a row, determining whether it is true or false.Ignore the values set with require() and exclude(), use only the value passed as a parameter.To ensure that $row has the required fields present, capture() must be called before evaluate(). This will signal to prepareQuery() that the fields should be added.

Parameters

stdClass	$row
mixed	$value	The validated value

Returns: bool

Implements MediaWiki\RecentChanges\ChangesListQuery\ChangesListCondition.

Definition at line 32 of file BooleanJoinFieldCondition.php.

◆ prepareCapture()

MediaWiki\RecentChanges\ChangesListQuery\BooleanJoinFieldCondition::prepareCapture	(	IReadableDatabase	$dbr,
		QueryBackend	$query )

protected

Definition at line 41 of file BooleanJoinFieldCondition.php.

References MediaWiki\RecentChanges\ChangesListQuery\QueryBackend\fields(), and MediaWiki\RecentChanges\ChangesListQuery\QueryBackend\joinForFields().

◆ prepareConds()

MediaWiki\RecentChanges\ChangesListQuery\BooleanJoinFieldCondition::prepareConds	(	IReadableDatabase	$dbr,
		QueryBackend	$query )

protected

Add conditions to the query according to the values passed to require() and exclude().Subclasses may use getUniqueValuesWithUnion() to get the required and excluded values.

Parameters