UserSwitch

API reference › Debug › models › UserSwitch

class	`yii\debug\models\UserSwitch`
Extends	`yii\base\Model` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\StaticInstanceInterface`, `IteratorAggregate`, `ArrayAccess`, `yii\base\Arrayable`, `yii\base\Configurable`
Uses traits	`yii\base\ArrayableTrait`, `yii\base\StaticInstanceTrait`
Source	`src/models/UserSwitch.php`

Backs the user-impersonation workflow by swapping the active session identity to another user.

Preserves the original identity in the session (main_user) so reset() can restore it once the impersonator is done. Every accessor resolves the user component lazily through getUser() so unit tests can inject a pre-built User instance into $userComponent.

Properties

Property	Type	Description	Defined by
`$activeValidators` read-only	`yii\validators\Validator[]`	The validators applicable to the current `$scenario`.	`yii\base\Model`
`$attributes`	`array<string, mixed>`	Attribute values (name => value).	`yii\base\Model`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$errors` read-only	`array<string, string[]>`	Errors for all attributes.	`yii\base\Model`
`$firstErrors` read-only	`array<string, string>`	The first errors.	`yii\base\Model`
`$iterator` read-only	`ArrayIterator<string, mixed>`	An iterator for traversing the items in the list.	`yii\base\Model`
`$mainUser` read-only	`yii\web\User`	User component carrying the original identity.	`UserSwitch`
`$scenario`	`string`	The scenario that this model is in.	`yii\base\Model`
`$user`	`yii\web\User`	Bound user component.	`UserSwitch`
`$userByIdentity` write-only	`yii\web\IdentityInterface`	Identity to impersonate.	`UserSwitch`
`$userComponent`	`string\|yii\web\User`	Component ID of the user component, or a `User` instance to operate on directly. Default: `'user'`.	`UserSwitch`
`$validators` read-only	`ArrayObject<int,` `yii\validators\Validator>\|yii\validators\Validator[]`	All the validators declared in the model.	`yii\base\Model`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Model`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`activeAttributes()`	Returns the attribute names that are subject to validation in the current scenario.	`yii\base\Model`
`addError()`	Adds a new error to the specified attribute.	`yii\base\Model`
`addErrors()`	Adds a list of errors.	`yii\base\Model`
`afterValidate()`	This method is invoked after validation ends.	`yii\base\Model`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`attributeHints()`	Returns the attribute hints.	`yii\base\Model`
`attributeLabels()`	Returns the labels shown for the switch form attributes.	`UserSwitch`
`attributes()`	Returns the list of attribute names.	`yii\base\Model`
`beforeValidate()`	This method is invoked before validation starts.	`yii\base\Model`
`behaviors()`	Returns a list of behaviors that this component should behave as.	`yii\base\Component`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`clearErrors()`	Removes errors for all attributes or a single attribute.	`yii\base\Model`
`createValidators()`	Creates validator objects based on the validation rules specified in `rules()`.	`yii\base\Model`
`detachBehavior()`	Detaches a behavior from the component.	`yii\base\Component`
`detachBehaviors()`	Detaches all behaviors from the component.	`yii\base\Component`
`ensureBehaviors()`	Makes sure that the behaviors declared in `behaviors()` are attached to this component.	`yii\base\Component`
`extraFields()`	Returns the list of fields that can be expanded further and returned by `toArray()`.	`yii\base\ArrayableTrait`
`fields()`	Returns the list of fields that should be returned by default by `toArray()` when no specific fields are specified.	`yii\base\Model`
`formName()`	Returns the form name that this model class should use.	`yii\base\Model`
`generateAttributeLabel()`	Generates a user friendly attribute label based on the give attribute name.	`yii\base\Model`
`getActiveValidators()`	Returns the validators applicable to the current `$scenario`.	`yii\base\Model`
`getAttributeHint()`	Returns the text hint for the specified attribute.	`yii\base\Model`
`getAttributeLabel()`	Returns the text label for the specified attribute.	`yii\base\Model`
`getAttributes()`	Returns attribute values.	`yii\base\Model`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getErrors()`	Returns the errors for all attributes or a single attribute.	`yii\base\Model`
`getErrorSummary()`	Returns the errors for all attributes as a one-dimensional array.	`yii\base\Model`
`getFirstError()`	Returns the first error of the specified attribute.	`yii\base\Model`
`getFirstErrors()`	Returns the first error of every attribute in the model.	`yii\base\Model`
`getIterator()`	Returns an iterator for traversing the attributes in the model.	`yii\base\Model`
`getMainUser()`	Returns the main user; the original identity captured on the first switch.	`UserSwitch`
`getScenario()`	Returns the scenario that this model is used in.	`yii\base\Model`
`getUser()`	Returns the user component bound to this switch model, resolving it lazily on first call.	`UserSwitch`
`getValidators()`	Returns all the validators declared in `rules()`.	`yii\base\Model`
`hasErrors()`	Returns a value indicating whether there is any validation error.	`yii\base\Model`
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	`yii\base\Component`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the object.	`yii\base\BaseObject`
`instance()` static	Returns static class instance, which can be used to obtain meta information.	`yii\base\StaticInstanceTrait`
`isAttributeActive()`	Returns a value indicating whether the attribute is active in the current scenario.	`yii\base\Model`
`isAttributeRequired()`	Returns a value indicating whether the attribute is required.	`yii\base\Model`
`isAttributeSafe()`	Returns a value indicating whether the attribute is safe for massive assignments.	`yii\base\Model`
`isMainUser()`	Returns whether the current identity is the main user (or a guest).	`UserSwitch`
`load()`	Populates the model with input data.	`yii\base\Model`
`loadMultiple()` static	Populates a set of models with the data from end user.	`yii\base\Model`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`offsetExists()`	Returns whether there is an element at the specified offset.	`yii\base\Model`
`offsetGet()`	Returns the element at the specified offset.	`yii\base\Model`
`offsetSet()`	Sets the element at the specified offset.	`yii\base\Model`
`offsetUnset()`	Sets the element value at the specified offset to null.	`yii\base\Model`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`onUnsafeAttribute()`	This method is invoked when an unsafe attribute is being massively assigned.	`yii\base\Model`
`reset()`	Restores the session to the main user captured before the first switch.	`UserSwitch`
`rules()`	Declares the validation rules applied to the switch form.	`UserSwitch`
`safeAttributes()`	Returns the attribute names that are safe to be massively assigned in the current scenario.	`yii\base\Model`
`scenarios()`	Returns a list of scenarios and the corresponding active attributes.	`yii\base\Model`
`setAttributes()`	Sets the attribute values in a massive way.	`yii\base\Model`
`setScenario()`	Sets the scenario for the model.	`yii\base\Model`
`setUser()`	Switches the session to the given user and tracks the main user id when impersonating.	`UserSwitch`
`setUserByIdentity()`	Switches the session to the user identified by `$identity`.	`UserSwitch`
`toArray()`	Converts the model into an array.	`yii\base\ArrayableTrait`
`trigger()`	Triggers an event.	`yii\base\Component`
`validate()`	Performs the data validation.	`yii\base\Model`
`validateMultiple()` static	Validates multiple models.	`yii\base\Model`
`extractFieldsFor()` protected	Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: “item.id” The previous example would extract “id”.	`yii\base\ArrayableTrait`
`extractRootFields()` protected	Extracts the root field names from nested fields.	`yii\base\ArrayableTrait`
`resolveFields()` protected	Determines which fields can be returned by `toArray()`.	`yii\base\ArrayableTrait`

Events

Event	Type	Description	Defined by
`EVENT_BEFORE_VALIDATE`	`yii\base\ModelEvent`	An event raised at the beginning of `validate()`. Event name: `'beforeValidate'`.	`yii\base\Model`
`EVENT_AFTER_VALIDATE`	`yii\base\Event`	An event raised at the end of `validate()` Event name: `'afterValidate'`.	`yii\base\Model`

Constants

Constant	Value	Description	Defined by
`SCENARIO_DEFAULT`	`'default'`	The name of the default scenario.	`yii\base\Model`

Method details

attributeLabels()

public function attributeLabels(): array<string, string>

Returns the labels shown for the switch form attributes.

Returns

array<string, string>: Form labels keyed by attribute name.

getMainUser()

public function getMainUser(): yii\web\User

Returns the main user; the original identity captured on the first switch.

Reads the captured id from the session when present; otherwise treats the current identity as the main one.

Returns

yii\web\User: User component carrying the original identity.

Throws

yii\base\InvalidConfigException: when the user component cannot be resolved.

getUser()

public function getUser(): yii\web\User

Returns the user component bound to this switch model, resolving it lazily on first call.

Returns

yii\web\User: Bound user component.

Throws

yii\base\InvalidConfigException: when the configured component ID does not resolve to a User instance.

isMainUser()

public function isMainUser(): bool

Returns whether the current identity is the main user (or a guest).

Returns

bool: true when the session runs as the main user or as a guest; false while impersonating.

Throws

yii\base\InvalidConfigException: when the user component cannot be resolved.

reset()

public function reset(): void

Restores the session to the main user captured before the first switch.

Throws

yii\base\InvalidConfigException: when the user component cannot be resolved.

rules()

public function rules(): array<int, array<int|string, mixed>>

Declares the validation rules applied to the switch form.

Returns

array<int, array<int|string, mixed>>: Validation rules consumed by Model::validate().

setUser()

public function setUser(yii\web\User $user): void

Switches the session to the given user and tracks the main user id when impersonating.

Parameters

Parameter	Type	Description
`$user`	`yii\web\User`	User component carrying the identity to switch to.

Throws

yii\base\InvalidConfigException: when the user component cannot be resolved.
RuntimeException: when the supplied user has no identity attached.

setUserByIdentity()

public function setUserByIdentity(yii\web\IdentityInterface $identity): void

Switches the session to the user identified by $identity.

Parameters

Parameter	Type	Description
`$identity`	`yii\web\IdentityInterface`	Identity to impersonate.

Throws

yii\base\InvalidConfigException: when the user component cannot be resolved.