Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes

DynExportBase Class Reference

Inheritance diagram for DynExportBase:
Collaboration diagram for DynExportBase:

List of all members.

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)

Protected Attributes

 $_iExportPerTick = null
 $_sFilePath = null
 $_aExportResultset = array()
 $_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. 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 $sHeapTable table name
string $sTableCharset table charset
Returns:
bool

Definition at line 591 of file dynexportbase.php.

DynExportBase._findDeepestCatPath ( $  oArticle  )  [protected]

finds deepest category path

Parameters:
oxarticle $oArticle article object
Returns:
string

Definition at line 829 of file dynexportbase.php.

DynExportBase._generateTableCharSet ( $  sMysqlVersion  )  [protected]

generates table charset

Parameters:
string $sMysqlVersion MySql version
Returns:
string

Definition at line 564 of file dynexportbase.php.

DynExportBase._getCatAdd ( $  aChosenCat  )  [protected]

creates additional cat string

Parameters:
array $aChosenCat Selected 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 $sHeapTable heap table name
int $iCnt record number
bool &$blContinue false 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 $sHeapTable heap table name
string $sCatAdd category 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 $sHeapTable table name
Returns:
null

Definition at line 697 of file dynexportbase.php.

DynExportBase._setCampaignDetailLink ( $  oArticle  )  [protected]

sets detail link for campaigns

Parameters:
oxarticle $oArticle article 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 $sInput string 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 $sInput string that will be replaced
string $sReplace string 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 $oArticle Article object
string $sSeparator separator (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 $oArticle article object
Returns:
string

Definition at line 445 of file dynexportbase.php.

DynExportBase.getDefaultCategoryString ( $  oArticle  ) 

Loads article default category

Parameters:
oxarticle $oArticle Article 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 $iCnt counter
bool &$blContinue false 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 $iCnt counter
Returns:
bool

Reimplemented in GenExport_Do, and VoucherSerie_Generate.

Definition at line 204 of file dynexportbase.php.

DynExportBase.prepareCSV ( $  sInput  ) 

Converts field for CSV

Parameters:
string $sInput input 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 $sInput string 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 $sInput Input 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 GenExport_Main, and VoucherSerie_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 $iCount articles 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 $sInput input to process
integer $iMaxSize maximum output size
bool $blRemoveNewline if 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 $iError error number
Returns:
null

Definition at line 187 of file dynexportbase.php.

DynExportBase.write ( $  sLine  ) 

writes one line into open export file

Parameters:
string $sLine exported line
Returns:
null

Reimplemented in GenExport_Do, and VoucherSerie_Export.

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]

Reimplemented from oxAdminView.

Reimplemented in GenExport_Do, GenExport_Main, VoucherSerie_Export, VoucherSerie_Generate, and VoucherSerie_Main.

Definition at line 93 of file dynexportbase.php.

DynExportBase.$fpFile = null

Definition at line 57 of file dynexportbase.php.

DynExportBase.$iExportPerTick = 30

Reimplemented in VoucherSerie_Export.

Definition at line 65 of file dynexportbase.php.

DynExportBase.$sClassDo = ""

Reimplemented in GenExport, GenExport_Do, GenExport_Main, VoucherSerie_Export, VoucherSerie_Generate, and VoucherSerie_Main.

Definition at line 22 of file dynexportbase.php.

DynExportBase.$sClassMain = ""

Reimplemented in GenExport, GenExport_Do, and GenExport_Main.

Definition at line 29 of file dynexportbase.php.

DynExportBase.$sExportFileName = "dynexport"

Reimplemented in GenExport_Do.

Definition at line 50 of file dynexportbase.php.

DynExportBase.$sExportFileType = "txt"

Reimplemented in VoucherSerie_Export.

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:
Generated by  doxygen 1.7.1