class.HTMLTemplateCore.md

Class HTMLTemplateCore

• Class name: HTMLTemplateCore
• This is an abstract class
• Source: classes/pdf/HTMLTemplate.php line 30

Contents

Properties

• $available_in_your_account
• $date
• $shop
• $smarty
• $title

Methods

• assignCommonHeaderData
• assignHookData
• getBulkFilename
• getContent
• getFilename
• getFooter
• getHeader
• getLogo
• getShopAddress
• getTemplate
• l
• setShopId

Properties

$available_in_your_account

public mixed $available_in_your_account = true

• Visibility: public
• Source: classes/pdf/HTMLTemplate.php line 34.

$date

public mixed $date

• Visibility: public
• Source: classes/pdf/HTMLTemplate.php line 33.

$shop

public \Shop $shop

• Visibility: public
• Source: classes/pdf/HTMLTemplate.php line 40.

$smarty

public \Smarty $smarty

• Visibility: public
• Source: classes/pdf/HTMLTemplate.php line 37.

$title

public mixed $title

• Visibility: public
• Source: classes/pdf/HTMLTemplate.php line 32.

Methods

assignCommonHeaderData

mixed HTMLTemplateCore::assignCommonHeaderData()

Assign common header data to smarty variables

• Visibility: public
• Source: classes/pdf/HTMLTemplate.php line 115

assignHookData

mixed HTMLTemplateCore::assignHookData(\ObjectModel $object)

Assign hook data

• Visibility: public
• Source: classes/pdf/HTMLTemplate.php line 155

Arguments

• $object ObjectModel - generally the object used in the constructor

getBulkFilename

string HTMLTemplateCore::getBulkFilename()

Returns the template filename when using bulk rendering

• Visibility: public
• This method is abstract.
• Source: classes/pdf/HTMLTemplate.php line 185

getContent

string HTMLTemplateCore::getContent()

Returns the template's HTML content

• Visibility: public
• This method is abstract.
• Source: classes/pdf/HTMLTemplate.php line 170

getFilename

string HTMLTemplateCore::getFilename()

Returns the template filename

• Visibility: public
• This method is abstract.
• Source: classes/pdf/HTMLTemplate.php line 178

getFooter

string HTMLTemplateCore::getFooter()

Returns the template's HTML footer

• Visibility: public
• Source: classes/pdf/HTMLTemplate.php line 59

getHeader

string HTMLTemplateCore::getHeader()

Returns the template's HTML header

• Visibility: public
• Source: classes/pdf/HTMLTemplate.php line 47

getLogo

mixed HTMLTemplateCore::getLogo()

Returns the invoice logo

• Visibility: protected
• Source: classes/pdf/HTMLTemplate.php line 97

getShopAddress

string HTMLTemplateCore::getShopAddress()

Returns the shop address

• Visibility: protected
• Source: classes/pdf/HTMLTemplate.php line 82

getTemplate

string HTMLTemplateCore::getTemplate($template_name)

If the template is not present in the theme directory, it will return the default template in PS_PDF_DIR directory

• Visibility: protected
• Source: classes/pdf/HTMLTemplate.php line 195

Arguments

• $template_name mixed

l

string HTMLTemplateCore::l(string $string)

Translation method

• Visibility: protected
• This method is static.
• Source: classes/pdf/HTMLTemplate.php line 217

Arguments

• $string string

setShopId

mixed HTMLTemplateCore::setShopId()

• Visibility: protected
• Source: classes/pdf/HTMLTemplate.php line 222