phpDocumentor

StyleEditApplication extends Application
in package

Class StyleEditApplication

Table of Contents

$cPath  : string
$defaultLanguageCode  : string
$languageProvider  : LanguageProvider
$pageNotFound  : bool
$timezoneSetter  : TimezoneSetter
$urlLangParam  : string
loadConfig()  : mixed
redirectTemplateSettings()  : void
redirectToFrontEnd()  : void
run()  : mixed
send404HttpResponse()  : void
trackUser()  : void
introduced in GX 4.5 replacing the includes/tracking.php
updateCustomerInformationInSession()  : void
introduced in GX 4.5 replacing the includes/write_customers_status.php
addCategoriesBasedOnHistoryToBreadcrumb()  : bool
addCategoriesToBreadcrumb()  : bool
addManufacturerToBreadcrumb()  : mixed
addProductToBreadcrumb()  : mixed
addStartPageToBreadcrumb()  : mixed
buildBreadcrumb()  : mixed
buildTemporaryTheme()  : mixed
checkRequestUriForCorrectLanguageCode()  : mixed
checkRequestUriForCorrectProtocolAndDomain()  : mixed
connectToDatabase()  : mixed
defineConstantsFromDbConfigurationTable()  : mixed
defineInitialConstants()  : mixed
executeCronjobLikeScripts()  : mixed
getActiveLanguageCodes()  : array<string|int, mixed>
getAllGetParams()  : string
Returns all GET params of current request uri as a url query string.
getCategoryNames()  : mixed
getCategoryRedirectionUrl()  : string
getCategoryUrl()  : string
Returns a category url if current request belongs to a category page, otherwise an empty string is returned.
getConnectionType()  : string
getContentRedirectionUrl()  : string
getContentUrl()  : string
Returns a content page url if current request belongs to a content page, otherwise an empty string is returned.
getDefaultLanguageCode()  : string
getLanguageCode()  : mixed
Returns a request specific language code like 'de'.
getLanguageGetParameter()  : string
getLanguageId()  : int
getLanguageProvider()  : LanguageProvider
getPageUrl()  : string
getParentCategoryIds()  : mixed
getProductRedirectionUrl()  : string
getProductUrl()  : string
Returns a product url if current request belongs to the product info page, otherwise an empty string is returned.
getRedirectionUrl()  : string
getRedirectionUrlByPage()  : string
getTimezoneSetter()  : mixed
getUrlLanguageCode()  : string
Returns language parameter like 'de' on success and 'invalid' on failure.
getUrlWithoutLanguageCode()  : string
handle404error()  : mixed
handleCategoryRequest()  : mixed
handleChangeOfLanguageOrCurrencyOrCountry()  : mixed
handleContentRequest()  : mixed
handleCustomRedirect()  : mixed
Handles custom redirects
handleDbConnectionError()  : void
sets 503 http response code, expiration date of 5 minutes and terminates application
handleManufacturerRequest()  : mixed
handlePageSpecificRequests()  : mixed
handleProductRequest()  : mixed
handleRedirection()  : mixed
hasLanguageOrCurrencyOrCountryChanged()  : bool
includeClasses()  : mixed
includeFunctions()  : mixed
includeStyleEdit()  : mixed
includeWrapperFunctions()  : mixed
initGXEngine()  : mixed
initializeBreadcrumb()  : mixed
initializeGlobalCategoryVariables()  : mixed
initializeGlobalDebuggerObject()  : mixed
initializeGlobalMainObject()  : mixed
initializeGlobalMessageStackObject()  : mixed
initializeGlobalObjects()  : mixed
initializeGlobalPhpSelfVariable()  : mixed
initializeGlobalSeoBoostObject()  : mixed
initializeGlobalXtcPriceObject()  : mixed
initializeHistory()  : void
adds a history to the session with the requested uri's and it's post/get parameters currently only activated if the ACTIVATE_NAVIGATOR module is enabled
initLanguage()  : mixed
isCategoryRequest()  : bool
isCategoryUrlInvalid()  : bool
isContentRequest()  : bool
isContentUrlInvalid()  : bool
isFrontendGetRequest()  : bool
isLanguageCodeForUrlsActivated()  : bool
isLanguageGetParamNotMatchingSessionLanguage()  : bool
isProductInCategory()  : mixed
isProductNotFound()  : bool
isProductRequest()  : bool
isProductUrlInvalid()  : bool
isProductUrlNotSeoOptimized()  : bool
isRedirectionAllowed()  : bool
isRequestUriMissingTrailingSlashAfterLanguageCode()  : bool
isUrlLanguageCodeInvalid()  : bool
logRedirectionLoop()  : mixed
redirect()  : mixed
registerAutoloader()  : mixed
registerComposerAutoloader()  : void
registerErrorHandler()  : mixed
resetSessionRedirectionInfo()  : mixed
resetShoppingCartIfNeeded()  : void
resets the Shopping Cart of the User if the Customer ID is in the Cache.
resetWishlistIfNeeded()  : void
Resets the Wishlist of the User if the Customer ID is in the Cache.
runCartActions()  : mixed
runExtenders()  : mixed
runGProtector()  : mixed
runPrimalExtenders()  : mixed
runUpdateNeededCheck()  : mixed
Checks for a flag file in the cache directory and shows a "Gambio Updater need to be executed" page, if it exists.
sanitizeRequestData()  : mixed
sendHeader()  : mixed
setCurrentTemplate()  : mixed
setGlobalProductVariables()  : mixed
setMemoryLimit()  : mixed
setMissingGetParams()  : mixed
setMissingServerVariables()  : mixed
setSessionAccountType()  : mixed
setSessionCountry()  : mixed
setSessionCurrency()  : mixed
setSessionCustomerStatus()  : mixed
setSessionLanguage()  : mixed
setSessionLanguageData()  : mixed
setSessionObjects()  : mixed
setTimezone()  : mixed
setUpEnvironment()  : mixed
setUpFrontend()  : mixed
setUpMenuBoxesConfiguration()  : mixed
setXSRFPageToken()  : mixed
startGzipOutputBuffer()  : mixed
startSession()  : mixed
startStopWatch()  : mixed
startTracking()  : mixed
updateBreadcrumbSession()  : mixed
updateCartRelatedDataInSession()  : mixed
updateSessionData()  : mixed
updateTimezone()  : mixed
verifySession()  : mixed

Properties

Methods

loadConfig()

public static loadConfig() : mixed
Return values
mixed

redirectTemplateSettings()

public redirectTemplateSettings() : void
Return values
void

send404HttpResponse()

public static send404HttpResponse() : void
Return values
void

trackUser()

introduced in GX 4.5 replacing the includes/tracking.php

public static trackUser() : void
Return values
void

updateCustomerInformationInSession()

introduced in GX 4.5 replacing the includes/write_customers_status.php

public static updateCustomerInformationInSession() : void
Return values
void

addCategoriesBasedOnHistoryToBreadcrumb()

protected addCategoriesBasedOnHistoryToBreadcrumb( $languageId) : bool
Parameters
$languageId :
Return values
bool

addCategoriesToBreadcrumb()

protected addCategoriesToBreadcrumb( $languageId,  $breadcrumbGenerated) : bool
Parameters
$languageId :
$breadcrumbGenerated :
Return values
bool

addManufacturerToBreadcrumb()

protected addManufacturerToBreadcrumb() : mixed
Return values
mixed

addProductToBreadcrumb()

protected addProductToBreadcrumb() : mixed
Return values
mixed

addStartPageToBreadcrumb()

protected addStartPageToBreadcrumb() : mixed
Return values
mixed

buildBreadcrumb()

protected buildBreadcrumb(mixed $languageId) : mixed
Parameters
$languageId : mixed
Return values
mixed

buildTemporaryTheme()

protected buildTemporaryTheme() : mixed
Return values
mixed

checkRequestUriForCorrectLanguageCode()

protected checkRequestUriForCorrectLanguageCode() : mixed
Return values
mixed

checkRequestUriForCorrectProtocolAndDomain()

protected checkRequestUriForCorrectProtocolAndDomain() : mixed
Return values
mixed

connectToDatabase()

protected connectToDatabase() : mixed
Return values
mixed

defineConstantsFromDbConfigurationTable()

protected defineConstantsFromDbConfigurationTable() : mixed
Return values
mixed

defineInitialConstants()

protected defineInitialConstants() : mixed
Return values
mixed

executeCronjobLikeScripts()

protected executeCronjobLikeScripts() : mixed
Return values
mixed

getActiveLanguageCodes()

protected getActiveLanguageCodes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getAllGetParams()

Returns all GET params of current request uri as a url query string.

protected getAllGetParams() : string
Return values
string

getCategoryNames()

protected getCategoryNames(array<string|int, mixed> $categoryIds) : mixed
Parameters
$categoryIds : array<string|int, mixed>
Return values
mixed

getCategoryRedirectionUrl()

protected getCategoryRedirectionUrl() : string
Return values
string

getCategoryUrl()

Returns a category url if current request belongs to a category page, otherwise an empty string is returned.

protected getCategoryUrl() : string
Return values
string

getConnectionType()

protected getConnectionType() : string
Return values
string

getContentRedirectionUrl()

protected getContentRedirectionUrl() : string
Return values
string

getContentUrl()

Returns a content page url if current request belongs to a content page, otherwise an empty string is returned.

protected getContentUrl() : string
Return values
string

getDefaultLanguageCode()

protected getDefaultLanguageCode() : string
Return values
string

getLanguageCode()

Returns a request specific language code like 'de'.

protected getLanguageCode( $urlLanguageCode,  $defaultLanguageCode,  $languageGetParameter) : mixed
Parameters
$urlLanguageCode :
$defaultLanguageCode :
$languageGetParameter :
Return values
mixed

getLanguageGetParameter()

protected getLanguageGetParameter() : string
Return values
string

getLanguageId()

protected getLanguageId() : int
Return values
int

getPageUrl()

protected getPageUrl( $urlLanguageCode) : string
Parameters
$urlLanguageCode :
Return values
string

getParentCategoryIds()

protected getParentCategoryIds(mixed $categoryId[, array<string|int, mixed> $parentIds = [] ]) : mixed
Parameters
$categoryId : mixed
$parentIds : array<string|int, mixed> = []
Return values
mixed

getProductRedirectionUrl()

protected getProductRedirectionUrl() : string
Return values
string

getProductUrl()

Returns a product url if current request belongs to the product info page, otherwise an empty string is returned.

protected getProductUrl() : string
Return values
string

getRedirectionUrl()

protected getRedirectionUrl( $url,  $getParams) : string
Parameters
$url :
$getParams :
Return values
string

getRedirectionUrlByPage()

protected getRedirectionUrlByPage( $page) : string
Parameters
$page :
Return values
string

getTimezoneSetter()

protected getTimezoneSetter() : mixed
Return values
mixed

getUrlLanguageCode()

Returns language parameter like 'de' on success and 'invalid' on failure.

protected getUrlLanguageCode() : string
Return values
string

getUrlWithoutLanguageCode()

protected getUrlWithoutLanguageCode( $urlLanguageCode) : string
Parameters
$urlLanguageCode :
Return values
string

handle404error()

protected handle404error() : mixed
Return values
mixed

handleCategoryRequest()

protected handleCategoryRequest( $languageId) : mixed
Parameters
$languageId :
Return values
mixed

handleChangeOfLanguageOrCurrencyOrCountry()

protected handleChangeOfLanguageOrCurrencyOrCountry() : mixed
Return values
mixed

handleContentRequest()

protected handleContentRequest( $languageId) : mixed
Parameters
$languageId :
Return values
mixed

handleCustomRedirect()

Handles custom redirects

protected handleCustomRedirect() : mixed
Return values
mixed

handleDbConnectionError()

sets 503 http response code, expiration date of 5 minutes and terminates application

protected static handleDbConnectionError([DriverException|null $exception = null ]) : void
Parameters
$exception : DriverException|null = null
Return values
void

handleManufacturerRequest()

protected handleManufacturerRequest() : mixed
Return values
mixed

handlePageSpecificRequests()

protected handlePageSpecificRequests() : mixed
Return values
mixed

handleProductRequest()

protected handleProductRequest( $languageId) : mixed
Parameters
$languageId :
Return values
mixed

handleRedirection()

protected handleRedirection( $url,  $redirectionUrl) : mixed
Parameters
$url :
$redirectionUrl :
Return values
mixed

hasLanguageOrCurrencyOrCountryChanged()

protected hasLanguageOrCurrencyOrCountryChanged() : bool
Return values
bool

includeClasses()

protected includeClasses() : mixed
Return values
mixed

includeFunctions()

protected includeFunctions() : mixed
Return values
mixed

includeStyleEdit()

protected includeStyleEdit() : mixed
Return values
mixed

includeWrapperFunctions()

protected includeWrapperFunctions() : mixed
Return values
mixed

initGXEngine()

protected initGXEngine() : mixed
Return values
mixed

initializeBreadcrumb()

protected initializeBreadcrumb() : mixed
Return values
mixed

initializeGlobalCategoryVariables()

protected initializeGlobalCategoryVariables() : mixed
Return values
mixed

initializeGlobalDebuggerObject()

protected initializeGlobalDebuggerObject() : mixed
Return values
mixed

initializeGlobalMainObject()

protected initializeGlobalMainObject() : mixed
Return values
mixed

initializeGlobalMessageStackObject()

protected initializeGlobalMessageStackObject() : mixed
Return values
mixed

initializeGlobalObjects()

protected initializeGlobalObjects() : mixed
Return values
mixed

initializeGlobalPhpSelfVariable()

protected initializeGlobalPhpSelfVariable() : mixed
Return values
mixed

initializeGlobalSeoBoostObject()

protected initializeGlobalSeoBoostObject() : mixed
Return values
mixed

initializeGlobalXtcPriceObject()

protected initializeGlobalXtcPriceObject() : mixed
Return values
mixed

initializeHistory()

adds a history to the session with the requested uri's and it's post/get parameters currently only activated if the ACTIVATE_NAVIGATOR module is enabled

protected initializeHistory() : void

once there are more use cases for the new history service it should always be initiated not only if the ACTIVATE_NAVIGATOR module is enabled

Return values
void

initLanguage()

protected initLanguage() : mixed
Return values
mixed

isCategoryRequest()

protected isCategoryRequest() : bool
Return values
bool

isCategoryUrlInvalid()

protected isCategoryUrlInvalid( $languageId,  $categoryId,  $redirectionUrl) : bool
Parameters
$languageId :
$categoryId :
$redirectionUrl :
Return values
bool

isContentRequest()

protected isContentRequest() : bool
Return values
bool

isContentUrlInvalid()

protected isContentUrlInvalid( $redirectionUrl,  $contentUrl) : bool
Parameters
$redirectionUrl :
$contentUrl :
Return values
bool

isFrontendGetRequest()

protected isFrontendGetRequest() : bool
Return values
bool

isLanguageCodeForUrlsActivated()

protected isLanguageCodeForUrlsActivated() : bool
Return values
bool

isLanguageGetParamNotMatchingSessionLanguage()

protected isLanguageGetParamNotMatchingSessionLanguage( $languageGetParameter) : bool
Parameters
$languageGetParameter :
Return values
bool

isProductInCategory()

protected isProductInCategory(mixed $pId, mixed $catId) : mixed
Parameters
$pId : mixed
$catId : mixed
Return values
mixed

isProductNotFound()

protected isProductNotFound() : bool
Return values
bool

isProductRequest()

protected isProductRequest() : bool
Return values
bool

isProductUrlInvalid()

protected isProductUrlInvalid( $languageId,  $redirectionUrl) : bool
Parameters
$languageId :
$redirectionUrl :
Return values
bool

isProductUrlNotSeoOptimized()

protected isProductUrlNotSeoOptimized() : bool
Return values
bool

isRedirectionAllowed()

protected isRedirectionAllowed( $url) : bool
Parameters
$url :
Return values
bool

isRequestUriMissingTrailingSlashAfterLanguageCode()

protected isRequestUriMissingTrailingSlashAfterLanguageCode() : bool
Return values
bool

isUrlLanguageCodeInvalid()

protected isUrlLanguageCodeInvalid( $urlLanguageCode) : bool
Parameters
$urlLanguageCode :
Return values
bool

logRedirectionLoop()

protected logRedirectionLoop( $redirectionUrl) : mixed
Parameters
$redirectionUrl :
Return values
mixed

redirect()

protected redirect( $url) : mixed
Parameters
$url :
Return values
mixed

registerAutoloader()

protected registerAutoloader() : mixed
Return values
mixed

registerComposerAutoloader()

protected registerComposerAutoloader() : void
Return values
void

registerErrorHandler()

protected registerErrorHandler() : mixed
Return values
mixed

resetSessionRedirectionInfo()

protected resetSessionRedirectionInfo() : mixed
Return values
mixed

resetShoppingCartIfNeeded()

resets the Shopping Cart of the User if the Customer ID is in the Cache.

protected resetShoppingCartIfNeeded() : void
Return values
void

resetWishlistIfNeeded()

Resets the Wishlist of the User if the Customer ID is in the Cache.

protected resetWishlistIfNeeded() : void
Return values
void

runCartActions()

protected runCartActions() : mixed
Return values
mixed

runExtenders()

protected runExtenders() : mixed
Return values
mixed

runGProtector()

protected runGProtector() : mixed
Return values
mixed

runPrimalExtenders()

protected runPrimalExtenders() : mixed
Return values
mixed

runUpdateNeededCheck()

Checks for a flag file in the cache directory and shows a "Gambio Updater need to be executed" page, if it exists.

protected runUpdateNeededCheck() : mixed
Return values
mixed

sanitizeRequestData()

protected sanitizeRequestData() : mixed
Return values
mixed

sendHeader()

protected sendHeader() : mixed
Return values
mixed

setCurrentTemplate()

protected setCurrentTemplate() : mixed
Return values
mixed

setGlobalProductVariables()

protected setGlobalProductVariables( $languageId) : mixed
Parameters
$languageId :
Return values
mixed

setMemoryLimit()

protected setMemoryLimit([mixed $limit = 128 ]) : mixed
Parameters
$limit : mixed = 128
Return values
mixed

setMissingGetParams()

protected setMissingGetParams() : mixed
Return values
mixed

setMissingServerVariables()

protected setMissingServerVariables() : mixed
Return values
mixed

setSessionAccountType()

protected setSessionAccountType() : mixed
Return values
mixed

setSessionCountry()

protected setSessionCountry() : mixed
Return values
mixed

setSessionCurrency()

protected setSessionCurrency() : mixed
Return values
mixed

setSessionCustomerStatus()

protected setSessionCustomerStatus() : mixed
Return values
mixed

setSessionLanguage()

protected setSessionLanguage() : mixed
Return values
mixed

setSessionLanguageData()

protected setSessionLanguageData(string $languageCode) : mixed
Parameters
$languageCode : string
Return values
mixed

setSessionObjects()

protected setSessionObjects() : mixed
Return values
mixed

setTimezone()

protected setTimezone() : mixed
Return values
mixed

setUpEnvironment()

protected setUpEnvironment() : mixed
Return values
mixed

setUpFrontend()

protected setUpFrontend() : mixed
Return values
mixed

setUpMenuBoxesConfiguration()

protected setUpMenuBoxesConfiguration() : mixed
Return values
mixed

setXSRFPageToken()

protected setXSRFPageToken() : mixed
Return values
mixed

startGzipOutputBuffer()

protected startGzipOutputBuffer() : mixed
Return values
mixed

startStopWatch()

protected startStopWatch() : mixed
Return values
mixed

startTracking()

protected startTracking() : mixed
Return values
mixed

updateBreadcrumbSession()

protected updateBreadcrumbSession() : mixed
Return values
mixed

updateCartRelatedDataInSession()

protected updateCartRelatedDataInSession() : mixed
Return values
mixed

updateSessionData()

protected updateSessionData() : mixed
Return values
mixed

updateTimezone()

protected updateTimezone(mixed $timezone) : mixed
Parameters
$timezone : mixed
Return values
mixed

verifySession()

protected verifySession() : mixed
Return values
mixed

Search results