CoolCMS API

LoginExternal extends BaseComponent
in package
uses AuthTrait

Table of Contents

Properties

$container  : Container
$routerDispatcher  : RouterDispatcher
$translator  : ITranslator
$appContext  : AppContext
$componentParameters  : array<string, mixed>
$currencyContext  : CurrencyContext|null
$deviceDetector  : DeviceDetector|null
$languageContext  : LanguageContext|null
$localizationContext  : LocalizationContext|null
$settingContext  : SettingContext
$themeContext  : ThemeContext|null
$translatorDomain  : string|null
$loginProviderManager  : LoginProviderManager
$provider  : AdapterInterface|null
$session  : Session
$sessionSection  : SessionSection
$userManager  : UserManager

Methods

__call()  : mixed
Dispatches `renderXyz()` to `render('Xyz', ...$args)`.
__construct()  : mixed
createComponent()  : IComponent|null
getAppContext()  : AppContext
getComponentParameter()  : mixed
Returns a component parameter, or null when it is not set.
getContainer()  : Container
getCurrencyContext()  : CurrencyContext|null
getLanguageContext()  : LanguageContext|null
getLocalizationContext()  : LocalizationContext|null
getRouterDispatcher()  : RouterDispatcher
getSettingContext()  : SettingContext
getSettings()  : array<int, array<string, mixed>>
getThemeContext()  : ThemeContext|null
handleAuthenticate()  : void
handleLogin()  : void
hasServiceByType()  : bool
Returns whether the container has a service of the given type.
initializeAllContexts()  : void
injectDeviceDetector()  : void
onCreate()  : void
processOauthCallback()  : void
render()  : void
setAppContext()  : $this
setComponentParameter()  : void
Sets a component parameter.
setCurrencyContext()  : $this
setLanguageContext()  : $this
setLocalizationContext()  : $this
setSettingContext()  : $this
setThemeContext()  : $this
setup()  : void
setupAppContext()  : void
typedComponent()  : T
Returns a subcomponent with a verified type.
frontPresenter()  : BasePresenter|null
Returns the front presenter the component is attached to (null outside the front end or when detached).
getTranslator()  : ITranslator
setTemplateFile()  : void
setTranslator()  : self
createMultiplierComponent()  : Multiplier<string|int, IComponent>
Creates a multiplier for the component.
createNewComponentInstance()  : IComponent|null
Creates a new component instance without adding it to the presenter; used by the multiplier.
createStandardComponent()  : IComponent|null
Creates a standard component (not a multiplier).
executeLogin()  : void
flashLoginFailure()  : void
Reports a failed external sign-in the same way as the password sign-in ({@see \App\Core\Traits\Front\Presenters\AuthStorageTrait::processFailedLogin()}).
getCallbackUrl()  : string
loadProvider()  : AdapterInterface
Loads the provider OAuth configuration.
log()  : void

Properties

$componentParameters

protected array<string, mixed> $componentParameters = []

component parameters set by setComponentParameter()

$translatorDomain

protected string|null $translatorDomain = 'front.system.components.loginExternal'

$provider

private AdapterInterface|null $provider = null

Methods

__call()

Dispatches `renderXyz()` to `render('Xyz', ...$args)`.

public __call(string $name, array<string|int, mixed> $args) : mixed

Called only when the component has no renderXyz() method of its own.

Parameters
$name : string
$args : array<string|int, mixed>

createComponent()

public createComponent(string $name) : IComponent|null
Parameters
$name : string
Return values
IComponent|null

getComponentParameter()

Returns a component parameter, or null when it is not set.

public getComponentParameter(string $name) : mixed
Parameters
$name : string

getContainer()

public getContainer() : Container
Return values
Container

getSettings()

public getSettings() : array<int, array<string, mixed>>
Return values
array<int, array<string, mixed>>

handleAuthenticate()

public handleAuthenticate(string $providerName) : void
Parameters
$providerName : string

handleLogin()

public handleLogin([string|null $providerName = null ]) : void
Parameters
$providerName : string|null = null

hasServiceByType()

Returns whether the container has a service of the given type.

public hasServiceByType(string $className) : bool

The name is composed dynamically (module plus component), so class_exists() runs first, and a true result guarantees a valid type.

Parameters
$className : string
Tags
phpstan-assert-if-true

class-string $className

Return values
bool

processOauthCallback()

public processOauthCallback(string $providerName) : void
Parameters
$providerName : string

render()

public render([string $style = 'Style_1' ]) : void
Parameters
$style : string = 'Style_1'

setComponentParameter()

Sets a component parameter.

public setComponentParameter(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed

typedComponent()

Returns a subcomponent with a verified type.

public typedComponent(string $name, T> $type) : T

Use it instead of an inline @var above $this['x'] (which does not narrow the type) and instead of the generic IComponent that $this['x'] returns. See Form::typedComponent().

Parameters
$name : string
$type : T>
Tags
template
Return values
T

frontPresenter()

Returns the front presenter the component is attached to (null outside the front end or when detached).

protected frontPresenter() : BasePresenter|null
Return values
BasePresenter|null

getTranslator()

protected getTranslator() : ITranslator
Return values
ITranslator

setTemplateFile()

protected setTemplateFile(string $dir, string $filename) : void
Parameters
$dir : string
$filename : string

setTranslator()

protected setTranslator(ITranslator $translator) : self
Parameters
$translator : ITranslator
Return values
self

createMultiplierComponent()

Creates a multiplier for the component.

private createMultiplierComponent(string $name) : Multiplier<string|int, IComponent>
Parameters
$name : string
Return values
Multiplier<string|int, IComponent>

createNewComponentInstance()

Creates a new component instance without adding it to the presenter; used by the multiplier.

private createNewComponentInstance(string $baseName[, int|string|null $uniqueKey = null ]) : IComponent|null
Parameters
$baseName : string
$uniqueKey : int|string|null = null
Return values
IComponent|null

createStandardComponent()

Creates a standard component (not a multiplier).

private createStandardComponent(string $name) : IComponent|null
Parameters
$name : string
Return values
IComponent|null

executeLogin()

private executeLogin(string $providerName) : void
Parameters
$providerName : string

flashLoginFailure()

Reports a failed external sign-in the same way as the password sign-in ({@see \App\Core\Traits\Front\Presenters\AuthStorageTrait::processFailedLogin()}).

private flashLoginFailure(Presenter $presenter, ResultCode $code) : void

The flash receives the finished translation (not a key): the shared flash layout partial translates with its own domain, so a key would stay untranslated. The redirect is needed because the callback URL /oauth/callback/<provider> has an empty template, so a flash message would have nowhere to show.

Parameters
$presenter : Presenter
$code : ResultCode

getCallbackUrl()

private getCallbackUrl(string $providerName) : string
Parameters
$providerName : string
Return values
string

loadProvider()

Loads the provider OAuth configuration.

private loadProvider(string $providerName) : AdapterInterface

IMPORTANT: the client id and secret must not be read from the loaded entity: both fields have #[FieldAccess(read: Audience::Privileged)] and the front end runs as guest, so the entity would give empty strings and Hybridauth would try to authenticate with empty keys. The keys therefore come from the dedicated internal action :Api:System:LoginProvider:oauthConfig, which builds its payload by hand outside the hydrator and has no action*(), so external HTTP cannot reach it. See LoginProviderPresenter::internalActionOauthConfig().

Parameters
$providerName : string
Return values
AdapterInterface

log()

private log(string $message[, array<string, mixed> $context = [] ]) : void
Parameters
$message : string
$context : array<string, mixed> = []
On this page

Search results