Skip to content

UserAttributesMapper ​

Type
Class
Namespace
craft\auth\sso\mapper
Inherits
craft\auth\sso\mapper\UserAttributesMapper » yii\base\BaseObject
Implements
craft\auth\sso\mapper\UserMapInterface, yii\base\Configurable
Since
5.3.0

Set multiple User attributes

View source

Public Properties ​

PropertyDescription
_attributescraft\auth\sso\mapper\UserMapInterface[]
attributesarray
defaultAttributeClassstring

_attributes ​

Type
craft\auth\sso\mapper\UserMapInterface[]
Default value
[]

View source

attributes ​

Type
array
Default value
null
Access
Write-only

View source

defaultAttributeClass ​

Type
string
Default value
\craft\auth\sso\mapper\IdpAttributeUserMapper::class

View source

Public Methods ​

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns the value of an object property.
__invoke()
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
setAttributes()

__invoke() ​

View source

Arguments ​

Returns ​

craft\elements\User

setAttributes() ​

View source

Arguments ​

Returns ​

$this

Throws ​