CoolCMS API

SearchBox extends BaseComponent

in package

• Application

uses FormTrait, SearchBoxRegionTrait

Search box of the Bazaar module.

{control frontBazaarSearchBox, 'Mini'}
{control frontBazaarSearchBox:medium}

Table of Contents

Constants

REGION_FIELD_TEMPLATE  : string = __DIR__ . '/../../../Base/Front/Components/Sear...

Shared Latte part of the field; component (and theme) templates only place it.

REGION_LINK_NO_CATEGORY  : string = '-'

Placeholder category meaning "no category" in the listing link.

REGION_NOT_FOUND_MESSAGE  : string = 'front.system.components.regionSuggest.messages...

Flash shown when the typed locality cannot be resolved (full key; the layout translates it via `{_$flash->message}`).

REGION_PLACEHOLDER_KEY  : string = 'areaPlaceholder'

Suggest placeholder key (domain `front.system.components.regionSuggest`): region, district, municipality, postcode.

TYPE_PARAMETER_KEY  : mixed = 'type'

Key of the parameter that carries the advert type. Options are its children in the tree.

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

$categoryManager  : CategoryManager

$parameterManager  : ParameterManager

$priceStepsConfig  : AdvertPriceStepsConfig

$regionManager  : RegionManager

$regionSuggestFactory  : RegionSuggestFactory

$typeParameterCache  : object|null

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

onSuccess()  : void

render()  : void

renderLarge()  : void

Type switch plus category/region/price. Main page of template2.

renderMedium()  : void

Fulltext plus category plus region. Hero of the signposts (/inzerce, /firmy).

renderMini()  : void

Fulltext plus button. Module headers.

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.

createComponentForm()  : Form

createComponentRegionSuggest()  : RegionSuggest

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

addRegionFields()  : void

Adds the locality fields to the form.

applyStyleRules()  : void

Fulltext is required only in `mini`, where it is the only field.

buildMainRegionOptions()  : array<int, NotTranslate>

buildRegionLinkParameters()  : array<string, mixed>

Adds `regionId` to the listing link parameters (and the placeholder category when there is none).

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

currentTypeOptionId()  : int|null

Currently selected type option from the URL (`?p[<id>]=<optionId>`).

findTypeParameter()  : object|null

languageId()  : int|null

Id of the current language for reading entity translations.

loadMainCategories()  : array<int, NotTranslate>

loadTypeOptions()  : array<int, NotTranslate>

pluckNames()  : array<int, NotTranslate>

Extracts `id => name` from entities with translations.

prepareParametersForRedirectLink()  : array<string, mixed>

Composes the link parameters for the list.

prepareRegionField()  : void

Sets variables for the shared Latte field part ({@see REGION_FIELD_TEMPLATE}).

priceOptions()  : array<int|string, NotTranslate>

Returns "Price up to" options in the site currency (currency of the localization region): steps from `advert.bazaarPriceSteps` ({@see AdvertPriceStepsConfig}), caption by localization.

resolveRegionLinkValue()  : int|string|null

Returns the `regionId` value for the listing link.

resolveSearchLanguageId()  : int

resolveSearchPreferRegionId()  : int|null

The country of the website localization takes precedence in the offer (same as in `RegionSuggest`).

safeDefault()  : int|string|null

Preselected select value, only if it is really in its options.