CoolCMS API

WatchdogForm extends BaseComponent

in package

• Application

uses FormTrait, ModalTrait, InMultiplierTrait

Table of Contents

Constants

DELETE_MODAL_TARGET  : mixed = 'watchdogDeleteModal'

FORM_MODAL_TARGET  : mixed = 'watchdogFormModal'

STATE_PARAMETER_KEY  : string = 'state'

Key of the parent parameter "state".

TYPE_PARAMETER_KEY  : string = 'type'

Key of the parent parameter "type" (options are its children, an advert stores the option id in `value`).

Properties

$container  : Container

$routerDispatcher  : RouterDispatcher

$translator  : ITranslator

$watchdogId  : int

$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

$categoryManager  : CategoryManager

$categorySuggestFactory  : CategorySuggestFactory

$eventDispatcher  : EventDispatcher

$languageManager  : LanguageManager

$modalRegistry  : ModalRegistry

$parameterManager  : ParameterManager

$regionManager  : RegionManager

$regionSuggestFactory  : RegionSuggestFactory

$watchdogManager  : WatchdogManager

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

handleDelete()  : void

handleShowDeleteModal()  : void

handleShowFormModal()  : void

hasServiceByType()  : bool

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

init()  : self

initializeAllContexts()  : void

injectDeviceDetector()  : void

onCreate()  : void

onError()  : void

Handles an invalid form: the modal must be redrawn, otherwise the user does not see the field errors (region, e-mail). Errors without a field (CSRF) have no place in the template, so they go to a generic flash.

onSuccess()  : void

onValidate()  : void

Validates the form: the category is required and text typed without a suggestion selected is an error. Without a region the localization country is watched; when the localization has none, the region is required. Typed region text without a selection is an error (otherwise a typo would save the whole country).

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.

createComponentCategorySuggest()  : CategorySuggest

Creates the category suggest (shared component, source = the module's Front `CategoryManager`).

createComponentForm()  : Form

createComponentRegionSuggest()  : RegionSuggest

Creates the region suggest. A watchdog can watch a country, county, district or municipality; matching goes through the ancestors of the advert region.

frontPresenter()  : BasePresenter|null

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

getDeleteModalTarget()  : string

getFormModalTarget()  : string

getTranslator()  : ITranslator

prepareFormTemplate()  : void

setTemplateFile()  : void

setTranslator()  : self

createDeleteContent()  : string

createDeleteResultContent()  : string

createFormContent()  : string

createModalEvent()  : ModalWindowEvent

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

createSuccessContent()  : string

getCategoryLabel()  : string

getParameterLabel()  : string

isSelectableCategory()  : bool

Checks that the selected category exists, is active and is not admin-only (any tree level).

isSelectableRegion()  : bool

Checks that the selected region exists and is active (any tree level).

isTyped()  : bool

Checks that the user typed something into the suggest field (regardless of a selection).

prepareLanguageList()  : array<int, string>

prepareStateList()  : array<int, string>

prepareTypeList()  : array<int, string>

resolveCategoryLabel()  : string

Returns the saved category label for editing (suggest text); empty text when it does not exist.

resolveDefaultRegionId()  : int|null

Returns the website localization country (`cms_system_localizations.cms_system_regions_region_id`).

resolveLanguageId()  : int

resolveRegionId()  : int

updateModalContent()  : void