DynExportBase Class Reference

Inheritance diagram for DynExportBase:
[legend]
Collaboration diagram for DynExportBase:
[legend]

List of all members.


Detailed Description

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

dyn

Definition at line 17 of file dynexportbase.php.


Public Member Functions

 __construct ()
 render ()
 createMainExportView ()
 start ()
 stop ($iError=0)
 nextTick ($iCnt)
 write ($sLine)
 run ()
 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

 $sClass_do = ""
 $sClass_main = ""
 $sExportPath = "export/"
 $sExportFileType = "txt"
 $sExportFileName = "dynexport"
 $fpFile = null
 $iExportPerTick = 30

Protected Member Functions

 _unHTMLEntities ($sInput)
 _getHeapTableName ()

Protected Attributes

 $_sFilePath = null
 $_aExportResultset = array()
 $_sThisTemplate = "dynexportbase.tpl"

Private Member Functions

 _generateTableCharSet ($sMysqlVersion)
 _createHeapTable ($sHeapTable, $sTableCharset)
 _getCatAdd ($aChosenCat)
 _insertArticles ($sHeapTable, $sCatAdd)
 _removeParentArticles ($sHeapTable)
 _setSessionParams ()
 _loadRootCats ()
 _findDeepestCatPath ($oArticle)
 _initArticle ($sHeapTable, $iCnt)
 _setCampaignDetailLink ($oArticle)

Constructor & Destructor Documentation

DynExportBase.__construct (  ) 

Returns:
null

Reimplemented from oxAdminView.

Definition at line 40 of file dynexportbase.php.


Member Function Documentation

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.

Definition at line 55 of file dynexportbase.php.

DynExportBase.createMainExportView (  ) 

Prepares and fill all data which all the dyn exports needs

Returns:
null

Definition at line 76 of file dynexportbase.php.

DynExportBase.start (  ) 

Prepares Export

Returns:
null

Definition at line 108 of file dynexportbase.php.

DynExportBase.stop ( iError = 0  ) 

Stops Export

Parameters:
integer $iError
Returns:
null

Definition at line 134 of file dynexportbase.php.

DynExportBase.nextTick ( iCnt  ) 

virtual function must be overloaded

Parameters:
integer $iCnt counter
Returns:
bool

Reimplemented in GenExport_Do.

Definition at line 152 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.

Definition at line 164 of file dynexportbase.php.

DynExportBase.run (  ) 

Does Export

Returns:
null

Definition at line 177 of file dynexportbase.php.

DynExportBase.removeSID ( sInput  ) 

Removes Session ID from $sInput

Parameters:
string $sInput
Returns:
null

Definition at line 216 of file dynexportbase.php.

DynExportBase.shrink ( sInput,
iMaxSize,
blRemoveNewline = true 
)

Shortens a string to $iMaxSize adding "..."

Parameters:
string $sInput
integer $iMaxSize
bool $blRemoveNewline
Returns:
string

Definition at line 240 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 268 of file dynexportbase.php.

DynExportBase.getDefaultCategoryString ( oArticle  ) 

Loads article default category

Parameters:
object $oArticle Article object
Returns:
record set

Definition at line 311 of file dynexportbase.php.

DynExportBase.prepareCSV ( sInput  ) 

Converts field for CSV

Parameters:
string $sInput
Returns:
string

Definition at line 335 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 352 of file dynexportbase.php.

DynExportBase.getDeepestCategoryPath ( &$  oArticle  ) 

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

Parameters:
object &$oArticle article object
Returns:
string

Definition at line 370 of file dynexportbase.php.

DynExportBase.prepareExport (  ) 

create export resultset

Returns:
int

Definition at line 384 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 434 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 474 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 493 of file dynexportbase.php.

DynExportBase._getHeapTableName (  )  [protected]

Create valid Heap table name

Returns:
string

Definition at line 506 of file dynexportbase.php.

DynExportBase._generateTableCharSet ( sMysqlVersion  )  [private]

generates table charset

Parameters:
string $sMysqlVersion MySql version
Returns:
string

Definition at line 523 of file dynexportbase.php.

DynExportBase._createHeapTable ( sHeapTable,
sTableCharset 
) [private]

creates heaptable

Parameters:
string $sHeapTable table name
string $sTableCharset table charset
Returns:
bool

Definition at line 553 of file dynexportbase.php.

DynExportBase._getCatAdd ( aChosenCat  )  [private]

creates additional cat string

Parameters:
array $aChosenCat
Returns:
string

Definition at line 576 of file dynexportbase.php.

DynExportBase._insertArticles ( sHeapTable,
sCatAdd 
) [private]

inserts articles into heaptable

Parameters:
string $sHeapTable
string $sCatAdd
Returns:
bool

Definition at line 603 of file dynexportbase.php.

DynExportBase._removeParentArticles ( sHeapTable  )  [private]

removes parent articles so that we only have variants itself

Parameters:
string $sHeapTable table name
Returns:
null

Definition at line 662 of file dynexportbase.php.

DynExportBase._setSessionParams (  )  [private]

stores some info in session

Returns:
null

Definition at line 695 of file dynexportbase.php.

DynExportBase._loadRootCats (  )  [private]

Load all root cat's == all trees

Returns:
null

Definition at line 735 of file dynexportbase.php.

DynExportBase._findDeepestCatPath ( oArticle  )  [private]

finds deepest category path

Parameters:
object $oArticle article object
Returns:
string

Definition at line 778 of file dynexportbase.php.

DynExportBase._initArticle ( sHeapTable,
iCnt 
) [private]

initialize article

Parameters:
string $sHeapTable
int $iCnt
Returns:
object

Definition at line 816 of file dynexportbase.php.

DynExportBase._setCampaignDetailLink ( oArticle  )  [private]

sets detail link for campaigns

Parameters:
object $oArticle article object
Returns:
object

Definition at line 860 of file dynexportbase.php.

DynExportBase.getViewId (  ) 

Current view ID getter helps to identify navigation position

Returns:
string

Reimplemented from oxAdminView.

Definition at line 881 of file dynexportbase.php.


Member Data Documentation

DynExportBase.$sClass_do = ""

Reimplemented in GenExport, GenExport_Do, and GenExport_Main.

Definition at line 19 of file dynexportbase.php.

DynExportBase.$sClass_main = ""

Reimplemented in GenExport, GenExport_Do, and GenExport_Main.

Definition at line 20 of file dynexportbase.php.

DynExportBase.$sExportPath = "export/"

Definition at line 23 of file dynexportbase.php.

DynExportBase.$sExportFileType = "txt"

Definition at line 24 of file dynexportbase.php.

DynExportBase.$sExportFileName = "dynexport"

Reimplemented in GenExport_Do.

Definition at line 25 of file dynexportbase.php.

DynExportBase.$fpFile = null

Definition at line 26 of file dynexportbase.php.

DynExportBase.$iExportPerTick = 30

Definition at line 27 of file dynexportbase.php.

DynExportBase.$_sFilePath = null [protected]

Definition at line 30 of file dynexportbase.php.

DynExportBase.$_aExportResultset = array() [protected]

Definition at line 31 of file dynexportbase.php.

DynExportBase.$_sThisTemplate = "dynexportbase.tpl" [protected]

Reimplemented from oxAdminView.

Reimplemented in GenExport_Do, and GenExport_Main.

Definition at line 33 of file dynexportbase.php.


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

Generated on Fri Dec 19 14:20:46 2008 for OXID eShop CE by  doxygen 1.5.5