CoolCMS API

RegistrationForm extends BaseComponent
in package
uses FormTrait, InitTrait

Table of Contents

Properties

$container  : Container
$onRegistrationSuccess  : array<string|int, callable>
$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
$blacklistManager  : BlacklistManager
$countryManager  : CountryManager
$paymentRegionManager  : PaymentRegionManager
$userManager  : UserManager
$userTypeManager  : UserTypeManager

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
hasServiceByType()  : bool
Returns whether the container has a service of the given type.
initializeAllContexts()  : void
injectDeviceDetector()  : void
onCreate()  : void
onError()  : void
onSuccess()  : 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.
validateBlacklist()  : void
One blacklist check of the e-mail, phone and visitor IP ({@see BlacklistManager::findBlacklistedTypes()}), run after the field rules passed. A blocked e-mail or phone is reported at its field, a blocked IP (single address or prefix range) at the form.
createComponentRegistrationForm()  : Form
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
addAddressFields()  : void
addAvatarField()  : void
addCompanyFields()  : void
addContactFields()  : void
addLoginFields()  : void
checkLoggedUser()  : bool
controlText()  : string
Hodnota pole jako string — `IControl::getValue()` je `mixed`.
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).
initializeNewUser()  : User
isFree()  : bool
Translates the `usernameExists()`/`emailExists()` response into a validation rule result.
preparePaymentRegions()  : array<int, string>
prepareUserTypes()  : array{array, int[], int[]}

Properties

$onRegistrationSuccess

public array<string|int, callable> $onRegistrationSuccess = []

$componentParameters

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

component parameters set by setComponentParameter()

$translatorDomain

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

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>>

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

onSuccess()

public onSuccess(Form $form, ArrayHash $values) : void
Parameters
$form : Form
$values : ArrayHash

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

validateBlacklist()

One blacklist check of the e-mail, phone and visitor IP ({@see BlacklistManager::findBlacklistedTypes()}), run after the field rules passed. A blocked e-mail or phone is reported at its field, a blocked IP (single address or prefix range) at the form.

public validateBlacklist(Form $form) : void

IMPORTANT: the query goes through isBlacklisted (blocked types only), not the generic getBy, which made the whole blacklist readable to anyone with a token. It is fail-closed like self::isFree(): when the Api does not answer, the registration is refused, otherwise an outage or a missing grant would silently switch the check off.

Parameters
$form : Form

createComponentRegistrationForm()

protected createComponentRegistrationForm() : Form
Return values
Form

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

addAddressFields()

private addAddressFields(Form $form, callable $t) : void
Parameters
$form : Form
$t : callable

addAvatarField()

private addAvatarField(Form $form, callable $t) : void
Parameters
$form : Form
$t : callable

addCompanyFields()

private addCompanyFields(Form $form, callable $t) : void
Parameters
$form : Form
$t : callable

addContactFields()

private addContactFields(Form $form, callable $t) : void
Parameters
$form : Form
$t : callable

addLoginFields()

private addLoginFields(Form $form, callable $t) : void
Parameters
$form : Form
$t : callable

checkLoggedUser()

private checkLoggedUser() : bool
Return values
bool

controlText()

Hodnota pole jako string — `IControl::getValue()` je `mixed`.

private controlText(IControl $control) : string
Parameters
$control : IControl
Return values
string

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

initializeNewUser()

private initializeNewUser(ArrayHash $values) : User
Parameters
$values : ArrayHash
Return values
User

isFree()

Translates the `usernameExists()`/`emailExists()` response into a validation rule result.

private isFree(bool|null $exists) : bool

IMPORTANT: it replaces isUnique(), which looked the account up itself through userManager->findBy() = :Api:System:User:getBy. That action is admin-only and returned null through FailSoftReadTrait under enforce, and null === null evaluated as "the name is free", so registration reported no duplicates at all and only the unique indexes uq_username / uq_email remained as a safeguard.

A null (the Api did not answer: guard or outage) is deliberately evaluated as invalid (fail-closed): the user sees "already exists" and retries, instead of passing on to a duplicate and failing on the database constraint.

Parameters
$exists : bool|null
Return values
bool

preparePaymentRegions()

private preparePaymentRegions() : array<int, string>
Return values
array<int, string>

prepareUserTypes()

private prepareUserTypes() : array{array, int[], int[]}
Return values
array{array, int[], int[]}
On this page

Search results