BaseExternalProvider

Type

Abstract Class

Namespace

craft\auth\sso

Inherits

craft\auth\sso\BaseExternalProvider » craft\auth\sso\BaseProvider » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\auth\sso\ProviderInterface, craft\base\ComponentInterface, craft\base\ModelInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\auth\sso\ProviderTrait, craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Since

5.3.0

BaseExternalProvider provides a base implementation for external identity providers.

We should always trust an external provider; therefore we need to perform additional operations such as finding, populating and linking a Craft user.

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
assignUserGroups	callable, null –
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
cpLoginHtml	string, null
errors	array – Errors for all attributes or the specified attribute.
findUser	callable, null –
firstErrors	array – The first errors.
handle	string, null – Handle
idpUniqueIdentifier	callable, null –
iterator	ArrayIterator – An iterator for traversing the items in the list.
name	string, null – Name
populateUser	callable, null –
scenario	string – The scenario that this model is in.
siteLoginHtml	string, null
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

assignUserGroups

Type

callable, null

Default value

null

View source

---

Example

php

function(array $groupIds, array $data) {
    if (!$data['admin']) {
        unset($groupIds[2]);
    }

    return $groupIds;
}

cpLoginHtml

Type

string, null

Default value

null

Access

Read-only

View source

findUser

Type

callable, null

Default value

null

View source

---

Example

php

function(array $data) {
    return Craft::$app->getUsers()->getUserByUsernameOrEmail($data['email']);
}

idpUniqueIdentifier

Type

callable, null

Default value

null

View source

---

Example

php

function(array $data, string $default) {
    return $data['sub'] ?? $default
}

populateUser

Type

callable, null

Default value

null

View source

---

Example

php

function(User $user, array $data) {
    $user->email = $data['email'];

    return $user;
}

siteLoginHtml

Type

string, null

Default value

null

Access

Read-only

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()	Constructor
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__unset()	Sets a component property to be null.
activeAttributes()	Returns the attribute names that are subject to validation in the current scenario.
addError()	Adds a new error to the specified attribute.
addErrors()	Adds a list of errors.
addModelErrors()	Adds errors from another model, with a given attribute name prefix.
afterValidate()	This method is invoked after validation ends.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
attributeHints()	Returns the attribute hints.
attributeLabels()	Returns the attribute labels.
attributes()	Returns the list of attribute names.
beforeValidate()	This method is invoked before validation starts.
behaviors()	Returns a list of behaviors that this component should behave as.
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.
clearErrors()	Removes errors for all attributes or a single attribute.
createValidators()	Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()	Returns the names of any attributes that should hold DateTime values.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
displayName()	Returns the display name of this class.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
extraFields()	Returns the list of fields that can be expanded further and returned by toArray().
fields()	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
formName()	Returns the form name that this model class should use.
generateAttributeLabel()	Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()	Returns the validators applicable to the current scenario.
getAttributeHint()	Returns the text hint for the specified attribute.
getAttributeLabel()	Returns the text label for the specified attribute.
getAttributes()	Returns attribute values.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getCpLoginHtml()
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.
getErrors()	Returns the errors for all attributes or a single attribute.
getFirstError()	Returns the first error of the specified attribute.
getFirstErrors()	Returns the first error of every attribute in the model.
getHandle()	Get the unique handle for the provider
getIterator()	Returns an iterator for traversing the attributes in the model.
getScenario()	Returns the scenario that this model is used in.
getSiteLoginHtml()
getValidators()	Returns all the validators declared in rules().
handleRequest()	Handle a request to authenticate against an identity provider
handleResponse()	Handle the response from an identity provider
hasErrors()	Returns a value indicating whether there is any validation error.
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined for this component.
init()	Initializes the object.
instance()	Returns static class instance, which can be used to obtain meta information.
isAttributeActive()	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired()	Returns a value indicating whether the attribute is required.
isAttributeSafe()	Returns a value indicating whether the attribute is safe for massive assignments.
isSelectable()	Returns whether the component should be selectable in component Type selects.
load()	Populates the model with input data.
loadMultiple()	Populates a set of models with the data from end user.
off()	Detaches an existing event handler from this component.
offsetExists()	Returns whether there is an element at the specified offset.
offsetGet()	Returns the element at the specified offset.
offsetSet()	Sets the element at the specified offset.
offsetUnset()	Sets the element value at the specified offset to null.
on()	Attaches an event handler to an event.
onUnsafeAttribute()	This method is invoked when an unsafe attribute is being massively assigned.
rules()	Returns the validation rules for attributes.
safeAttributes()	Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()	Returns a list of scenarios and the corresponding active attributes.
setAttributes()	Sets the attribute values in a massive way.
setScenario()	Sets the scenario for the model.
toArray()	Converts the model into an array.
trigger()	Triggers an event.
validate()	Performs the data validation.
validateMultiple()	Validates multiple models.

getCpLoginHtml()

View source

Arguments

• $label
• $url

Returns

string, null

getSiteLoginHtml()

View source

Arguments

• $label
• $url

Returns

string, null

Protected Methods

Method	Description
defineBehaviors()	Returns the behaviors to attach to this class.
defineRules()	Returns the validation rules for attributes.
extractFieldsFor()	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".
extractRootFields()	Extracts the root field names from nested fields.
findUser()
getProvider()
getRequestUrl()	The URL that we will re-direct the user to for authentication
getResponseUrl()	The URL that the IdP should send the authentication response to
normalizeCallback()	Normalize a callback
populateUser()	Populate a User
resolveFields()	Determines which fields can be returned by toArray().
resolveUser()	Find or create, populate and sync a provider resource user to Craft User
syncUser()

findUser()

View source

Arguments

• $data (array)
• $idpIdentifier (string, null)

Returns

craft\elements\User, null

Throws

• yii\base\InvalidConfigException

getRequestUrl()

The URL that we will re-direct the user to for authentication

View source

Returns

string, null – The auth request URL

getResponseUrl()

The URL that the IdP should send the authentication response to

View source

Returns

string, null – The response URL

normalizeCallback()

Normalize a callback

View source

Arguments

• $callback (mixed)
• $defaultClass (string, null)

Returns

callable, null

Throws

• yii\base\InvalidConfigException

populateUser()

Populate a User

View source

Arguments

• $user (craft\elements\User)
• $data (array)

Returns

craft\elements\User

resolveUser()

Find or create, populate and sync a provider resource user to Craft User

View source

Arguments

• $data (array)
• $idpIdentifier (string, null)

Returns

craft\elements\User

Throws

• Throwable
• craft\errors\ElementNotFoundException
• yii\base\Exception

syncUser()

View source

Arguments

• $user (craft\elements\User)
• $data (array)
• $idpIdentifier

Returns

craft\elements\User

Throws

• Throwable
• craft\errors\ElementNotFoundException
• yii\base\Exception

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.