OXID eShop CE  4.8.11
 All Classes Files Functions Variables Pages
DynExportBase Class Reference
+ Inheritance diagram for DynExportBase:
+ Collaboration diagram for DynExportBase:

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 Member Functions inherited from oxAdminDetails
 resetNrOfCatArticles ()
 resetNrOfVendorArticles ()
 resetNrOfManufacturerArticles ()
 changeFolder ()
- Public Member Functions inherited from oxAdminView
 init ()
 addGlobalParams ($oShop=null)
 getServiceUrl ($sLangAbbr=null)
 save ()
 resetContentCache ($blForceReset=null)
 resetCounter ($sCounterType, $sValue=null)
 getNavigation ()
 chshp ()
 resetSeoData ($sShopId)
 getPreviewId ()
 getEditObjectId ()
 setEditObjectId ($sId)
- Public Member Functions inherited from oxView
 setViewParameters ($aParams=null)
 getViewParameter ($sKey)
 setIsCallForCache ($blIsCallForCache=null)
 getIsCallForCache ()
 addTplParam ($sPara, $sValue)
 getBelboonParam ()
 getViewConfig ()
 getTemplateName ()
 setTemplateName ($sTemplate)
 setClassName ($sClassName)
 getClassName ()
 setFncName ($sFncName)
 getFncName ()
 setViewData ($aViewData=null)
 getViewData ()
 getViewDataElement ($sParamId=null)
 setClassLocation ($sClassLocation=null)
 getClassLocation ()
 setThisAction ($sThisAction=null)
 getThisAction ()
 setParent ($oParent=null)
 getParent ()
 setIsComponent ($blIsComponent=null)
 getIsComponent ()
 executeFunction ($sFunction)
 getAdditionalParams ()
 getTrustedShopId ()
 getTSExcellenceId ()
 getCharSet ()
 getShopVersion ()
 getShopEdition ()
 getRevision ()
 getPackageInfo ()
 getShopFullEdition ()
 isDemoVersion ()
 isBetaVersion ()
 isRCVersion ()
 showBetaNote ()
 isDemoShop ()
 showNewsletter ()
 setShowNewsletter ($blShow)
 getShopLogo ()
 setShopLogo ($sLogo)
 getActCategory ()
 setActCategory ($oCategory)
 getCategoryId ()
 setCategoryId ($sCategoryId)
 getErrorDestination ()
 getActionClassName ()
 isConnectedWithFb ()
 getFbUserId ()
 showFbConnectToAccountMsg ()
 isMall ()
 showRdfa ()
 getSidForWidget ()
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

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)
- Protected Member Functions inherited from oxAdminDetails
 _getTextEditor ($iWidth, $iHeight, $oObject, $sField, $sStylesheet=null)
 _getEditValue ($oObject, $sField)
 _processEditValue ($sValue)
 _getPlainEditor ($iWidth, $iHeight, $oObject, $sField)
 _generateTextEditor ($iWidth, $iHeight, $oObject, $sField, $sStylesheet=null)
 _createCategoryTree ($sTplVarName, $sEditCatId= '', $blForceNonCache=false, $iTreeShopId=null)
 _getCategoryTree ($sTplVarName, $sSelectedCatId, $sEditCatId= '', $blForceNonCache=false, $iTreeShopId=null)
 _setupNavigation ($sNode)
 _resetCounts ($aIds)
- Protected Member Functions inherited from oxAdminView
 _getEditShop ($sShopId)
 _getServiceProtocol ()
 _getShopVersionNr ()
 _addNavigationHistory ($sNode)
 _getMaxUploadFileInfo ($iMaxFileSize, $blFormatted=false)
 _allowAdminEdit ($sUserId)
 _getCountryByCode ($sCountryCode)
 _authorize ()
- Protected Member Functions inherited from oxView
 _executeNewAction ($sNewAction)

Protected Attributes

 $_iExportPerTick = null
 $_sFilePath = null
 $_aExportResultset = array()
 $_sThisTemplate = "dynexportbase.tpl"
 $_aCatLvlCache = null
- Protected Attributes inherited from oxAdminDetails
 $_oEditor = null
- Protected Attributes inherited from oxAdminView
 $_aSumType
 $_sThisTemplate = null
 $_iDefEdit = 0
 $_iEditLang = 0
 $_sShopTitle = " - "
 $_sShopVersion = null
 $_sServiceUrl = null
 $_oEditShop = null
 $_sEditObjectId = null
- Protected Attributes inherited from oxView
 $_aViewData = array()
 $_sClassLocation = null
 $_sThisAction = null
 $_oParent = null
 $_blIsComponent = false
 $_sThisTemplate = null
 $_sViewId = null
 $_sClass = null
 $_sFnc = null
 $_sTrustedShopId = null
 $_sTSExcellenceId = null
 $_sCharSet = null
 $_sVersion = null
 $_blDemoVersion = null
 $_blDemoShop = null
 $_iNewsStatus = null
 $_sShopLogo = null
 $_sCategoryId = null
 $_oClickCat = null
 $_blIsCallForCache = false
 $_oViewConf = null

Additional Inherited Members

- Static Protected Attributes inherited from oxAdminView
static $_oNaviTree = null
static $_sAuthUserRights = null

Detailed Description

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

Definition at line 15 of file dynexportbase.php.

Constructor & Destructor Documentation

DynExportBase::__construct ( )

Calls parent costructor and initializes $this->_sFilePath parameter

Returns
null

Reimplemented from oxAdminView.

Reimplemented in VoucherSerie_Export.

Definition at line 107 of file dynexportbase.php.

Member Function Documentation

DynExportBase::_createHeapTable (   $sHeapTable,
  $sTableCharset 
)
protected

creates heaptable

Parameters
string$sHeapTabletable name
string$sTableCharsettable charset
Returns
bool

Definition at line 591 of file dynexportbase.php.

DynExportBase::_findDeepestCatPath (   $oArticle)
protected

finds deepest category path

Parameters
oxarticle$oArticlearticle object
Returns
string

Definition at line 829 of file dynexportbase.php.

DynExportBase::_generateTableCharSet (   $sMysqlVersion)
protected

generates table charset

Parameters
string$sMysqlVersionMySql version
Returns
string

Definition at line 564 of file dynexportbase.php.

DynExportBase::_getCatAdd (   $aChosenCat)
protected

creates additional cat string

Parameters
array$aChosenCatSelected category array
Returns
string

Definition at line 612 of file dynexportbase.php.

DynExportBase::_getHeapTableName ( )
protected

Create valid Heap table name

Returns
string

Definition at line 551 of file dynexportbase.php.

DynExportBase::_initArticle (   $sHeapTable,
  $iCnt,
$blContinue 
)
protected

initialize article

Parameters
string$sHeapTableheap table name
int$iCntrecord number
bool&$blContinuefalse is used to stop exporting
Returns
object

Definition at line 869 of file dynexportbase.php.

DynExportBase::_insertArticles (   $sHeapTable,
  $sCatAdd 
)
protected

inserts articles into heaptable

Parameters
string$sHeapTableheap table name
string$sCatAddcategory id filter (part of sql)
Returns
bool

Definition at line 639 of file dynexportbase.php.

DynExportBase::_loadRootCats ( )
protected

Load all root cat's == all trees

Returns
null

Definition at line 780 of file dynexportbase.php.

DynExportBase::_removeParentArticles (   $sHeapTable)
protected

removes parent articles so that we only have variants itself

Parameters
string$sHeapTabletable name
Returns
null

Definition at line 697 of file dynexportbase.php.

DynExportBase::_setCampaignDetailLink (   $oArticle)
protected

sets detail link for campaigns

Parameters
oxarticle$oArticlearticle object
Returns
oxarticle

Definition at line 905 of file dynexportbase.php.

DynExportBase::_setSessionParams ( )
protected

stores some info in session

Returns
null

Definition at line 732 of file dynexportbase.php.

DynExportBase::_unHtmlEntities (   $sInput)
protected

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

Parameters
string$sInputstring to replace
Returns
string

Definition at line 540 of file dynexportbase.php.

DynExportBase::assureContent (   $sInput,
  $sReplace = null 
)

Make sure that string is never empty.

Parameters
string$sInputstring that will be replaced
string$sReplacestring that will replace
Returns
string

Definition at line 520 of file dynexportbase.php.

DynExportBase::createMainExportView ( )

Prepares and fill all data which all the dyn exports needs

Returns
null

Definition at line 142 of file dynexportbase.php.

DynExportBase::getCategoryString (   $oArticle,
  $sSeparator = "/" 
)

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

Parameters
object$oArticleArticle object
string$sSeparatorseparator (default "/")
Returns
string

Definition at line 347 of file dynexportbase.php.

DynExportBase::getDeepestCategoryPath (   $oArticle)

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

Parameters
oxarticle$oArticlearticle object
Returns
string

Definition at line 445 of file dynexportbase.php.

DynExportBase::getDefaultCategoryString (   $oArticle)

Loads article default category

Parameters
oxarticle$oArticleArticle object
Returns
record set

Definition at line 392 of file dynexportbase.php.

DynExportBase::getExportPerTick ( )

Returns how many articles should be exported per tick

Returns
int

Definition at line 266 of file dynexportbase.php.

DynExportBase::getOneArticle (   $iCnt,
$blContinue 
)

get's one oxid for exporting

Parameters
integer$iCntcounter
bool&$blContinuefalse is used to stop exporting
Returns
mixed

Definition at line 491 of file dynexportbase.php.

DynExportBase::getViewId ( )

Returns view id ('dyn_interface')

Returns
string

Reimplemented from oxAdminView.

Reimplemented in VoucherSerie_Main.

Definition at line 926 of file dynexportbase.php.

DynExportBase::nextTick (   $iCnt)

virtual function must be overloaded

Parameters
integer$iCntcounter
Returns
bool

Reimplemented in VoucherSerie_Generate, and GenExport_Do.

Definition at line 204 of file dynexportbase.php.

DynExportBase::prepareCSV (   $sInput)

Converts field for CSV

Parameters
string$sInputinput to process
Returns
string

Definition at line 414 of file dynexportbase.php.

DynExportBase::prepareExport ( )

create export resultset

Returns
int

Reimplemented in VoucherSerie_Main.

Definition at line 455 of file dynexportbase.php.

DynExportBase::prepareXML (   $sInput)

Changes special chars to be XML compatible

Parameters
string$sInputstring which have to be changed
Returns
string

Definition at line 427 of file dynexportbase.php.

DynExportBase::removeSid (   $sInput)

Removes Session ID from $sInput

Parameters
string$sInputInput to process
Returns
null

Definition at line 296 of file dynexportbase.php.

DynExportBase::render ( )

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

Returns
string

Reimplemented from oxAdminDetails.

Reimplemented in VoucherSerie_Main, and GenExport_Main.

Definition at line 121 of file dynexportbase.php.

DynExportBase::run ( )

Does Export

Returns
null

Reimplemented in VoucherSerie_Export, and VoucherSerie_Generate.

Definition at line 228 of file dynexportbase.php.

DynExportBase::setExportPerTick (   $iCount)

Sets how many articles should be exported per tick

Parameters
int$iCountarticles count per tick
Returns
int

Definition at line 284 of file dynexportbase.php.

DynExportBase::shrink (   $sInput,
  $iMaxSize,
  $blRemoveNewline = true 
)

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

Parameters
string$sInputinput to process
integer$iMaxSizemaximum output size
bool$blRemoveNewlineif true -
and will be replaced by " "
Returns
string

Definition at line 319 of file dynexportbase.php.

DynExportBase::start ( )

Prepares Export

Returns
null

Reimplemented in VoucherSerie_Main.

Definition at line 161 of file dynexportbase.php.

DynExportBase::stop (   $iError = 0)

Stops Export

Parameters
integer$iErrorerror number
Returns
null

Definition at line 187 of file dynexportbase.php.

DynExportBase::write (   $sLine)

writes one line into open export file

Parameters
string$sLineexported line
Returns
null

Reimplemented in VoucherSerie_Export, and GenExport_Do.

Definition at line 216 of file dynexportbase.php.

Member Data Documentation

DynExportBase::$_aCatLvlCache = null
protected

Definition at line 100 of file dynexportbase.php.

DynExportBase::$_aExportResultset = array()
protected

Definition at line 86 of file dynexportbase.php.

DynExportBase::$_iExportPerTick = null
protected

Definition at line 72 of file dynexportbase.php.

DynExportBase::$_sFilePath = null
protected

Definition at line 79 of file dynexportbase.php.

DynExportBase::$_sThisTemplate = "dynexportbase.tpl"
protected

Definition at line 93 of file dynexportbase.php.

DynExportBase::$fpFile = null

Definition at line 57 of file dynexportbase.php.

DynExportBase::$iExportPerTick = 30

Definition at line 65 of file dynexportbase.php.

DynExportBase::$sClassDo = ""

Definition at line 22 of file dynexportbase.php.

DynExportBase::$sClassMain = ""

Definition at line 29 of file dynexportbase.php.

DynExportBase::$sExportFileName = "dynexport"

Definition at line 50 of file dynexportbase.php.

DynExportBase::$sExportFileType = "txt"

Definition at line 43 of file dynexportbase.php.

DynExportBase::$sExportPath = "export/"

Definition at line 36 of file dynexportbase.php.


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