OXID eShop CE  6.1.5
OxidEsales\EshopCommunity\Core\Output Class Reference
+ Inheritance diagram for OxidEsales\EshopCommunity\Core\Output:
+ Collaboration diagram for OxidEsales\EshopCommunity\Core\Output:

Public Member Functions

 __construct ()
 
 setIsSearchEngine ($blOn)
 
 process ($sValue, $sClassName)
 
 addVersionTags ($sOutput)
 
 processViewArray ($aViewData, $sClassName)
 
 processEmail (&$oEmail)
 
 setCharset ($sCharset)
 
 setOutputFormat ($sFormat)
 
 output ($sName, $output)
 
 flushOutput ()
 
 sendHeaders ()
 

Public Attributes

const OUTPUT_FORMAT_HTML = 'html'
 
const OUTPUT_FORMAT_JSON = 'json'
 

Protected Member Functions

 getShopMode ()
 

Protected Attributes

 $_blSearchEngine = false
 
 $_sCharset = null
 
 $_sOutputFormat = self::OUTPUT_FORMAT_HTML
 
 $_aBuffer = []
 

Detailed Description

class for output processing

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Core\Output::__construct ( )

Class constructor. Sets search engine mode according to client info

Returns
null

Member Function Documentation

◆ addVersionTags()

OxidEsales\EshopCommunity\Core\Output::addVersionTags (   $sOutput)
final

Add a version tag to a html page

Parameters
string$sOutputhtmlheader
Returns
string

◆ flushOutput()

OxidEsales\EshopCommunity\Core\Output::flushOutput ( )

flush pending output

◆ getShopMode()

OxidEsales\EshopCommunity\Core\Output::getShopMode ( )
protected

Forms Shop mode name.

Returns
string

◆ output()

OxidEsales\EshopCommunity\Core\Output::output (   $sName,
  $output 
)

output data

Parameters
string$sNameoutput name (used in json mode)
string$outputoutput text/data

◆ process()

OxidEsales\EshopCommunity\Core\Output::process (   $sValue,
  $sClassName 
)

function for front-end (normaly HTML) output processing This function is called from index.php

Parameters
string$sValuevalue
string$sClassNameclassname
Returns
string

◆ processEmail()

OxidEsales\EshopCommunity\Core\Output::processEmail ( $oEmail)

This function is called from index.php

Parameters
object$oEmailemail object

◆ processViewArray()

OxidEsales\EshopCommunity\Core\Output::processViewArray (   $aViewData,
  $sClassName 
)

Abstract function for smarty tag processing This function is called from index.php

Parameters
array$aViewDataviewarray
string$sClassNameclassname
Returns
array

◆ sendHeaders()

OxidEsales\EshopCommunity\Core\Output::sendHeaders ( )

send page headers (content type, charset)

◆ setCharset()

OxidEsales\EshopCommunity\Core\Output::setCharset (   $sCharset)

set page charset

Parameters
string$sCharsetcharset to send with headers

◆ setIsSearchEngine()

OxidEsales\EshopCommunity\Core\Output::setIsSearchEngine (   $blOn)

Search engine mode setter

Parameters
bool$blOnsearch engine mode

◆ setOutputFormat()

OxidEsales\EshopCommunity\Core\Output::setOutputFormat (   $sFormat)

set page output format

Parameters
string$sFormathtml or json

Member Data Documentation

◆ $_aBuffer

OxidEsales\EshopCommunity\Core\Output::$_aBuffer = []
protected

◆ $_blSearchEngine

OxidEsales\EshopCommunity\Core\Output::$_blSearchEngine = false
protected

◆ $_sCharset

OxidEsales\EshopCommunity\Core\Output::$_sCharset = null
protected

◆ $_sOutputFormat

OxidEsales\EshopCommunity\Core\Output::$_sOutputFormat = self::OUTPUT_FORMAT_HTML
protected

◆ OUTPUT_FORMAT_HTML

const OxidEsales\EshopCommunity\Core\Output::OUTPUT_FORMAT_HTML = 'html'

◆ OUTPUT_FORMAT_JSON

const OxidEsales\EshopCommunity\Core\Output::OUTPUT_FORMAT_JSON = 'json'

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