Property Details

$admin public property #

Whether to only return users that are admins.

public boolean $admin = false

$can public property #

The permission that the resulting users must have.

public string, integer, false, null $can = null

$client public property #

Whether to only return the client user.

public boolean $client = false

$email public property #

The email address that the resulting users must have.

public string, string[], null $email = null

$firstName public property #

The first name that the resulting users must have.

public string, string[], null $firstName = null

$groupId public property #

The tag group ID(s) that the resulting users must be in.

public integer, integer[], null $groupId = null

$lastLoginDate public property #

The date that the resulting users must have last logged in.

public mixed $lastLoginDate = null

$lastName public property #

The last name that the resulting users must have.

public string, string[], null $lastName = null

$username public property #

The username that the resulting users must have.

public string, string[], null $username = null

Method Details

__construct() public method #

Constructor

public void __construct ( $elementType, array $config = [] )

__set() public method #

Sets the value of a component property.

This method will check in the following order and act accordingly:

• a property defined by a setter: set the property value
• an event in the format of "on xyz": attach the handler to the event "xyz"
• a behavior in the format of "as xyz": attach the behavior named as "xyz"
• a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

public void __set ( $name, $value )

admin() public method #

Sets the admin() property.

public static admin ( \craft\elements\db\bool $value = true )

beforePrepare() protected method #

This method is called at the beginning of preparing an element query for the query builder.

The main Query object being prepared for the query builder is available via $query. The subselect’s Query object being prepared is available via $subQuery. The role of the subselect query is to apply conditions to the query and narrow the result set down to just the elements that should actually be returned. The role of the main query is to join in any tables that should be included in the results, and select all of the columns that should be included in the results.

protected boolean beforePrepare ( )

can() public method #

Sets the can() property.

public static can ( $value )

client() public method #

Sets the client() property.

public static client ( \craft\elements\db\bool $value = true )

email() public method #

Sets the email() property.

public static email ( $value )

firstName() public method #

Sets the firstName() property.

public static firstName ( $value )

group() public method #

Sets the groupId() property based on a given tag group(s)’s handle(s).

public static group ( $value )

groupId() public method #

Sets the groupId() property.

public static groupId ( $value )

lastLoginDate() public method #

Sets the lastLoginDate() property.

public static lastLoginDate ( $value )

lastName() public method #

Sets the lastName() property.

public static lastName ( $value )

statusCondition() protected method #

Returns the condition that should be applied to the element query for a given status.

For example, if you support a status called “pending”, which maps back to a pending database column that will either be 0 or 1, this method could do this:

protected function statusCondition($status)
{
    switch ($status) {
        case 'pending':
            return ['mytable.pending' => 1];
        default:
            return parent::statusCondition($status);
    }

protected string, array, yii\db\ExpressionInterface, false, null statusCondition ( \craft\elements\db\string $status )

username() public method #

Sets the username() property.

public static username ( $value )