MediaWiki\RecentChanges\ChangesListQuery\FieldEqualityCondition Class Reference

A filter condition module which uses equals or not-equals operators. More...

Inherits MediaWiki\RecentChanges\ChangesListQuery\ChangesListConditionBase.

Collaboration diagram for MediaWiki\RecentChanges\ChangesListQuery\FieldEqualityCondition:

Public Member Functions
	__construct (private $fieldName, private $isNullable=false,)
	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 filter condition module which uses equals or not-equals operators.

Access: internal

For use by ChangesListQuery

Since

1.45

Definition at line 15 of file FieldEqualityCondition.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\RecentChanges\ChangesListQuery\FieldEqualityCondition::__construct	(	private	$fieldName,
		private	$isNullable = false )

Parameters

string	$fieldName	The field name
bool	$isNullable	Whether the field is nullable

Definition at line 20 of file FieldEqualityCondition.php.

Member Function Documentation

evaluate()

MediaWiki\RecentChanges\ChangesListQuery\FieldEqualityCondition::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 36 of file FieldEqualityCondition.php.

prepareCapture()

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

protected

Definition at line 41 of file FieldEqualityCondition.php.

References MediaWiki\RecentChanges\ChangesListQuery\QueryBackend\fields().

prepareConds()

MediaWiki\RecentChanges\ChangesListQuery\FieldEqualityCondition::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

IReadableDatabase	$dbr
QueryBackend	$query

Reimplemented from MediaWiki\RecentChanges\ChangesListQuery\ChangesListConditionBase.

Definition at line 46 of file FieldEqualityCondition.php.

References Wikimedia\Rdbms\IReadableDatabase\expr(), MediaWiki\RecentChanges\ChangesListQuery\QueryBackend\forceEmptySet(), and MediaWiki\RecentChanges\ChangesListQuery\QueryBackend\where().

validateValue()

MediaWiki\RecentChanges\ChangesListQuery\FieldEqualityCondition::validateValue

(

$value

)

Validate a value and return its normalized form.

Parameters

mixed

$value

Returns

mixed

Implements MediaWiki\RecentChanges\ChangesListQuery\ChangesListCondition.

Definition at line 27 of file FieldEqualityCondition.php.

---

The documentation for this class was generated from the following file:

• includes/RecentChanges/ChangesListQuery/FieldEqualityCondition.php