OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration:

Public Member Functions
	render ()
	saveConfVars ()
	save ()
	loadConfVars ($shopId, $moduleId)
	informationSendingToOxidConfigurable ()
	_unserializeConfVar ($type, $name, $value)
	_serializeConfVar ($type, $name, $value)
	getEditObjectId ()

Protected Member Functions
	_getModuleForConfigVars ()
	_parseConstraint ($type, $constraint)
	_serializeConstraint ($type, $constraint)
	_arrayToMultiline ($input)
	_multilineToArray ($multiline)
	_aarrayToMultiline ($input)
	_multilineToAarray ($multiline)

Protected Attributes
	$_sThisTemplate = 'shop_config.tpl'
	$_aSkipMultiline = ['aHomeCountry']
	$_aParseFloat = ['iMinOrderPrice']
	$_aConfParams

Private Member Functions
	saveSetting (string $configName, string $existingConfigType, $configValue)

Detailed Description

Admin shop config manager. Collects shop config information, updates it on user submit, etc. Admin Menu: Main Menu -> Core Settings -> General.

Member Function Documentation

_aarrayToMultiline()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::_aarrayToMultiline (   $input )

protected

Converts associative array to multiline text. Returns this text.

Parameters

array

$input

Array to convert

Returns

string

Deprecated:

underscore prefix violates PSR12, will be renamed to "aarrayToMultiline" in next major

_arrayToMultiline()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::_arrayToMultiline (   $input )

protected

Converts simple array to multiline text. Returns this text.

Parameters

array

$input

Array with text

Returns

string

Deprecated:

underscore prefix violates PSR12, will be renamed to "arrayToMultiline" in next major

_getModuleForConfigVars()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::_getModuleForConfigVars ( )

protected

return theme filter for config variables

Returns

string

Deprecated:

underscore prefix violates PSR12, will be renamed to "getModuleForConfigVars" in next major

_multilineToAarray()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::_multilineToAarray (   $multiline )

protected

Converts Multiline text to associative array. Returns this array.

Parameters

string

$multiline

Multiline text

Returns

array

Deprecated:

underscore prefix violates PSR12, will be renamed to "multilineToAarray" in next major

_multilineToArray()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::_multilineToArray (   $multiline )

protected

Converts Multiline text to simple array. Returns this array.

Parameters

string

$multiline

Multiline text

Returns

array

Deprecated:

underscore prefix violates PSR12, will be renamed to "multilineToArray" in next major

_parseConstraint()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::_parseConstraint (   $type,   $constraint  )

protected

parse constraint from type and serialized values

Parameters

string	$type	variable type
string	$constraint	serialized constraint

Returns

mixed

Deprecated:

underscore prefix violates PSR12, will be renamed to "parseConstraint" in next major

_serializeConfVar()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::_serializeConfVar	(		$type,
			$name,
			$value
	)

Prepares data for storing to database. Example: $sType='aarr', $sName='aModules', $mValue='key1=>val1\nkey2=>val2'

Parameters

string	$type	var type
string	$name	var name
mixed	$value	var value

Returns

string

Deprecated:

will be renamed to "serializeConfVar" in next major

_serializeConstraint()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::_serializeConstraint (   $type,   $constraint  )

protected

serialize constraint from type and value

Parameters

string	$type	variable type
mixed	$constraint	constraint value

Returns

string

Deprecated:

underscore prefix violates PSR12, will be renamed to "serializeConstraint" in next major

_unserializeConfVar()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::_unserializeConfVar	(		$type,
			$name,
			$value
	)

Unserialize config var depending on it's type

Parameters

string	$type	var type
string	$name	var name
string	$value	var value

Returns

mixed

Deprecated:

will be renamed to "unserializeConfVar" in next major

getEditObjectId()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::getEditObjectId

(

)

Returns active/editable object id

Returns

string

informationSendingToOxidConfigurable()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::informationSendingToOxidConfigurable

(

)

If allow to configure information sending to OXID. For PE and EE users it is always turned on.

Returns

bool

loadConfVars()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::loadConfVars	(		$shopId,
			$moduleId
	)

Load and parse config vars from db. Return value is a map: 'vars' => config variable values as array[type][name] = value 'constraints' => constraints list as array[name] = constraint 'grouping' => grouping info as array[name] = grouping

Parameters

string	$shopId	Shop id
string	$moduleId	module to load (empty string is for base values)

Returns

array

render()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::render

(

)

Executes parent method parent::render(), passes shop configuration parameters to Smarty and returns name of template file "shop_config.tpl".

Returns

string

save()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::save

(

)

Saves changed shop configuration parameters.

saveConfVars()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::saveConfVars

(

)

Saves shop configuration variables

saveSetting()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::saveSetting ( string  $configName, string  $existingConfigType,   $configValue  )

private

Parameters

string	$configName
string	$existingConfigType
mixed	$configValue

Member Data Documentation

$_aConfParams

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::$_aConfParams

protected

Initial value:

= [
        "bool"   => 'confbools',
        "str"    => 'confstrs',
        "arr"    => 'confarrs',
        "aarr"   => 'confaarrs',
        "select" => 'confselects',
        "num"    => 'confnum',
    ]

$_aParseFloat

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::$_aParseFloat = ['iMinOrderPrice']

protected

$_aSkipMultiline

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::$_aSkipMultiline = ['aHomeCountry']

protected

$_sThisTemplate

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopConfiguration::$_sThisTemplate = 'shop_config.tpl'

protected

---

The documentation for this class was generated from the following file:

• /oxideshop-ce/source/Application/Controller/Admin/ShopConfiguration.php