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

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

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

Public Member Functions
	render ()
	resetNrOfCatArticles ()
	resetNrOfVendorArticles ()
	resetNrOfManufacturerArticles ()
	changeFolder ()

Protected Member Functions
	getDocumentationLanguageId ()
	_getEditValue ($oObject, $sField)
	_processEditValue ($sValue)
	_getPlainEditor ($width, $height, $object, $field)
	_generateTextEditor ($width, $height, $object, $field, $stylesheet=null)
	generateTextEditor ($width, $height, $object, $field, $stylesheet=null)
	_createCategoryTree ($sTplVarName, $sEditCatId='', $blForceNonCache=false, $iTreeShopId=null)
	_getCategoryTree ($sTplVarName, $sSelectedCatId, $sEditCatId='', $blForceNonCache=false, $iTreeShopId=null)
	_setupNavigation ($sNode)
	_resetCounts ($aIds)
	configureTextEditorHandler (\OxidEsales\Eshop\Application\Controller\TextEditorHandler $textEditorHandler, $editedObject, $field, $stylesheet)
	createTextEditorHandler ()

Protected Attributes
	$_oEditor = null

Detailed Description

Admin selectlist list manager.

Member Function Documentation

_createCategoryTree()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::_createCategoryTree (   $sTplVarName,   $sEditCatId = '',   $blForceNonCache = false,   $iTreeShopId = null  )

protected

Function creates category tree for select list used in "Category main", "Article extend" etc.

Parameters

string	$sTplVarName	name of template variable where is stored category tree
string	$sEditCatId	ID of category witch we are editing
bool	$blForceNonCache	Set to true to disable caching
int	$iTreeShopId	tree shop id

Returns

string

_generateTextEditor()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::_generateTextEditor (   $width,   $height,   $object,   $field,   $stylesheet = null  )

protected

Generates Text editor html code.

Parameters

int	$width	editor width
int	$height	editor height
\OxidEsales\Eshop\Core\Model\BaseModel	$object	object passed to editor
string	$field	object field which content is passed to editor
string	$stylesheet	stylesheet to use in editor

Deprecated:

since v6.0 (2017-06-29); Please use generateTextEditor() method.

Returns

string Editor output

_getCategoryTree()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::_getCategoryTree (   $sTplVarName,   $sSelectedCatId,   $sEditCatId = '',   $blForceNonCache = false,   $iTreeShopId = null  )

protected

Function creates category tree for select list used in "Category main", "Article extend" etc. Returns ID of selected category if available.

Parameters

string	$sTplVarName	name of template variable where is stored category tree
string	$sSelectedCatId	ID of category witch was selected in select list
string	$sEditCatId	ID of category witch we are editing
bool	$blForceNonCache	Set to true to disable caching
int	$iTreeShopId	tree shop id

Returns

string

_getEditValue()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::_getEditValue (   $oObject,   $sField  )

protected

Returns string which must be edited by editor.

Parameters

\OxidEsales\Eshop\Core\Model\BaseModel	$oObject	object used for editing
string	$sField	name of editable field

Returns

string

_getPlainEditor()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::_getPlainEditor (   $width,   $height,   $object,   $field  )

protected

Returns textarea filled with text to edit.

Parameters

int	$width	editor width
int	$height	editor height
\OxidEsales\Eshop\Core\Model\BaseModel	$object	object passed to editor
string	$field	object field which content is passed to editor

Deprecated:

since v6.0 (2017-06-29); Please use TextEditorHandler::renderPlainTextEditor() method.

Returns

string

_processEditValue()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::_processEditValue (   $sValue )

protected

Processes edit value.

Parameters

string

$sValue

string to process

Returns

string

_resetCounts()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::_resetCounts (   $aIds )

protected

Resets count of vendor/manufacturer category items.

Parameters

array

$aIds

to reset type => id

_setupNavigation()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::_setupNavigation (   $sNode )

protected

Sets-up navigation parameters.

Parameters

string

$sNode

active view id

changeFolder()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::changeFolder

(

)

Updates object folder parameters.

configureTextEditorHandler()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::configureTextEditorHandler ( \OxidEsales\Eshop\Application\Controller\TextEditorHandler  $textEditorHandler,   $editedObject,   $field,   $stylesheet  )

protected

Create the handler for the text editor.

Note: the parameters editedObject and field are not used here but in the enterprise edition.

Parameters

\OxidEsales\Eshop\Application\Controller\TextEditorHandler	$textEditorHandler
mixed	$editedObject	The object we want to edit. Either type of \OxidEsales\Eshop\Core\BaseModel if you want to persist or anything else
string	$field	The input field we want to edit
string	$stylesheet	The name of the CSS file

createTextEditorHandler()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::createTextEditorHandler ( )

protected

Create the handler for the text editor.

Returns

\OxidEsales\Eshop\Application\Controller\TextEditorHandler The text editor handler

generateTextEditor()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::generateTextEditor (   $width,   $height,   $object,   $field,   $stylesheet = null  )

protected

Generates Text editor html code.

Parameters

int	$width	editor width
int	$height	editor height
\OxidEsales\Eshop\Core\Model\BaseModel	$object	object passed to editor
string	$field	object field which content is passed to editor
string	$stylesheet	stylesheet to use in editor

Returns

string Editor output

getDocumentationLanguageId()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::getDocumentationLanguageId ( )

protected

Get language id for documentation by current language id.

Returns

int

render()

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

(

)

Calls parent::render, sets admin help url.

Returns

string

resetNrOfCatArticles()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::resetNrOfCatArticles

(

)

Resets number of articles in current shop categories.

resetNrOfManufacturerArticles()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::resetNrOfManufacturerArticles

(

)

Resets number of articles in current shop manufacturers.

resetNrOfVendorArticles()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::resetNrOfVendorArticles

(

)

Resets number of articles in current shop vendors.

Member Data Documentation

$_oEditor

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminDetailsController::$_oEditor = null

protected

---

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

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