API Documentation

Namespaces

FWK

Table of Contents

API_TIMEOUT  = 10
ATTACHMENT_MAX_SIZE  = 20
CDN_ASSETS_COMMERCE  = '/assets'
CHARSET  = 'UTF-8'
CONNECTIONLOGGER_ENABLED  = self::getLoggerConnectionEnabled()
DATE_TIME_FORMATER_DEFAULT_CALENDAR_TYPE  = \IntlDateFormatter::GREGORIAN
DATE_TIME_FORMATER_DEFAULT_DATE_TYPE  = \IntlDateFormatter::MEDIUM
DATE_TIME_FORMATER_DEFAULT_TIME_TYPE  = \IntlDateFormatter::MEDIUM
DEBUGINFOLOGGER_ENABLED  = self::getLoggerDebugInfoEnabled()
DEFAULT_CACHE_CONTROL_MAX_AGE  = '3600'
DEFAULT_CACHE_TTL  = '3600'
DEFAULT_ROUTE  = [\FWK\Enums\RouteItems::STATUS => 200, \FWK\Enums\RouteItems::LANGUAGE => 'es', \FWK\Enums\RouteItems::CURRENCY => 'EUR', \FWK\Enums\RouteItems::THEME => [\FWK\Enums\RouteItems::LAYOUT => 'default', \FWK\Enums\RouteItems::CONTENT => 'default', \FWK\Enums\RouteItems::NAME => 'default', \FWK\Enums\RouteItems::CHANNEL => '']]
DEVEL  = \false
DEVEL_HEADER  = isset(\REQUEST_HEADERS[$constDevelHeader]) && \boolval(\REQUEST_HEADERS[$constDevelHeader])
DOCUEMENT_TEMPLATES_PATH  = '/documentTemplates/'
ERROR_ON_CACHEABLE_ZERO_TTL  = self::getErrorOnCacheableZeroTTL()
ERROR_WITHOUT_CONTROLLER  = 'ErrorWithoutController.php'
EXCEPTIONLOGGER_ENABLED  = self::getLoggerExceptionEnabled()
FWK_JS_VERSION  = ''
FWK_LOAD_PATH  = $path
FWK_NAMESPACE  = 'FWK\\'
FWK_PHAR_BUILD  = '20221117-12:27'
HEALTHCHECKLOGGER_ENABLED  = self::getLoggerHealthcheckEnabled()
IMAGE_FEATURED_SMALL  = 'featuredSmall.png'
IMAGE_LANGUAGE  = 'languages/flag_{{initials}}.png'
IMAGE_MISSING_BASKET_ITEM  = 'notFoundProductSmall.png'
IMAGE_MISSING_OPTION_IMAGE  = 'notFoundProductOption.png'
IMAGE_MISSING_PRODUCTS  = 'notFoundProduct.png'
IMAGE_MISSING_PRODUCTS_LIST  = 'notFoundProductSmall.png'
IMAGE_NOT_FOUND  = 'notFound.png'
IMAGE_OFFER_SMALL  = 'offerSmall.png'
INTERNAL_FOLDER  = 'Internal'
INTERNAL_PREFIX  = 'lc_ecom_internal'
INTERNAL_THEME  = 'Internal'
INTERNAL_UTIL_VERSION  = 'Util'
JSON_ENCODE_FILTER  = \JSON_UNESCAPED_UNICODE
LICENSES_LOCATION_ADDRESS_VALIDATION  = ['ADBAS', 'ADEXT']
LIFE_TIME_CACHE_APPLICATION  = self::getLifeTimeCacheApplication()
LIFE_TIME_CACHE_OBJECTS  = self::getLifeTimeCacheObjects()
LIFE_TIME_CACHE_PLUGINS  = self::getLifeTimeCachePlugins()
LIFE_TIME_SESSION  = self::getLifeTimeSession()
LIFE_TIME_SESSION_BOT  = 5
LOG_ENABLED  = self::getLogEnabled()
LOG_HANDLER  = self::getLogHandler()
LOG_LEVEL  = self::getLogLevel()
LOGGER_LEVEL  = self::getLoggerLevel()
MAX_LENGTH_APPLIED_PARAMETER_VALUE  = 500
REQUEST_HEADERS  = \array_change_key_case(\getallheaders(), \CASE_UPPER)
REQUEST_ID  = \date("dmy-His") . '_' . \uniqid()
REQUESTHANDLERLOGGER_ENABLED  = self::getLoggerRequestHandlerEnabled()
REQUIRED_FIELD_HTML_FLAG  = '<span class="required">*</span>'
SDK_INTERCEPTORS_NAMESPACE  = 'FWK\\Core\\Interceptors'
THEME_DEFAULT_MODE  = 'bootstrap5'
THEME_DEFAULT_VERSION  = 'Desktop'
THROW_CONNECTION_ERRORS  = \false
TIMER_DEBUG  = isset(\REQUEST_HEADERS[$constTimerDebug]) && \boolval(\REQUEST_HEADERS[$constTimerDebug])
TIMERLOGGER_ENABLED  = self::getLoggerTimerEnabled()
URL_ROUTE  = 'path'
USE_CACHE_REDIS_OBJECT  = self::getUseCacheRedisObject()
USER_ACTIONS_FILE_EXTENSION  = '.png'
exceptionCapturerFWK() This is our user-defined exception handler function to be called when an uncaught exception occurs.  : void
errorCapturerFWK() This is the function for execution on shutdown.  : void
callMethod()  : bool

Constants

API_TIMEOUT

public mixed API_TIMEOUT = 10

ATTACHMENT_MAX_SIZE

public mixed ATTACHMENT_MAX_SIZE = 20

CDN_ASSETS_COMMERCE

public mixed CDN_ASSETS_COMMERCE = '/assets'

CHARSET

public mixed CHARSET = 'UTF-8'

CONNECTIONLOGGER_ENABLED

public mixed CONNECTIONLOGGER_ENABLED = self::getLoggerConnectionEnabled()

DATE_TIME_FORMATER_DEFAULT_CALENDAR_TYPE

public mixed DATE_TIME_FORMATER_DEFAULT_CALENDAR_TYPE = \IntlDateFormatter::GREGORIAN

DATE_TIME_FORMATER_DEFAULT_DATE_TYPE

public mixed DATE_TIME_FORMATER_DEFAULT_DATE_TYPE = \IntlDateFormatter::MEDIUM

DATE_TIME_FORMATER_DEFAULT_TIME_TYPE

public mixed DATE_TIME_FORMATER_DEFAULT_TIME_TYPE = \IntlDateFormatter::MEDIUM

DEBUGINFOLOGGER_ENABLED

public mixed DEBUGINFOLOGGER_ENABLED = self::getLoggerDebugInfoEnabled()

DEFAULT_CACHE_CONTROL_MAX_AGE

public mixed DEFAULT_CACHE_CONTROL_MAX_AGE = '3600'

DEFAULT_CACHE_TTL

public mixed DEFAULT_CACHE_TTL = '3600'

DEFAULT_ROUTE

public mixed DEFAULT_ROUTE = [\FWK\Enums\RouteItems::STATUS => 200, \FWK\Enums\RouteItems::LANGUAGE => 'es', \FWK\Enums\RouteItems::CURRENCY => 'EUR', \FWK\Enums\RouteItems::THEME => [\FWK\Enums\RouteItems::LAYOUT => 'default', \FWK\Enums\RouteItems::CONTENT => 'default', \FWK\Enums\RouteItems::NAME => 'default', \FWK\Enums\RouteItems::CHANNEL => '']]

DEVEL_HEADER

public mixed DEVEL_HEADER = isset(\REQUEST_HEADERS[$constDevelHeader]) && \boolval(\REQUEST_HEADERS[$constDevelHeader])

DOCUEMENT_TEMPLATES_PATH

public mixed DOCUEMENT_TEMPLATES_PATH = '/documentTemplates/'

ERROR_ON_CACHEABLE_ZERO_TTL

public mixed ERROR_ON_CACHEABLE_ZERO_TTL = self::getErrorOnCacheableZeroTTL()

ERROR_WITHOUT_CONTROLLER

public mixed ERROR_WITHOUT_CONTROLLER = 'ErrorWithoutController.php'

EXCEPTIONLOGGER_ENABLED

public mixed EXCEPTIONLOGGER_ENABLED = self::getLoggerExceptionEnabled()

FWK_JS_VERSION

public mixed FWK_JS_VERSION = ''

FWK_LOAD_PATH

public mixed FWK_LOAD_PATH = $path

FWK_NAMESPACE

public mixed FWK_NAMESPACE = 'FWK\\'

FWK_PHAR_BUILD

public mixed FWK_PHAR_BUILD = '20221117-12:27'

HEALTHCHECKLOGGER_ENABLED

public mixed HEALTHCHECKLOGGER_ENABLED = self::getLoggerHealthcheckEnabled()

IMAGE_FEATURED_SMALL

public mixed IMAGE_FEATURED_SMALL = 'featuredSmall.png'

IMAGE_LANGUAGE

public mixed IMAGE_LANGUAGE = 'languages/flag_{{initials}}.png'

IMAGE_MISSING_BASKET_ITEM

public mixed IMAGE_MISSING_BASKET_ITEM = 'notFoundProductSmall.png'

IMAGE_MISSING_OPTION_IMAGE

public mixed IMAGE_MISSING_OPTION_IMAGE = 'notFoundProductOption.png'

IMAGE_MISSING_PRODUCTS

public mixed IMAGE_MISSING_PRODUCTS = 'notFoundProduct.png'

IMAGE_MISSING_PRODUCTS_LIST

public mixed IMAGE_MISSING_PRODUCTS_LIST = 'notFoundProductSmall.png'

IMAGE_NOT_FOUND

public mixed IMAGE_NOT_FOUND = 'notFound.png'

IMAGE_OFFER_SMALL

public mixed IMAGE_OFFER_SMALL = 'offerSmall.png'

INTERNAL_FOLDER

public mixed INTERNAL_FOLDER = 'Internal'

INTERNAL_PREFIX

public mixed INTERNAL_PREFIX = 'lc_ecom_internal'

INTERNAL_THEME

public mixed INTERNAL_THEME = 'Internal'

INTERNAL_UTIL_VERSION

public mixed INTERNAL_UTIL_VERSION = 'Util'

JSON_ENCODE_FILTER

public mixed JSON_ENCODE_FILTER = \JSON_UNESCAPED_UNICODE

LICENSES_LOCATION_ADDRESS_VALIDATION

public mixed LICENSES_LOCATION_ADDRESS_VALIDATION = ['ADBAS', 'ADEXT']

LIFE_TIME_CACHE_APPLICATION

public mixed LIFE_TIME_CACHE_APPLICATION = self::getLifeTimeCacheApplication()

LIFE_TIME_CACHE_OBJECTS

public mixed LIFE_TIME_CACHE_OBJECTS = self::getLifeTimeCacheObjects()

LIFE_TIME_CACHE_PLUGINS

public mixed LIFE_TIME_CACHE_PLUGINS = self::getLifeTimeCachePlugins()

LIFE_TIME_SESSION

public mixed LIFE_TIME_SESSION = self::getLifeTimeSession()

LIFE_TIME_SESSION_BOT

public mixed LIFE_TIME_SESSION_BOT = 5

LOG_ENABLED

public mixed LOG_ENABLED = self::getLogEnabled()

LOG_HANDLER

public mixed LOG_HANDLER = self::getLogHandler()

LOG_LEVEL

public mixed LOG_LEVEL = self::getLogLevel()

LOGGER_LEVEL

public mixed LOGGER_LEVEL = self::getLoggerLevel()

MAX_LENGTH_APPLIED_PARAMETER_VALUE

public mixed MAX_LENGTH_APPLIED_PARAMETER_VALUE = 500

REQUEST_HEADERS

public mixed REQUEST_HEADERS = \array_change_key_case(\getallheaders(), \CASE_UPPER)

REQUEST_ID

public mixed REQUEST_ID = \date("dmy-His") . '_' . \uniqid()

REQUESTHANDLERLOGGER_ENABLED

public mixed REQUESTHANDLERLOGGER_ENABLED = self::getLoggerRequestHandlerEnabled()

REQUIRED_FIELD_HTML_FLAG

public mixed REQUIRED_FIELD_HTML_FLAG = '<span class="required">*</span>'

SDK_INTERCEPTORS_NAMESPACE

public mixed SDK_INTERCEPTORS_NAMESPACE = 'FWK\\Core\\Interceptors'

THEME_DEFAULT_MODE

public mixed THEME_DEFAULT_MODE = 'bootstrap5'

THEME_DEFAULT_VERSION

public mixed THEME_DEFAULT_VERSION = 'Desktop'

THROW_CONNECTION_ERRORS

public mixed THROW_CONNECTION_ERRORS = \false

TIMER_DEBUG

public mixed TIMER_DEBUG = isset(\REQUEST_HEADERS[$constTimerDebug]) && \boolval(\REQUEST_HEADERS[$constTimerDebug])

TIMERLOGGER_ENABLED

public mixed TIMERLOGGER_ENABLED = self::getLoggerTimerEnabled()

URL_ROUTE

public mixed URL_ROUTE = 'path'

USE_CACHE_REDIS_OBJECT

public mixed USE_CACHE_REDIS_OBJECT = self::getUseCacheRedisObject()

USER_ACTIONS_FILE_EXTENSION

public mixed USER_ACTIONS_FILE_EXTENSION = '.png'

Functions

exceptionCapturerFWK()

This is our user-defined exception handler function to be called when an uncaught exception occurs.

exceptionCapturerFWK(Throwable $e) : void

It instanciates an ExceptionHandler object (see FWK\Core\Exceptions\ExceptionHandler) to manage the captured exception.

Parameters
$e : Throwable
Tags
see
ExceptionHandler
Return values
void —

errorCapturerFWK()

This is the function for execution on shutdown.

errorCapturerFWK() : void
Return values
void —

callMethod()

callMethod(callable $method[, callable $finally = null ][, string $message = '' ][, array<string|int, mixed> $args = [] ][, bool $staticRedirect = false ]) : bool
Parameters
$method : callable
$finally : callable = null
$message : string = ''
$args : array<string|int, mixed> = []
$staticRedirect : bool = false
Return values
bool —

Search results