CoolCMS API

AccountDeletion extends BaseComponent
in package
uses FormTrait

Page "Account deletion". One component, the mode follows the visitor's situation ({@see self::resolveMode()}):

  • request — signed in: "Delete my account" confirmed by the password (an account without a password leaves it empty and confirms by e-mail),
  • pending — a sign-in was just refused because the account awaits deletion: the date and "Cancel the deletion" (the ticket stays in the session, never in the HTML),
  • cancel — ?cancel=<token> from the e-mail: a button that cancels the deletion,
  • confirm — ?confirm=<token> from the e-mail (account without a password): a button that confirms the request,
  • anonymous — nothing of the above: a hint to sign in.

Links from e-mails only show a button; the change happens on the POST of the form (a mail client or a scanner opening the link must not cancel or confirm anything).

Table of Contents

Constants

PAGE_SLUG  : int = \App\Core\Routers\PageId::SYSTEM_ACCOUNT_DELETION
Page id — must match `Api\…\UserManager::ACCOUNT_DELETION_PAGE_SLUG` (links in e-mails).

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
$accountDeletionSessionManager  : AccountDeletionSessionManager
$authStorageManager  : AuthStorageManager
$outcome  : string
Result of the form processed in this request: requested / confirmed / confirmationSent / cancelled.
$outcomeDate  : DateTimeImmutable|null
Deletion date to show with the outcome.
$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
hasServiceByType()  : bool
Returns whether the container has a service of the given type.
initializeAllContexts()  : void
injectDeviceDetector()  : void
onCancelSuccess()  : void
onConfirmSuccess()  : void
onCreate()  : void
onRequestSuccess()  : 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.
createComponentCancelForm()  : Form
createComponentConfirmForm()  : Form
createComponentRequestForm()  : 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
buildForm()  : Form
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).
readFormKey()  : string
readLinkParameter()  : string
The e-mailed token arrives in the query (GET); the forms carry it on in the hidden field `key`, because the form action drops the query.
readScheduledAt()  : DateTimeImmutable|null
resolveMode()  : string
resolveRequestError()  : string

Constants

PAGE_SLUG

Page id — must match `Api\…\UserManager::ACCOUNT_DELETION_PAGE_SLUG` (links in e-mails).

public int PAGE_SLUG = \App\Core\Routers\PageId::SYSTEM_ACCOUNT_DELETION

Properties

$componentParameters

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

component parameters set by setComponentParameter()

$translatorDomain

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

$outcome

Result of the form processed in this request: requested / confirmed / confirmationSent / cancelled.

private string $outcome = ''

$outcomeDate

Deletion date to show with the outcome.

private DateTimeImmutable|null $outcomeDate = 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>>

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

onCancelSuccess()

public onCancelSuccess(Form $form) : void
Parameters
$form : Form

onConfirmSuccess()

public onConfirmSuccess(Form $form) : void
Parameters
$form : Form

onRequestSuccess()

public onRequestSuccess(Form $form) : void
Parameters
$form : Form

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

createComponentCancelForm()

protected createComponentCancelForm() : Form
Return values
Form

createComponentConfirmForm()

protected createComponentConfirmForm() : Form
Return values
Form

createComponentRequestForm()

protected createComponentRequestForm() : 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

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

readFormKey()

private static readFormKey(Form $form) : string
Parameters
$form : Form
Return values
string

readLinkParameter()

The e-mailed token arrives in the query (GET); the forms carry it on in the hidden field `key`, because the form action drops the query.

private readLinkParameter(string $name) : string
Parameters
$name : string
Return values
string

readScheduledAt()

private readScheduledAt(Result $result) : DateTimeImmutable|null
Parameters
$result : Result
Return values
DateTimeImmutable|null

resolveRequestError()

private resolveRequestError(Result $result) : string
Parameters
$result : Result
Return values
string
On this page

Search results