HTML\Converters
Templating
Global Functions
Website
\Components\Website\Designs \Components\Website\Media \Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts \Components\Website\Posts\Categories
Customers
\Components\Customers\Contacts \Components\Customers\Contacts\Relationships \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups
Marketing
\Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Categories \Components\Marketing\Events\Locations \Components\Marketing\SMSMarketing
Commerce
\Components\Commerce\Carts \Components\Commerce\Carts\Current \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\Products\Inventory \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations
Settings
\Components\Settings\Administrators \Components\Settings\CustomFields \Components\Settings\Domains
Other Apps
\Components\Website\Comments \Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards
Framework
\Framework\Caching \Framework\Data\Util \Framework\DOM\CurrentContext \Framework\HTML\Converters
DESCRIPTION
METHODS
convertHTMLToText()
convertToDocX()
convertToPDF()
\Framework\HTTP\Cookies \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages

Converters

Convert strings of HTML into Text or PDF

Methods

Invoke via \Framework\HTML\Converters::method()
Click a method name to copy it.
- ` string convertHTMLToText($strHTML, $bIncludeLinks) `
Converts HTML to Text
Parameters:
- $strHTML
mixed
- $bIncludeLinks
mixed
Return
string
- ` string convertToDocX($strHTML, $arrParameters) `
Converts a HTML string to Word document (DOCX)
Parameters:
- $strHTML
mixed
- $arrParameters
mixed
Return
Binary content of the Word document
- ` string convertToPDF($strHTML, $arrParameters) `
Converts a HTML string to PDF

The available options ($arrParameteres) are:
  • (string) orientation - 'portrait' or 'landscape' (default)[/il]
  • (string) size - 'Letter', 'Legal', 'Tabloid', 'Ledger', 'A0', 'A1', 'A2', 'A3', 'A4' (default), 'A5', or 'A6'. Case sensitive
  • (Array) format - example: ['4x4', 'in'] The first value are the dimensions while the second value is the unit of those dimensions. In this case, the size will be set as 4 (width) by 4 (height) inches. The valid units are 'mm', 'cm', 'px', or 'in'.
    Case sensitive.
  • (string) format - example: '4x11' Sets the dimension of the paper as 4 (width) by 11 (height) inches

If 'size' option is set, 'format' will be ignored. Any invalid value from size or format will default the PDF size to "A4"
Parameters:
- $strHTML
mixed
- $arrParameters
mixed
Return
string