class.OrderControllerCore.md

Class OrderControllerCore

• Class name: OrderControllerCore
• Parent class: ParentOrderController
• Source: controllers/front/OrderController.php line 28

Contents

Properties

• $step
• $nbProducts
• $php_self
• $ssl
• $auth
• $authRedirection
• $cart
• $cookie
• $currentCustomerGroups
• $display_column_left
• $display_column_right
• $errors
• $guestAllowed
• $initialized
• $iso
• $link
• $maintenance
• $n
• $nb_items_per_page
• $orderBy
• $orderWay
• $p
• $restrictedCountry
• $smarty
• $ajax
• $content_only
• $context
• $css_files
• $display_footer
• $display_header
• $hook_list
• $js_files
• $json
• $redirect_after
• $status
• $template

Methods

• __construct
• _assignAddress
• _assignCarrier
• _assignPayment
• _assignSummaryInformations
• _assignWrappingAndTOS
• _checkFreeOrder
• _processCarrier
• _setDefaultCarrierSelection
• _updateMessage
• addCSS
• addJS
• addJquery
• addJqueryPlugin
• addJqueryUI
• autoStep
• canonicalRedirection
• checkAccess
• display
• displayFooter
• displayHeader
• displayMaintenancePage
• displayRestrictedCountryPage
• geolocationManagement
• getController
• getCurrentCustomerGroups
• getLiveEditFooter
• init
• initContent
• initCursedPage
• initFooter
• initHeader
• isInWhitelistForGeolocation
• isTokenValid
• pagination
• postProcess
• preProcess
• process
• processAddress
• processAddressFormat
• processCarrier
• productSort
• recoverCart
• redirect
• run
• setDefaultCarrierSelection
• setMedia
• setNoCarrier
• setTemplate
• validateDeliveryOption

Properties

$step

public mixed $step

• Visibility: public
• Source: controllers/front/OrderController.php line 30.

$nbProducts

public mixed $nbProducts

• Visibility: public
• This property is defined by ParentOrderControllerCore.
• Source: controllers/front/ParentOrderController.php line 40.

$php_self

public mixed $php_self = 'order'

• Visibility: public
• This property is defined by ParentOrderControllerCore.
• Source: controllers/front/ParentOrderController.php line 38.

$ssl

public mixed $ssl = true

• Visibility: public
• This property is defined by ParentOrderControllerCore.
• Source: controllers/front/ParentOrderController.php line 37.

$auth

public mixed $auth = false

• Visibility: public
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 44.

$authRedirection

public mixed $authRedirection = false

• Visibility: public
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 46.

$cart

protected mixed $cart

• Visibility: protected
• This property is static.
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 35.

$cookie

protected mixed $cookie

• Visibility: protected
• This property is static.
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 35.

$currentCustomerGroups

protected mixed $currentCustomerGroups

• Visibility: protected
• This property is static.
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 57.

$display_column_left

public mixed $display_column_left = true

• Visibility: public
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 52.

$display_column_right

public mixed $display_column_right = true

• Visibility: public
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 53.

$errors

public mixed $errors = array()

• Visibility: public
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 30.

$guestAllowed

public mixed $guestAllowed = false

• Visibility: public
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 45.

$initialized

public mixed $initialized = false

• Visibility: public
• This property is static.
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 55.

$iso

public mixed $iso

• Visibility: public
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 37.

$link

protected mixed $link

• Visibility: protected
• This property is static.
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 35.

$maintenance

protected mixed $maintenance = false

• Visibility: protected
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 50.

$n

public mixed $n

• Visibility: public
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 42.

$nb_items_per_page

public mixed $nb_items_per_page

• Visibility: public
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 59.

$orderBy

public mixed $orderBy

• Visibility: public
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 39.

$orderWay

public mixed $orderWay

• Visibility: public
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 40.

$p

public mixed $p

• Visibility: public
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 41.

$restrictedCountry

protected mixed $restrictedCountry = false

• Visibility: protected
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 49.

$smarty

protected mixed $smarty

• Visibility: protected
• This property is static.
• This property is defined by FrontControllerCore.
• Source: classes/FrontController.php line 35.

$ajax

protected boolean $ajax = false

• Visibility: protected
• This property is defined by ControllerCore.
• Source: classes/Controller.php line 71.

$content_only

protected string $content_only = false

• Visibility: protected
• This property is defined by ControllerCore.
• Source: classes/Controller.php line 66.

$context

protected \Context $context

• Visibility: protected
• This property is defined by ControllerCore.
• Source: classes/Controller.php line 36.

$css_files

public array $css_files = array()

• Visibility: public
• This property is defined by ControllerCore.
• Source: classes/Controller.php line 41.

$display_footer

protected string $display_footer

• Visibility: protected
• This property is defined by ControllerCore.
• Source: classes/Controller.php line 61.

$display_header

protected boolean $display_header

• Visibility: protected
• This property is defined by ControllerCore.
• Source: classes/Controller.php line 51.

$hook_list

public mixed $hook_list = array()

hook_list is used with liveEdit

• Visibility: public
• This property is defined by ControllerCore.
• Source: classes/Controller.php line 78.

$js_files

public array $js_files = array()

• Visibility: public
• This property is defined by ControllerCore.
• Source: classes/Controller.php line 46.

$json

protected mixed $json = false

• Visibility: protected
• This property is defined by ControllerCore.
• Source: classes/Controller.php line 72.

$redirect_after

protected mixed $redirect_after = null

• Visibility: protected
• This property is defined by ControllerCore.
• Source: classes/Controller.php line 75.

$status

protected mixed $status = ''

• Visibility: protected
• This property is defined by ControllerCore.
• Source: classes/Controller.php line 73.

$template

protected string $template

• Visibility: protected
• This property is defined by ControllerCore.
• Source: classes/Controller.php line 56.

Methods

__construct

mixed FrontControllerCore::__construct()

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 61

_assignAddress

mixed OrderControllerCore::_assignAddress()

Address step

• Visibility: protected
• Source: controllers/front/OrderController.php line 263

_assignCarrier

mixed OrderControllerCore::_assignCarrier()

Carrier step

• Visibility: protected
• Source: controllers/front/OrderController.php line 278

_assignPayment

mixed OrderControllerCore::_assignPayment()

Payment step

• Visibility: protected
• Source: controllers/front/OrderController.php line 293

_assignSummaryInformations

mixed ParentOrderControllerCore::_assignSummaryInformations()

• Visibility: protected
• This method is defined by ParentOrderControllerCore.
• Source: controllers/front/ParentOrderController.php line 266

_assignWrappingAndTOS

mixed ParentOrderControllerCore::_assignWrappingAndTOS()

• Visibility: protected
• This method is defined by ParentOrderControllerCore.
• Source: controllers/front/ParentOrderController.php line 418

_checkFreeOrder

boolean ParentOrderControllerCore::_checkFreeOrder()

Check if order is free

• Visibility: protected
• This method is defined by ParentOrderControllerCore.
• Source: controllers/front/ParentOrderController.php line 155

_processCarrier

mixed ParentOrderControllerCore::_processCarrier()

• Visibility: protected
• This method is defined by ParentOrderControllerCore.
• Source: controllers/front/ParentOrderController.php line 199

_setDefaultCarrierSelection

\number ParentOrderControllerCore::_setDefaultCarrierSelection(array $carriers)

Decides what the default carrier is and update the cart with it

• Visibility: protected
• This method is defined by ParentOrderControllerCore.
• Source: controllers/front/ParentOrderController.php line 514

Arguments

• $carriers array

_updateMessage

mixed ParentOrderControllerCore::_updateMessage($messageContent)

• Visibility: protected
• This method is defined by ParentOrderControllerCore.
• Source: controllers/front/ParentOrderController.php line 167

Arguments

• $messageContent mixed

addCSS

mixed FrontControllerCore::addCSS($css_uri, $css_media_type)

Add one or several CSS for front, checking if css files are overriden in theme/css/modules/ directory

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 805

Arguments

• $css_uri mixed
• $css_media_type mixed

addJS

mixed FrontControllerCore::addJS($js_uri)

Add one or several JS files for front, checking if js files are overriden in theme/js/modules/ directory

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 828

Arguments

• $js_uri mixed

addJquery

void ControllerCore::addJquery($version, $folder, $minifier)

Add a new javascript file in page header.

• Visibility: public
• This method is defined by ControllerCore.
• Source: classes/Controller.php line 283

Arguments

• $version mixed
• $folder mixed
• $minifier mixed

addJqueryPlugin

void ControllerCore::addJqueryPlugin($name, $folder)

Add a new javascript file in page header.

• Visibility: public
• This method is defined by ControllerCore.
• Source: classes/Controller.php line 313

Arguments

• $name mixed
• $folder mixed

addJqueryUI

void ControllerCore::addJqueryUI($component, $theme, $check_dependencies)

Add a new javascript file in page header.

• Visibility: public
• This method is defined by ControllerCore.
• Source: classes/Controller.php line 294

Arguments

• $component mixed
• $theme mixed
• $check_dependencies mixed

autoStep

mixed OrderControllerCore::autoStep()

Order process controller

• Visibility: public
• Source: controllers/front/OrderController.php line 183

canonicalRedirection

mixed FrontControllerCore::canonicalRedirection($canonicalURL)

• Visibility: protected
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 534

Arguments

• $canonicalURL mixed

checkAccess

void FrontControllerCore::checkAccess()

checkAccess

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 74

display

mixed FrontControllerCore::display()

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 455

displayFooter

mixed FrontControllerCore::displayFooter($display)

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 430

Arguments

• $display mixed

displayHeader

mixed FrontControllerCore::displayHeader($display)

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 398

Arguments

• $display mixed

displayMaintenancePage

mixed FrontControllerCore::displayMaintenancePage()

• Visibility: protected
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 516

displayRestrictedCountryPage

mixed FrontControllerCore::displayRestrictedCountryPage()

• Visibility: protected
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 527

geolocationManagement

mixed FrontControllerCore::geolocationManagement($defaultCountry)

• Visibility: protected
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 559

Arguments

• $defaultCountry mixed

getController

mixed ControllerCore::getController(string $class_name, boolean $auth, boolean $ssl)

Get an instance of a controller

• Visibility: public
• This method is static.
• This method is defined by ControllerCore.
• Source: classes/Controller.php line 122

Arguments

• $class_name string
• $auth boolean
• $ssl boolean

getCurrentCustomerGroups

mixed FrontControllerCore::getCurrentCustomerGroups()

• Visibility: public
• This method is static.
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 759

getLiveEditFooter

mixed FrontControllerCore::getLiveEditFooter()

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 662

init

mixed OrderControllerCore::init()

Initialize order controller

• Visibility: public
• Source: controllers/front/OrderController.php line 36

initContent

mixed FrontControllerCore::initContent()

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 383

initCursedPage

mixed FrontControllerCore::initCursedPage()

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 441

initFooter

mixed FrontControllerCore::initFooter()

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 654

initHeader

mixed FrontControllerCore::initHeader()

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 636

isInWhitelistForGeolocation

mixed FrontControllerCore::isInWhitelistForGeolocation()

• Visibility: protected
• This method is static.
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 777

isTokenValid

boolean FrontControllerCore::isTokenValid()

Check if token is valid

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 795

pagination

mixed FrontControllerCore::pagination($nbProducts)

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 708

Arguments

• $nbProducts mixed

postProcess

mixed FrontControllerCore::postProcess()

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 363

preProcess

mixed FrontControllerCore::preProcess()

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 379

process

mixed FrontControllerCore::process()

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 446

processAddress

mixed OrderControllerCore::processAddress()

• Visibility: public
• Source: controllers/front/OrderController.php line 209

processAddressFormat

mixed OrderControllerCore::processAddressFormat()

• Visibility: private
• Source: controllers/front/OrderController.php line 167

processCarrier

mixed OrderControllerCore::processCarrier()

Carrier step

• Visibility: protected
• Source: controllers/front/OrderController.php line 243

productSort

mixed FrontControllerCore::productSort()

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 681

recoverCart

mixed FrontControllerCore::recoverCart()

• Visibility: protected
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 847

redirect

mixed FrontControllerCore::redirect()

• Visibility: public
• This method is defined by FrontControllerCore.
• Source: classes/FrontController.php line 450

run

mixed ControllerCore::run()

Start controller process (this method shouldn't be overriden !)

• Visibility: public
• This method is defined by ControllerCore.
• Source: classes/Controller.php line 143

setDefaultCarrierSelection

\number ParentOrderControllerCore::setDefaultCarrierSelection(array $carriers)

Decides what the default carrier is and update the cart with it

• Visibility: protected
• This method is defined by ParentOrderControllerCore.
• Source: controllers/front/ParentOrderController.php line 479

Arguments

• $carriers array

setMedia

mixed ParentOrderControllerCore::setMedia()

• Visibility: public
• This method is defined by ParentOrderControllerCore.
• Source: controllers/front/ParentOrderController.php line 133

setNoCarrier

mixed ParentOrderControllerCore::setNoCarrier()

Set id_carrier to 0 (no shipping price)

• Visibility: protected
• This method is defined by ParentOrderControllerCore.
• Source: controllers/front/ParentOrderController.php line 462

setTemplate

mixed ControllerCore::setTemplate($template)

• Visibility: public
• This method is defined by ControllerCore.
• Source: classes/Controller.php line 196

Arguments

• $template mixed

validateDeliveryOption

mixed ParentOrderControllerCore::validateDeliveryOption(array $delivery_option)

Validate get/post param delivery option

• Visibility: protected
• This method is defined by ParentOrderControllerCore.
• Source: controllers/front/ParentOrderController.php line 254

Arguments

• $delivery_option array