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

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

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

Public Member Functions
	__construct ()
	render ()
	createMainExportView ()
	start ()
	stop ($iError=0)
	nextTick ($iCnt)
	write ($sLine)
	run ()
	getExportPerTick ()
	setExportPerTick ($iCount)
	removeSid ($sInput)
	shrink ($sInput, $iMaxSize, $blRemoveNewline=true)
	getCategoryString ($oArticle, $sSeparator="/")
	getDefaultCategoryString ($oArticle)
	prepareCSV ($sInput)
	prepareXML ($sInput)
	getDeepestCategoryPath ($oArticle)
	prepareExport ()
	getOneArticle ($iCnt, & $blContinue)
	assureContent ($sInput, $sReplace=null)
	getViewId ()

Public Attributes
	$sClassDo = ""
	$sClassMain = ""
	$sExportPath = "export/"
	$sExportFileType = "txt"
	$sExportFileName = "dynexport"
	$fpFile = null
	$iExportPerTick = 30

Protected Member Functions
	_unHtmlEntities ($sInput)
	_getHeapTableName ()
	_generateTableCharSet ($sMysqlVersion)
	_createHeapTable ($sHeapTable, $sTableCharset)
	_getCatAdd ($aChosenCat)
	_insertArticles ($sHeapTable, $sCatAdd)
	_removeParentArticles ($sHeapTable)
	_setSessionParams ()
	_loadRootCats ()
	_findDeepestCatPath ($oArticle)
	_initArticle ($sHeapTable, $iCnt, & $blContinue)
	_setCampaignDetailLink ($oArticle)
	updateArticle ($article)
	getDb ()

Protected Attributes
	$_iExportPerTick = null
	$_sFilePath = null
	$_aExportResultset = []
	$_sThisTemplate = "dynexportbase.tpl"
	$_aCatLvlCache = null

Detailed Description

DynExportBase framework class encapsulating a method for defining implementation class. Performs export function according to user chosen categories.

@subpackage dyn

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::__construct

(

)

Calls parent costructor and initializes $this->_sFilePath parameter

Member Function Documentation

_createHeapTable()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::_createHeapTable (   $sHeapTable,   $sTableCharset  )

protected

creates heaptable

Parameters

string	$sHeapTable	table name
string	$sTableCharset	table charset

Returns

bool

_findDeepestCatPath()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::_findDeepestCatPath (   $oArticle )

protected

finds deepest category path

Parameters

\OxidEsales\Eshop\Application\Model\Article

$oArticle

article object

Returns

string

_generateTableCharSet()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::_generateTableCharSet (   $sMysqlVersion )

protected

generates table charset

Parameters

string

$sMysqlVersion

MySql version

Returns

string

_getCatAdd()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::_getCatAdd (   $aChosenCat )

protected

creates additional cat string

Parameters

array

$aChosenCat

Selected category array

Returns

string

_getHeapTableName()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::_getHeapTableName ( )

protected

Create valid Heap table name

Returns

string

_initArticle()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::_initArticle (   $sHeapTable,   $iCnt, &  $blContinue  )

protected

initialize article

Parameters

string	$sHeapTable	heap table name
int	$iCnt	record number
bool	$blContinue	false is used to stop exporting

Returns

object

_insertArticles()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::_insertArticles (   $sHeapTable,   $sCatAdd  )

protected

inserts articles into heaptable

Parameters

string	$sHeapTable	heap table name
string	$sCatAdd	category id filter (part of sql)

Returns

bool

_loadRootCats()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::_loadRootCats ( )

protected

Load all root cat's == all trees

Returns

null

_removeParentArticles()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::_removeParentArticles (   $sHeapTable )

protected

removes parent articles so that we only have variants itself

Parameters

string

$sHeapTable

table name

_setCampaignDetailLink()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::_setCampaignDetailLink (   $oArticle )

protected

sets detail link for campaigns

Parameters

\OxidEsales\Eshop\Application\Model\Article

$oArticle

article object

Returns

\OxidEsales\Eshop\Application\Model\Article

_setSessionParams()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::_setSessionParams ( )

protected

stores some info in session

_unHtmlEntities()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::_unHtmlEntities (   $sInput )

protected

Replace HTML Entities Replacement for html_entity_decode which is only available from PHP 4.3.0 onj

Parameters

string

$sInput

string to replace

Returns

string

assureContent()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::assureContent	(		$sInput,
			$sReplace = null
	)

Make sure that string is never empty.

Parameters

string	$sInput	string that will be replaced
string	$sReplace	string that will replace

Returns

string

createMainExportView()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::createMainExportView

(

)

Prepares and fill all data which all the dyn exports needs

getCategoryString()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::getCategoryString	(		$oArticle,
			$sSeparator = "/"
	)

Loads all article parent categories and returns titles separated by "/"

Parameters

object	$oArticle	Article object
string	$sSeparator	separator (default "/")

Returns

string

getDb()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::getDb ( )

protected

Get the actual database.

Returns

\OxidEsales\Eshop\Core\Database\Adapter\DatabaseInterface The database.

getDeepestCategoryPath()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::getDeepestCategoryPath

(

$oArticle

)

Searches for deepest path to a categorie this article is assigned to

Parameters

\OxidEsales\Eshop\Application\Model\Article

$oArticle

article object

Returns

string

getDefaultCategoryString()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::getDefaultCategoryString

(

$oArticle

)

Loads article default category

Parameters

\OxidEsales\Eshop\Application\Model\Article

$oArticle

Article object

Returns

record set

getExportPerTick()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::getExportPerTick

(

)

Returns how many articles should be exported per tick

Returns

int

getOneArticle()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::getOneArticle	(		$iCnt,
		&	$blContinue
	)

get's one oxid for exporting

Parameters

integer	$iCnt	counter
bool	$blContinue	false is used to stop exporting

Returns

mixed

getViewId()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::getViewId

(

)

Returns view id ('dyn_interface')

Returns

string

nextTick()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::nextTick

(

$iCnt

)

virtual function must be overloaded

Parameters

integer

$iCnt

counter

Returns

bool

prepareCSV()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::prepareCSV

(

$sInput

)

Converts field for CSV

Parameters

string

$sInput

input to process

Returns

string

prepareExport()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::prepareExport

(

)

create export resultset

Returns

int

prepareXML()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::prepareXML

(

$sInput

)

Changes special chars to be XML compatible

Parameters

string

$sInput

string which have to be changed

Returns

string

removeSid()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::removeSid

(

$sInput

)

Removes Session ID from $sInput

Parameters

string

$sInput

Input to process

Returns

null

render()

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

(

)

Calls parent rendering methods, sends implementation class names to template and returns default template name

Returns

string

run()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::run

(

)

Does Export

setExportPerTick()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::setExportPerTick

(

$iCount

)

Sets how many articles should be exported per tick

Parameters

int

$iCount

articles count per tick

shrink()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::shrink	(		$sInput,
			$iMaxSize,
			$blRemoveNewline = true
	)

Removes tags, shortens a string to $iMaxSize adding "..."

Parameters

string	$sInput	input to process
integer	$iMaxSize	maximum output size
bool	$blRemoveNewline	if true - and \r will be replaced by " "

Returns

string

start()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::start

(

)

Prepares Export

stop()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::stop

(

$iError = 0

)

Stops Export

Parameters

integer

$iError

error number

updateArticle()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::updateArticle (   $article )

protected

Updates Article object. Method is used for overriding.

Parameters

\OxidEsales\Eshop\Application\Model\Article

$article

Returns

\OxidEsales\Eshop\Application\Model\Article

write()

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::write

(

$sLine

)

writes one line into open export file

Parameters

string

$sLine

exported line

Member Data Documentation

$_aCatLvlCache

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::$_aCatLvlCache = null

protected

$_aExportResultset

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::$_aExportResultset = []

protected

$_iExportPerTick

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::$_iExportPerTick = null

protected

$_sFilePath

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::$_sFilePath = null

protected

$_sThisTemplate

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::$_sThisTemplate = "dynexportbase.tpl"

protected

$fpFile

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::$fpFile = null

$iExportPerTick

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::$iExportPerTick = 30

$sClassDo

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::$sClassDo = ""

$sClassMain

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::$sClassMain = ""

$sExportFileName

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::$sExportFileName = "dynexport"

$sExportFileType

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::$sExportFileType = "txt"

$sExportPath

OxidEsales\EshopCommunity\Application\Controller\Admin\DynamicExportBaseController::$sExportPath = "export/"

---

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

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