UserSearchInterface

API reference › Debug › models › search › UserSearchInterface

interface	yii\debug\models\search\UserSearchInterface
Source	src/models/search/UserSearchInterface.php

Implemented by 1 type

• UserSearch

Contract for filter models backing the User Switch panel’s search form.

Implementations expose a single search() method that returns a DataProviderInterface over the candidate identities filtered by the submitted request parameters.

Methods

Method	Description	Defined by
search() abstract	Returns a data provider over the identity records, filtered by the submitted search parameters.	UserSearchInterface

Method details

search()

abstract public function search(array<int|string, mixed> $params): yii\data\DataProviderInterface

Returns a data provider over the identity records, filtered by the submitted search parameters.

Parameters

Parameter	Type	Description
$params	array<int|string, mixed>	Raw request parameters consumed by the implementing model.

Returns

yii\data\DataProviderInterface: Provider over the matching identity records.