Class craft\console\User

Inheritance: craft\console\User » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/console/User.php

The User component provides APIs for managing the user authentication status.

An instance of the User component is globally accessible in Craft via craft\base\ApplicationTrait::getUser().

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	yii\base\BaseObject
`__clone()`	This method is called after the object is created by cloning an existing one.	yii\base\Component
`__construct()`	Constructor.	yii\base\BaseObject
`__get()`	Returns the value of an object property.	yii\base\BaseObject
`__isset()`	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
`__set()`	Sets value of an object property.	yii\base\BaseObject
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`attachBehavior()`	Attaches a behavior to this component.	yii\base\Component
`attachBehaviors()`	Attaches a list of behaviors to the component.	yii\base\Component
`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\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`checkPermission()`	Returns whether the current user has a given permission.	craft\console\User
`className()`	Returns the fully qualified name of this class.	yii\base\BaseObject
`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
`getBehavior()`	Returns the named behavior object.	yii\base\Component
`getBehaviors()`	Returns all behaviors attached to this component.	yii\base\Component
`getId()`	Returns the current user’s ID, if they are logged in.	craft\console\User
`getIdentity()`	Returns the current identity object.	craft\console\User
`getIsAdmin()`	Returns whether the current user is an admin.	craft\console\User
`getIsGuest()`	Returns whether the current user is a guest (not authenticated).	craft\console\User
`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\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`init()`	Initializes the object.	yii\base\BaseObject
`off()`	Detaches an existing event handler from this component.	yii\base\Component
`on()`	Attaches an event handler to an event.	yii\base\Component
`setIdentity()`	Sets the user identity object.	craft\console\User
`trigger()`	Triggers an event.	yii\base\Component

Method Details

`checkPermission()` public method #

Returns whether the current user has a given permission.

public boolean checkPermission ( \craft\console\string $permissionName )

`$permissionName`	string	The name of the permission.
return	boolean	Whether the current user has the permission.

`getId()` public method #

Returns the current user’s ID, if they are logged in.

`getIdentity()` public method #

Returns the current identity object.

public craft\elements\User, yii\web\IdentityInterface, false, null getIdentity ( )

`getIsAdmin()` public method #

Returns whether the current user is an admin.

public boolean getIsAdmin ( )

return	boolean	Whether the current user is an admin.

`getIsGuest()` public method #

Returns whether the current user is a guest (not authenticated).

public boolean getIsGuest ( )

return	boolean	Whether the current user is a guest.

`setIdentity()` public method #

Sets the user identity object.

public void setIdentity ( yii\web\IdentityInterface $identity = null )

`$identity`	yii\web\IdentityInterface, null	The identity object. If null, it means the current user will be a guest without any associated identity.
throws	yii\base\InvalidValueException	If `$identity` object does not implement yii\web\IdentityInterface.

Method Details

checkPermission() public method #

getId() public method #

getIdentity() public method #

getIsAdmin() public method #