CoolCMS API

FeedEdit extends BaseComponent

in package

• Application

uses AdminComponentFormTrait, FormHelpersTrait, FormTrait, ParameterTreeTrait, GenerateTrait

Renders the feed add/edit form as the page content (not in a modal).

Table of Contents

Constants

EDIT_INCLUDES  : array<int, string> = ['language', 'currency']

Category mappings are not included: the form does not edit them and the Api `defaultSkipFields` excludes them from the save path.

GENERATE_LOCK_NAME  : string = 'cron.eshop.feed.generate'

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

$adminLanguageManager  : LanguageManager

$cronLockManager  : CronLockManager

$currencyManager  : CurrencyManager

$editedFeed  : Feed|null

Edited feed (null when adding), set by {@see resolveEditedFeed()}.

$feedCurrencies  : array<int, Currency>

$feedId  : int|null

Per-instance context from {@see FeedEditFactory::create()}; null when adding.

$feedLanguages  : array<int, Language>

$feedManager  : FeedManager

$feedParameterActionManager  : FeedParameterActionManager

$feedParameterActionOptions  : array<int, NotTranslate>

$feedParameterTreeCache  : array<int, array<string, mixed>>|null

$formActionsFactory  : FormActionsFactory

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

handleGenerateNow()  : void

hasServiceByType()  : bool

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

initializeAllContexts()  : void

injectDeviceDetector()  : void

onCreate()  : 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.

createAdminComponentForm()  : Form

createComponentAdminFormActions()  : FormActions

createComponentEditForm()  : Form

frontPresenter()  : BasePresenter|null

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

getTranslator()  : ITranslator

intOrNull()  : int|null

setTemplateFile()  : void

setTranslator()  : self

str()  : string

strOrNull()  : string|null

addFeedBaseFields()  : void

addFeedParameterNodeControls()  : void

addFeedParameterTreeMultiplier()  : void

buildFeedEntity()  : Feed

buildParameterTreeDefaultRows()  : array<int, array<string, mixed>>

Converts the stored tree into nested default rows (two levels) for the multiplier, passed through `$form->setDefaults()` in {@see FormTrait::setFeedFormDefaults()}.

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

currentLangIdOrDefault()  : int

extractSubmittedTree()  : array<int, array<string, mixed>>

Converts the nested `$values->parameters` (multiplier) into the shape expected by {@see \App\UI\Admin\Eshop\Models\Managers\FeedManager::saveParameterTree()}.

httpRequest()  : IRequest

Returns the HTTP request through the presenter; a control has no `getHttpRequest()`.

isSignalRequest()  : bool

Tells whether a signal is being handled; a control has no `getSignal()`, only the presenter has.

loadFeedParameterTree()  : array<int, array<string, mixed>>

Returns the feed parameter tree, memoized per request because `render()` and `createComponentEditForm()` can both ask for the prefill.

loadFeedSelectData()  : void

Loads the select data (languages, currencies, actions) once per request.

resolveEditedFeed()  : Feed|null

saveFeedForm()  : bool

setFeedFormDefaults()  : void

Prefills the base fields and the parameter tree multiplier (including the nested level) in a single `setDefaults()`.