API Documentation
Table of Contents
Namespaces
Interfaces
- ContrexxJavascriptI18nProvider
- An interface describing an i18n provider.
Classes
- BackendTable
- BackendTable
- CompressedList
- Compressed list
- Creditcard
- Creditcard helper methods
- Env
- A global environment repository.
- Filetype
- All kind of file type stuff, including MIME types
- Html
- HTML class
- HtmlTag
- HTML Tag Class
- InitCMSException
- InitCMSException
- InitCMS
- Initialize the CMS
- LinkGeneratorException
- LinkGeneratorException
- LinkGenerator
- Handles the node-Url placeholders: [[ NODE_(<node_id>|<module>[_<cmd>])[_<lang_id>] ]]
- LinkSanitizer
- This class replaces any links from Cloudrexx < 3.0 on the fly.
- Message
- Message
- Mime
- OBSOLETE -- See {@see Filetype.class.php}
- ModuleException
- ModuleException
- Module
- Module
- Navigation
- Class Navigation This class creates the navigation tree Note: modified 27/06/2006 by Sébastien Perret => sva.perret@bluewin.ch
- PageGuardException
- PageGuardException
- PageGuard
- Handles access restriction administration on Pages.
- Paging
- Creates the paging
- Permission
- Permission
- SmtpSettings
- SMTP Settings
- Socket
- Useful methods that help you connect to other hosts using sockets
- Sorting
- Provides methods to create sorted tables
- Text
- Text
- ContentTree
- This class creates a tree structure as an indexed array object content array provider
- ContrexxJavascriptException
- ContrexxJavascriptException
- ContrexxJavascript
- This class configures the ContrexxJavascript-object (referred to as 'cx-object' in the comments)
- ContrexxJavascriptI18nException
- ContrexxJavascriptI18nException
- ContrexxJavascriptI18n
- This handles i18n for Javascript.
- JQueryUiI18nProvider
- JQueryUiI18nProvider
- DateTimeTools
- Date and time helper functions
- DBG
- DBG_Log
- DBG_LogStream
- DBG_FileLogStream
- DBG_CliLogStream
- File
- Legacy file manager
- FWUser
- Framework user
- ImageManager
- Image manager
- JSParseException
- Exception on Javascript parsing
- JS
- Javascript
- FWLanguage
- Framework language
- ModuleInterfaceException
- ModuleInterfaceException
- ModuleInterface
- An interface using which modules provide functionality to stuff outside the module itself.
- MXLookup
- MXLookup
- RSSWriter
- SQL
- Provides SQL building functions.
- FWSystem
- FWSystem This class provides system related methods.
- UserException
- UserException
- User
- User Object
- User_Profile
- User Profile
- User_Profile_Attribute
- User Profile Attribute Object
- User_Setting
- User Settings Object
- User_Setting_Mail
- User Settings Mail Object
- UserGroup
- User Group Object
- FWValidator
- Framework Validator
- CxValidate
- An abstract base for ZendValidator-Style instantiable Validators
- CxValidateString
- Validates Strings to a set of constraints
- CxValidateRegexp
- CxValidateRegexp
- CxValidateInteger
- CxValidateInteger
- CxValidateComponentName
- CxValidateComponentName
- Datatrans
- Datatrans PSP Interface
- Dummy
- Lets you choose successful, failed, and aborted payments.
- PayPal
- Interface for the PayPal payment service provider
- PayrexxProcessor
- Payrexx Payment Processor
- Saferpay
- Interface to Saferpay
- SaferpayJsonException
- Exception while using interface to Saferpay JSON API
- SaferpayJson
- Interface to Saferpay JSON API
- PostfinanceMobile
- Mobile Payment
- Yellowpay
- PostFinance online payment
Constants
- _MPDF_SYSTEM_TTFONTS = $this->cx->getCodeBaseLibraryPath() . '/mpdf/ttfonts/'
- _MPDF_SYSTEM_TTFONTS_CONFIG = $this->getDirectory() . '/Controller/clx_config.php'
- _MPDF_TTFONTPATH = $this->cx->getWebsiteDocumentRootPath() . \Cx\Core\Core\Controller\Cx::FOLDER_NAME_MEDIA . '/Pdf/ttfonts/'
- _PAYMENT_DEBUG = 0
- Debug mode
- _PAYPAL_DEBUG = 0
- Debug mode
- ADODB_OUTP = function () { }
- BACKEND_PROTECTION = 1 << 1
- CRM_EVENT_ON_ACCOUNT_UPDATED = 'crm_notify_staff_on_contact_added'
- CRM_EVENT_ON_TASK_CREATED = 'crm_task_assigned'
- CRM_EVENT_ON_USER_ACCOUNT_CREATED = 'crm_user_account_created'
- DBG_ADODB = \DBG_ADODB_SELECT | \DBG_ADODB_CHANGE
- DBG_ADODB_CHANGE = 1 << 3
- DBG_ADODB_ERROR = 1 << 4
- DBG_ADODB_SELECT = 1 << 1
- DBG_ADODB_TRACE = 1 << 2
- DBG_ALL = \DBG_PHP | \DBG_DB | \DBG_DB_TRACE | \DBG_DB_ERROR | \DBG_DB_DUMP_ON_ERROR | \DBG_LOG_FILE | \DBG_LOG_MEMORY | \DBG_LOG | \DBG_PROFILE | \DBG_DEBUG
- DBG_DB = \DBG_DB_SELECT | \DBG_DB_CHANGE
- DBG_DB_CHANGE = \DBG_ADODB_CHANGE | \DBG_DOCTRINE_CHANGE
- DBG_DB_DUMP_ON_ERROR = 1 << 10
- DBG_DB_ERROR = \DBG_ADODB_ERROR | \DBG_DOCTRINE_ERROR
- DBG_DB_SELECT = \DBG_ADODB_SELECT | \DBG_DOCTRINE_SELECT
- DBG_DB_TRACE = \DBG_ADODB_TRACE | \DBG_DOCTRINE_TRACE
- DBG_DEBUG = 1 << 14
- DBG_DOCTRINE = \DBG_DOCTRINE_SELECT | \DBG_DOCTRINE_CHANGE
- DBG_DOCTRINE_CHANGE = 1 << 7
- DBG_DOCTRINE_ERROR = 1 << 8
- DBG_DOCTRINE_SELECT = 1 << 5
- DBG_DOCTRINE_TRACE = 1 << 6
- DBG_LOG = 1 << 12
- DBG_LOG_FILE = 1 << 9
- DBG_LOG_MEMORY = 1 << 11
- DBG_NONE = 0
- Cloudrexx
- DBG_PHP = 1 << 0
- DBG_PROFILE = 1 << 13
- DBG_PROFILE_FORCE = 1 << 16
- DBG_PROFILE_OFF = 1 << 15
- DBG_PROFILE_ON = \DBG_PROFILE
- FRONTEND_LANG_ID = $this->lang
- FRONTEND_LANG_ID = $params['get']['lang']
- FRONTEND_LANG_ID = 1
- FRONTEND_LANG_ID = $langId
- FRONTEND_LANG_ID = $lang
- FRONTEND_LANG_ID = 1
- FRONTEND_PROTECTION = 1 << 0
- PCLZIP_TEMPORARY_DIR = $this->cx->getComponent('Session')->getSession()->getTempPath() . '/'
- SHOP_CATEGORY_IMAGE_PATH = \Cx\Core\Core\Controller\Cx::instanciate()->getWebsiteImagesShopPath() . '/'
- SHOP_CATEGORY_IMAGE_WEB_PATH = \Cx\Core\Core\Controller\Cx::instanciate()->getWebsiteImagesShopWebPath() . '/'
- SHOP_PSP_URI_DATATRANS = 'https://payment.datatrans.biz/upp/jsp/upStart.jsp'
- Payment gateway URIs
- SHOP_PSP_URI_DATATRANS_TEST = 'https://pilot.datatrans.biz/upp/jsp/upStart.jsp'
- SWAGGER_API_HOST = \Cx\Core\Routing\Url::fromApi('v1', array())->toString()
- VALIDATOR_REGEX_EMAIL = '[a-zäàáâöôüûñéè0-9!\#\$\%\&\'\*\+\/\=\?\^_\`\{\|\}\~-]+(?:\.[a-zäàáâöôüûñéè0-9!\#\$\%\&\'\*\+\/\=\?\^_\`\{\|\}\~-]+)*@(?:[a-zäàáâöôüûñéè0-9](?:[a-zäàáâöôüûñéè0-9-]*[a-zäàáâöôüûñéè0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?'
- Regular Expression for e-mail addresses TKaelin @ 2.0.2: wrote new regex based on http://en.wikipedia.org/wiki/E-mail_address Dave V, @ 2.1.2: re-wrote regex according to http://www.regular-expressions.info/email.html Reto Kohli @ 2.1.4: Fixed e-mail regex for PHP by adding more backslashes for special characters
- VALIDATOR_REGEX_EMAIL_JS = '^' . \VALIDATOR_REGEX_EMAIL . '$'
- Regular Expression in javascript for e-mail addresses
- VALIDATOR_REGEX_URI = \VALIDATOR_REGEX_URI_PROTO . '?((([\wäàáâöôüûñéè\d-]{1,}\.)+[a-z]{2,})|((?:(?:25[0-5]|2[0-4]\d|[01]\d\d|\d?\d)(?:(\.?\d)\.)) {4}))(?:[\w\d]+)?(\/[\w\d\-\.\?\,\'\/\\\\+\&\%\$\#\=\~:]*)?'
- Regular Expression for URIs
- VALIDATOR_REGEX_URI_JS = '^' . \VALIDATOR_REGEX_URI . '$'
- Regular Expression in javascript for URIs
- VALIDATOR_REGEX_URI_PROTO = '(?:(?:ht|f)tps?\:\/\/)'
- Regular Expression for URI protocols
Functions
- contrexx_isCoreModule() : bool
- Checks if a certain module, specified by param $moduleName, is a core module.
- contrexx_isModuleActive() : bool
- Checks if a certain module, specified by param $moduleName, is active.
- contrexx_isModuleInstalled() : bool
- Checks if a certain module, specified by param $moduleName, is installed.
- getPaging() : string
- OBSOLETE Use the {@see Paging::get()} method instead.
- init() : Cx
- Wrapper for new \Cx\Core\Core\Controller\Cx()
- contrexx_strip_tags() : string
- Wrapper for strip_tags() that complies with gpc_magic_quotes
- contrexx_addslashes() : string
- Wrapper for addslashes() that complies with gpc_magic_quotes
- contrexx_stripslashes() : string
- Wrapper for stripslashes() that complies with gpc_magic_quotes
- contrexx_stripslashes_recursive() : mixed
- Processes the argument like {@see contrexx_stripslashes()}, but also handles arrays
- preg_match_replace() : string
- Convenient match-and-replace-in-one function
- checkForSpider() : bool
- Checks whether the request comes from a known spider
- contrexx_raw2xhtml() : mixed
- Encodes raw strings or arrays thereof for use with [X]HTML
- contrexx_input2raw() : mixed
- Unescapes data from any request and returns a raw string or an array thereof.
- contrexx_input2int() : mixed
- Ensures that data from any request is limited to integer values
- contrexx_input2float() : mixed
- Ensures that data from any request is limited to float values
- contrexx_input2db() : mixed
- Unescapes data from any request and adds slashes for insertion into the database
- contrexx_input2xhtml() : mixed
- Unescapes data from any request and encodes it for use with [X]HTML
- contrexx_raw2db() : mixed
- Adds slashes to the given raw string or array thereof for insertion into the database.
- contrexx_raw2xml() : mixed
- Encodes a raw string or array thereof for use with XML
- contrexx_raw2encodedUrl() : mixed
- Encodes a raw string or array thereof for use as a href or src attribute value.
- contrexx_remove_script_tags() : mixed
- Removes script tags and their content from the given string or array thereof
- contrexx_xhtml2raw() : mixed
- Decode [X]HTML entities to raw plaintext string
- contrexx_html2plaintext() : mixed
- Extracts the plaintext out of a html code
- getCustomFonts() : void
- Load custom fonts for PDF generation
Constants
_MPDF_SYSTEM_TTFONTS
public
mixed
_MPDF_SYSTEM_TTFONTS
= $this->cx->getCodeBaseLibraryPath() . '/mpdf/ttfonts/'
_MPDF_SYSTEM_TTFONTS_CONFIG
public
mixed
_MPDF_SYSTEM_TTFONTS_CONFIG
= $this->getDirectory() . '/Controller/clx_config.php'
_MPDF_TTFONTPATH
public
mixed
_MPDF_TTFONTPATH
= $this->cx->getWebsiteDocumentRootPath() . \Cx\Core\Core\Controller\Cx::FOLDER_NAME_MEDIA . '/Pdf/ttfonts/'
_PAYMENT_DEBUG
Debug mode
public
mixed
_PAYMENT_DEBUG
= 0
_PAYPAL_DEBUG
Debug mode
public
mixed
_PAYPAL_DEBUG
= 0
Tags
ADODB_OUTP
public
mixed
ADODB_OUTP
= function () {
}
BACKEND_PROTECTION
public
mixed
BACKEND_PROTECTION
= 1 << 1
CRM_EVENT_ON_ACCOUNT_UPDATED
public
mixed
CRM_EVENT_ON_ACCOUNT_UPDATED
= 'crm_notify_staff_on_contact_added'
CRM_EVENT_ON_TASK_CREATED
public
mixed
CRM_EVENT_ON_TASK_CREATED
= 'crm_task_assigned'
CRM_EVENT_ON_USER_ACCOUNT_CREATED
public
mixed
CRM_EVENT_ON_USER_ACCOUNT_CREATED
= 'crm_user_account_created'
DBG_ADODB
public
mixed
DBG_ADODB
= \DBG_ADODB_SELECT | \DBG_ADODB_CHANGE
DBG_ADODB_CHANGE
public
mixed
DBG_ADODB_CHANGE
= 1 << 3
DBG_ADODB_ERROR
public
mixed
DBG_ADODB_ERROR
= 1 << 4
DBG_ADODB_SELECT
public
mixed
DBG_ADODB_SELECT
= 1 << 1
DBG_ADODB_TRACE
public
mixed
DBG_ADODB_TRACE
= 1 << 2
DBG_ALL
public
mixed
DBG_ALL
= \DBG_PHP | \DBG_DB | \DBG_DB_TRACE | \DBG_DB_ERROR | \DBG_DB_DUMP_ON_ERROR | \DBG_LOG_FILE | \DBG_LOG_MEMORY | \DBG_LOG | \DBG_PROFILE | \DBG_DEBUG
DBG_DB
public
mixed
DBG_DB
= \DBG_DB_SELECT | \DBG_DB_CHANGE
DBG_DB_CHANGE
public
mixed
DBG_DB_CHANGE
= \DBG_ADODB_CHANGE | \DBG_DOCTRINE_CHANGE
DBG_DB_DUMP_ON_ERROR
public
mixed
DBG_DB_DUMP_ON_ERROR
= 1 << 10
DBG_DB_ERROR
public
mixed
DBG_DB_ERROR
= \DBG_ADODB_ERROR | \DBG_DOCTRINE_ERROR
DBG_DB_SELECT
public
mixed
DBG_DB_SELECT
= \DBG_ADODB_SELECT | \DBG_DOCTRINE_SELECT
DBG_DB_TRACE
public
mixed
DBG_DB_TRACE
= \DBG_ADODB_TRACE | \DBG_DOCTRINE_TRACE
DBG_DEBUG
public
mixed
DBG_DEBUG
= 1 << 14
DBG_DOCTRINE
public
mixed
DBG_DOCTRINE
= \DBG_DOCTRINE_SELECT | \DBG_DOCTRINE_CHANGE
DBG_DOCTRINE_CHANGE
public
mixed
DBG_DOCTRINE_CHANGE
= 1 << 7
DBG_DOCTRINE_ERROR
public
mixed
DBG_DOCTRINE_ERROR
= 1 << 8
DBG_DOCTRINE_SELECT
public
mixed
DBG_DOCTRINE_SELECT
= 1 << 5
DBG_DOCTRINE_TRACE
public
mixed
DBG_DOCTRINE_TRACE
= 1 << 6
DBG_LOG
public
mixed
DBG_LOG
= 1 << 12
DBG_LOG_FILE
public
mixed
DBG_LOG_FILE
= 1 << 9
DBG_LOG_MEMORY
public
mixed
DBG_LOG_MEMORY
= 1 << 11
DBG_NONE
Cloudrexx
public
mixed
DBG_NONE
= 0
Tags
DBG_PHP
public
mixed
DBG_PHP
= 1 << 0
DBG_PROFILE
public
mixed
DBG_PROFILE
= 1 << 13
DBG_PROFILE_FORCE
public
mixed
DBG_PROFILE_FORCE
= 1 << 16
DBG_PROFILE_OFF
public
mixed
DBG_PROFILE_OFF
= 1 << 15
DBG_PROFILE_ON
public
mixed
DBG_PROFILE_ON
= \DBG_PROFILE
FRONTEND_LANG_ID
public
mixed
FRONTEND_LANG_ID
= $this->lang
FRONTEND_LANG_ID
public
mixed
FRONTEND_LANG_ID
= $params['get']['lang']
FRONTEND_LANG_ID
public
mixed
FRONTEND_LANG_ID
= 1
FRONTEND_LANG_ID
public
mixed
FRONTEND_LANG_ID
= $langId
FRONTEND_LANG_ID
public
mixed
FRONTEND_LANG_ID
= $lang
FRONTEND_LANG_ID
public
mixed
FRONTEND_LANG_ID
= 1
FRONTEND_PROTECTION
public
mixed
FRONTEND_PROTECTION
= 1 << 0
PCLZIP_TEMPORARY_DIR
public
mixed
PCLZIP_TEMPORARY_DIR
= $this->cx->getComponent('Session')->getSession()->getTempPath() . '/'
SHOP_CATEGORY_IMAGE_PATH
public
mixed
SHOP_CATEGORY_IMAGE_PATH
= \Cx\Core\Core\Controller\Cx::instanciate()->getWebsiteImagesShopPath() . '/'
SHOP_CATEGORY_IMAGE_WEB_PATH
public
mixed
SHOP_CATEGORY_IMAGE_WEB_PATH
= \Cx\Core\Core\Controller\Cx::instanciate()->getWebsiteImagesShopWebPath() . '/'
SHOP_PSP_URI_DATATRANS
Payment gateway URIs
public
mixed
SHOP_PSP_URI_DATATRANS
= 'https://payment.datatrans.biz/upp/jsp/upStart.jsp'
Live Service URIs: UTF-8 encoding: https://payment.datatrans.biz/upp/jsp/upStart.jsp ISO encoding: https://payment.datatrans.biz/upp/jsp/upStartIso.jsp
Service URIs for testing: UTF-8 encoding: https://pilot.datatrans.biz/upp/jsp/upStart.jsp ISO encoding: https://pilot.datatrans.biz/upp/jsp/upStartIso.jsp
Tags
SHOP_PSP_URI_DATATRANS_TEST
public
mixed
SHOP_PSP_URI_DATATRANS_TEST
= 'https://pilot.datatrans.biz/upp/jsp/upStart.jsp'
SWAGGER_API_HOST
public
mixed
SWAGGER_API_HOST
= \Cx\Core\Routing\Url::fromApi('v1', array())->toString()
VALIDATOR_REGEX_EMAIL
Regular Expression for e-mail addresses TKaelin @ 2.0.2: wrote new regex based on http://en.wikipedia.org/wiki/E-mail_address Dave V, @ 2.1.2: re-wrote regex according to http://www.regular-expressions.info/email.html Reto Kohli @ 2.1.4: Fixed e-mail regex for PHP by adding more backslashes for special characters
public
mixed
VALIDATOR_REGEX_EMAIL
= '[a-zäàáâöôüûñéè0-9!\#\$\%\&\'\*\+\/\=\?\^_\`\{\|\}\~-]+(?:\.[a-zäàáâöôüûñéè0-9!\#\$\%\&\'\*\+\/\=\?\^_\`\{\|\}\~-]+)*@(?:[a-zäàáâöôüûñéè0-9](?:[a-zäàáâöôüûñéè0-9-]*[a-zäàáâöôüûñéè0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?'
Tags
VALIDATOR_REGEX_EMAIL_JS
Regular Expression in javascript for e-mail addresses
public
mixed
VALIDATOR_REGEX_EMAIL_JS
= '^' . \VALIDATOR_REGEX_EMAIL . '$'
Tags
VALIDATOR_REGEX_URI
Regular Expression for URIs
public
mixed
VALIDATOR_REGEX_URI
= \VALIDATOR_REGEX_URI_PROTO . '?((([\wäàáâöôüûñéè\d-]{1,}\.)+[a-z]{2,})|((?:(?:25[0-5]|2[0-4]\d|[01]\d\d|\d?\d)(?:(\.?\d)\.)) {4}))(?:[\w\d]+)?(\/[\w\d\-\.\?\,\'\/\\\\+\&\%\$\#\=\~:]*)?'
Tags
VALIDATOR_REGEX_URI_JS
Regular Expression in javascript for URIs
public
mixed
VALIDATOR_REGEX_URI_JS
= '^' . \VALIDATOR_REGEX_URI . '$'
Tags
VALIDATOR_REGEX_URI_PROTO
Regular Expression for URI protocols
public
mixed
VALIDATOR_REGEX_URI_PROTO
= '(?:(?:ht|f)tps?\:\/\/)'
Known protocols include HTTP, HTTPS, FTP, and FTPS.
Tags
Functions
contrexx_isCoreModule()
Checks if a certain module, specified by param $moduleName, is a core module.
contrexx_isCoreModule(string $moduleName) : bool
Parameters
- $moduleName : string
Return values
boolcontrexx_isModuleActive()
Checks if a certain module, specified by param $moduleName, is active.
contrexx_isModuleActive(string $moduleName) : bool
Parameters
- $moduleName : string
Return values
boolcontrexx_isModuleInstalled()
Checks if a certain module, specified by param $moduleName, is installed.
contrexx_isModuleInstalled(string $moduleName) : bool
Parameters
- $moduleName : string
Return values
boolgetPaging()
OBSOLETE Use the {@see Paging::get()} method instead.
getPaging(int $numof_rows, int $pos, string $uri_parameter, string $paging_text[, bool $showeverytime = false ][, int $results_per_page = null ]) : string
Returs a string representing the complete paging HTML code for the current page. Note that the old $pos parameter is obsolete as well, see getPosition().
Parameters
- $numof_rows : int
-
The number of rows available
- $pos : int
-
The offset from the first row
- $uri_parameter : string
- $paging_text : string
- $showeverytime : bool = false
- $results_per_page : int = null
Tags
Return values
string —Result
init()
Wrapper for new \Cx\Core\Core\Controller\Cx()
init([string $mode = null ][, mixed $checkInstallationStatus = true ]) : Cx
This is necessary, because we cannot use namespaces in index.php in order to catch errors with PHP versions prior to 5.3
Parameters
- $mode : string = null
-
(optional) One of 'frontend', 'backend', 'cli', 'minimal'
- $checkInstallationStatus : mixed = true
Return values
Cx —Instance of Cloudrexx
contrexx_strip_tags()
Wrapper for strip_tags() that complies with gpc_magic_quotes
contrexx_strip_tags(string $string) : string
Parameters
- $string : string
Return values
string —$string (cleaned)
contrexx_addslashes()
Wrapper for addslashes() that complies with gpc_magic_quotes
contrexx_addslashes(string $string) : string
Parameters
- $string : string
Return values
string —cleaned
contrexx_stripslashes()
Wrapper for stripslashes() that complies with gpc_magic_quotes
contrexx_stripslashes(string $string) : string
Parameters
- $string : string
Return values
stringcontrexx_stripslashes_recursive()
Processes the argument like {@see contrexx_stripslashes()}, but also handles arrays
contrexx_stripslashes_recursive(mixed $param) : mixed
Recurses down into array parameters and applies contrexx_stripslashes() to any scalar value encountered.
Parameters
- $param : mixed
-
A scalar or array value
Return values
mixed —The parameter with magic slashes removed recursively, if any.
preg_match_replace()
Convenient match-and-replace-in-one function
preg_match_replace(string $pattern, string $replace, string $subject[, array<string|int, mixed> &$subpatterns = null ][, int $limit = -1 ][, int &$count = null ]) : string
Parameters are those of preg_match() and preg_replace() combined.
Parameters
- $pattern : string
-
The regex pattern to match
- $replace : string
-
The replacement string for matches
- $subject : string
-
The string to be matched/replaced on
- $subpatterns : array<string|int, mixed> = null
-
The optional array for the matches found
- $limit : int = -1
-
The optional limit for replacements
- $count : int = null
-
The optional counter for the replacements done
Return values
string —The resulting string
checkForSpider()
Checks whether the request comes from a known spider
checkForSpider() : bool
Return values
boolcontrexx_raw2xhtml()
Encodes raw strings or arrays thereof for use with [X]HTML
contrexx_raw2xhtml(mixed $raw) : mixed
Apply to raw strings and those taken from the database, or arrays of these, before writing the contents to the HTML response stream. Note that arrays may be nested, and all scalar (leaf) elements are treated the same way. Array keys are preserved.
Parameters
- $raw : mixed
-
The raw string or array
Tags
Return values
mixed —The HTML encoded string or array
contrexx_input2raw()
Unescapes data from any request and returns a raw string or an array thereof.
contrexx_input2raw(mixed $input) : mixed
Apply to any string or array taken from a get or post request, or from a cookie.
Parameters
- $input : mixed
-
The input string or array
Return values
mixed —The raw string or array
contrexx_input2int()
Ensures that data from any request is limited to integer values
contrexx_input2int(mixed $input) : mixed
Apply to any string or array taken from a get or post request, or from a cookie.
Parameters
- $input : mixed
-
The input string or array
Tags
Return values
mixed —The integer or array thereof
contrexx_input2float()
Ensures that data from any request is limited to float values
contrexx_input2float(mixed $input) : mixed
Apply to any string or array taken from a get or post request, or from a cookie.
Parameters
- $input : mixed
-
The input string or array
Tags
Return values
mixed —The float or array thereof
contrexx_input2db()
Unescapes data from any request and adds slashes for insertion into the database
contrexx_input2db(mixed $input) : mixed
Apply to any string or array taken from a get or post request, or from a cookie before inserting into the database.
Parameters
- $input : mixed
-
The input string or array
Return values
mixed —The unescaped slashed string or array
contrexx_input2xhtml()
Unescapes data from any request and encodes it for use with [X]HTML
contrexx_input2xhtml(mixed $input) : mixed
Apply to any string or array taken from a get or post request, or from a cookie before writing it to the HTML response stream.
Parameters
- $input : mixed
-
The input string or array
Return values
mixed —The unescaped HTML encoded string or array
contrexx_raw2db()
Adds slashes to the given raw string or array thereof for insertion into the database.
contrexx_raw2db(mixed $raw) : mixed
Parameters
- $raw : mixed
-
The raw string or array
Return values
mixed —The slashed string or array
contrexx_raw2xml()
Encodes a raw string or array thereof for use with XML
contrexx_raw2xml(mixed $raw) : mixed
Apply to raw strings and those taken from the database or arrays thereof before writing to the XML response stream.
Parameters
- $raw : mixed
-
The raw string or array
Return values
mixed —The XML encoded string or array
contrexx_raw2encodedUrl()
Encodes a raw string or array thereof for use as a href or src attribute value.
contrexx_raw2encodedUrl(mixed $source[, bool $encodeDash = false ]) : mixed
Apply to any raw string or array that is to be used as a link or image address in any tag attribute, such as a.href or img.src.
Parameters
- $source : mixed
-
The raw string or array
- $encodeDash : bool = false
-
Encode dashes ('-') if true. Defaults to false
Return values
mixed —The URL encoded string or array
contrexx_remove_script_tags()
Removes script tags and their content from the given string or array thereof
contrexx_remove_script_tags(mixed $raw) : mixed
Parameters
- $raw : mixed
-
The original string or array
Tags
Return values
mixed —The string or array with script tags removed
contrexx_xhtml2raw()
Decode [X]HTML entities to raw plaintext string
contrexx_xhtml2raw(mixed $xhtml) : mixed
Note that arrays may be nested, and all scalar (leaf) elements are treated the same way. Array keys are preserved.
Parameters
- $xhtml : mixed
-
The raw string or array
Tags
Return values
mixed —The raw decoded string or array
contrexx_html2plaintext()
Extracts the plaintext out of a html code
contrexx_html2plaintext(mixed $html) : mixed
Parameters
- $html : mixed
-
The html code as string or an array containing multiple html code strings
Return values
mixed —The plaintext of the provided html code
getCustomFonts()
Load custom fonts for PDF generation
getCustomFonts(mPdf $mPdf) : void
Parameters
- $mPdf : mPdf
-
mPdf