List of all members.
Public Member Functions |
| getSmarty ($blReload=false) |
| getTemplateOutput ($sTemplate, $oObject) |
| passAllErrorsToView (&$aView, $aErrors) |
| addErrorToDisplay ($oEr, $blFull=false, $blCustomDestination=false, $sCustomDestination="") |
| parseThroughSmarty ($sDesc, $sOxid=null, $oActView=null, $blRecompile=false) |
| setTemplateDir ($sTplDir) |
| getTemplateDirs () |
| getTemplateCompileId () |
| _smartyDefaultTemplateHandler ($sResourceType, $sResourceName, &$sResourceContent, &$sResourceTimestamp, $oSmarty) |
| getTemplateBlocks ($sFile) |
Static Public Member Functions |
static | getInstance () |
Protected Member Functions |
| _fillCommonSmartyProperties ($oSmarty) |
| _smartyCompileCheck ($oSmarty) |
| _getTemplateBlock ($sModule, $sFile) |
| _getActiveModuleInfo () |
Protected Attributes |
| $_aTemplateDir = array() |
| $_blIsTplBlocks = null |
| $_aActiveModuleInfo = null |
Static Protected Attributes |
static | $_oSmarty = null |
Static Private Attributes |
static | $_instance = null |
Detailed Description
View utility class
Definition at line 6 of file oxutilsview.php.
Member Function Documentation
oxUtilsView._fillCommonSmartyProperties |
( |
$ |
oSmarty |
) |
[protected] |
sets properties of smarty object
- Parameters:
-
| object | $oSmarty template processor object (smarty) |
- Returns:
- null
Definition at line 316 of file oxutilsview.php.
oxUtilsView._getActiveModuleInfo |
( |
|
) |
[protected] |
oxUtilsView._getTemplateBlock |
( |
$ |
sModule, |
|
|
$ |
sFile | |
|
) |
| | [protected] |
retrieve module block contents
- Parameters:
-
| string | $sModule module name |
| string | $sFile module block file name without .tpl ending |
- See also:
- getTemplateBlocks
- Exceptions:
-
- Returns:
- string
Definition at line 415 of file oxutilsview.php.
oxUtilsView._smartyCompileCheck |
( |
$ |
oSmarty |
) |
[protected] |
sets compile check property to smarty object
- Parameters:
-
| object | $oSmarty template processor object (smarty) |
- Returns:
- null
Definition at line 374 of file oxutilsview.php.
oxUtilsView._smartyDefaultTemplateHandler |
( |
$ |
sResourceType, |
|
|
$ |
sResourceName, |
|
|
&$ |
sResourceContent, |
|
|
&$ |
sResourceTimestamp, |
|
|
$ |
oSmarty | |
|
) |
| | |
is called when a template cannot be obtained from its resource.
- Parameters:
-
| string | $sResourceType template type |
| string | $sResourceName template file name |
| string | &$sResourceContent template file content |
| int | &$sResourceTimestamp template file timestamp |
| object | $oSmarty template processor object (smarty) |
- Returns:
- bool
Definition at line 392 of file oxutilsview.php.
oxUtilsView.addErrorToDisplay |
( |
$ |
oEr, |
|
|
$ |
blFull = false , |
|
|
$ |
blCustomDestination = false , |
|
|
$ |
sCustomDestination = "" | |
|
) |
| | |
adds a exception to the array of displayed exceptions for the view by default is displayed in the inc_header, but with the custom destination set to true the exception won't be displayed by default but can be displayed where ever wanted in the tpl
- Parameters:
-
| exception | $oEr a exception object or just a language local (string) which will be converted into a oxExceptionToDisplay object |
| bool | $blFull if true the whole object is add to display (default false) |
| bool | $blCustomDestination true if the exception shouldn't be displayed at the default position (default false) |
| string | $sCustomDestination defines a name of the view variable containing the messages, overrides Parameter 'CustomError' ("default") |
- Returns:
- null
Definition at line 148 of file oxutilsview.php.
static oxUtilsView.getInstance |
( |
|
) |
[static] |
oxUtilsView.getSmarty |
( |
$ |
blReload = false |
) |
|
returns existing or creates smarty object Returns smarty object. If object not yet initiated - creates it. Sets such default parameters, like cache lifetime, cache/templates directory, etc.
- Parameters:
-
| bool | $blReload set true to force smarty reload |
- Returns:
- smarty
Definition at line 76 of file oxutilsview.php.
oxUtilsView.getTemplateBlocks |
( |
$ |
sFile |
) |
|
template blocks getter: retrieve sorted blocks for overriding in templates
- Parameters:
-
| string | $sFile filename of rendered template |
- See also:
- smarty_prefilter_oxblock
- Returns:
- array
Definition at line 440 of file oxutilsview.php.
oxUtilsView.getTemplateCompileId |
( |
|
) |
|
oxUtilsView.getTemplateDirs |
( |
|
) |
|
Initializes and returns templates directory info array
- Returns:
- array
Definition at line 281 of file oxutilsview.php.
oxUtilsView.getTemplateOutput |
( |
$ |
sTemplate, |
|
|
$ |
oObject | |
|
) |
| | |
Returns renderd template output. According to debug configuration outputs debug information.
- Parameters:
-
| string | $sTemplate template file name |
| object | $oObject object, witch template we wish to output |
- Returns:
- string
Definition at line 96 of file oxutilsview.php.
oxUtilsView.parseThroughSmarty |
( |
$ |
sDesc, |
|
|
$ |
sOxid = null , |
|
|
$ |
oActView = null , |
|
|
$ |
blRecompile = false | |
|
) |
| | |
Runs long description through smarty. If you pass array of data to process, array will be returned, if you pass string - string will be passed as result
- Parameters:
-
| mixed | $sDesc description or array of descriptions ( array( [] => array( _ident_, _value_to_process_ ) ) ) |
| string | $sOxid current object id |
| oxview | $oActView view data to use its view data (optional) |
| bool | $blRecompile force to recompile if found in cache |
- Returns:
- mixed
Definition at line 212 of file oxutilsview.php.
oxUtilsView.passAllErrorsToView |
( |
&$ |
aView, |
|
|
$ |
aErrors | |
|
) |
| | |
adds the given errors to the view array
- Parameters:
-
| array | &$aView view data array |
| array | $aErrors array of errors to pass to view |
- Returns:
- null
Definition at line 125 of file oxutilsview.php.
oxUtilsView.setTemplateDir |
( |
$ |
sTplDir |
) |
|
Templates directory setter
- Parameters:
-
| string | $sTplDir templates path |
- Returns:
- null
Definition at line 269 of file oxutilsview.php.
Member Data Documentation
oxUtilsView.$_aActiveModuleInfo = null [protected] |
oxUtilsView.$_aTemplateDir = array() [protected] |
oxUtilsView.$_blIsTplBlocks = null [protected] |
oxUtilsView.$_instance = null [static, private] |
oxUtilsView.$_oSmarty = null [static, protected] |
The documentation for this class was generated from the following file: