• Home
• Contao
• System

PHP Class Contao\System

The class provides miscellaneous methods that are used all throughout the application. It is the base class of the Contao library which provides the central "import" method to load other library classes. Usage: class MyClass extends \System { public function __construct() { $this->import('Database'); } } Show file Open project: contao/core-bundle Class Usage Examples

Protected Properties

Property	Type	Description
$arrCache	array	Cache
$arrImageSizes	array	Available image sizes
$arrLanguageFiles	array	Loaded language files
$arrLanguages	array	Available languages
$arrObjects	array	Default libraries
$arrStaticObjects	array	Static objects
$objContainer	Symfony\Component\DependencyInjection\ContainerInterface	Container

Public Methods

Method	Description
__get ( string $strKey ) : mixed | null	Get an object property
addToUrl ( string $strRequest ) : string	Add a request string to the current URL
anonymizeIp ( string $strIp ) : string	Anonymize an IP address by overriding the last chunk
convertXlfToPhp ( string $strName, string $strLanguage, boolean $blnLoad = false ) : string	Convert an .xlf file into a PHP language file
disableModule ( ) : boolean	Disable a back end module
enableModule ( ) : boolean	Enable a back end module
getContainer ( ) : Symfony\Component\DependencyInjection\ContainerInterface	Return the container object
getCountries ( ) : array	Return the countries as array
getFormattedNumber ( mixed $varNumber, integer $intDecimals = 2 ) : mixed	Format a number
getImageSizes ( ) : array	Return all image sizes as array
getIndexFreeRequest ( boolean $blnAmpersand = true ) : string	Return the request string without the script name
getLanguages ( boolean $blnInstalledOnly = false ) : array	Return the available languages as array
getModelClassFromTable ( string $strTable ) : string	Compile a Model class name from a table name (e.g. tl_form_field becomes FormFieldModel)
getReadableSize ( integer $intSize, integer $intDecimals = 1 ) : string	Convert a byte value into a human readable format
getReferer ( boolean $blnEncodeAmpersands = false, string $strTable = null ) : string	Return the referer URL and optionally encode ampersands
getSessionHash ( string $strCookie ) : string	Return the session hash
getTimeZones ( ) : array	Return the timezones as array
importStatic ( string $strClass, string $strKey = null, boolean $blnForce = false ) : object	Import a library in non-object context
isInstalledLanguage ( boolean $strLanguage ) : boolean	Check whether a language is installed
loadLanguageFile ( string $strName, boolean $strLanguage = null, boolean $blnNoCache = false )	Load a set of language files
log ( string $strText, string $strFunction, string $strCategory )	Add a log entry to the database
parseDate ( string $strFormat, integer $intTstamp = null ) : string	Parse a date format string and translate textual representations
redirect ( string $strLocation, integer $intStatus = 303 )	Redirect to another page
reload ( )	Reload the current page
setContainer ( Symfony\Component\DependencyInjection\ContainerInterface $container )	Set the container object
setCookie ( string $strName, mixed $varValue, integer $intExpires, string $strPath = null, string $strDomain = null, boolean $blnSecure = false, boolean $blnHttpOnly = false )	Set a cookie
splitFriendlyName ( string $strEmail ) : array	Split a friendly-name e-address and return name and e-mail as array
urlEncode ( string $strPath ) : string	Urlencode a file path preserving slashes

Protected Methods

Method	Description
__construct ( )	Import the Config and Session instances
addConfirmationMessage ( string $strMessage )	Add a confirmation message
addErrorMessage ( string $strMessage )	Add an error message
addInfoMessage ( string $strMessage )	Add an info message
addMessage ( string $strMessage, string $strType )	Add a message
addNewMessage ( string $strMessage )	Add a new message
addRawMessage ( string $strMessage )	Add an unformatted message
getMessageTypes ( ) : array	Return all available message types
getMessages ( string $strScope = TL_MODE ) : string	Return all messages as HTML
idnaDecode ( string $strDomain ) : string	Decode an internationalized domain name
idnaEncode ( string $strDomain ) : string	Encode an internationalized domain name
idnaEncodeEmail ( string $strEmail ) : string	Encode the domain in an e-mail address
idnaEncodeUrl ( string $strUrl ) : string	Encode the domain in an URL
import ( string $strClass, string $strKey = null, boolean $blnForce = false )	Import a library and make it accessible by its name or an optional key
isValidEmailAddress ( string $strEmail ) : boolean	Validate an e-mail address
readPhpFileWithoutTags ( string $strName ) : string	Read the contents of a PHP file, stripping the opening and closing PHP tags
resetMessages ( )	Reset the message system

Method Details

Property Details