• Home
• Contao
• Controller

PHP Class Contao\Controller

Some of the methods have been made static in Contao 3 and can be used in non-object context as well. Usage: echo Controller::getTheme(); Inside a controller: public function generate() { return $this->getArticle(2); } Show file Open project: contao/core-bundle Class Usage Examples

Public Methods

Method	Description
addEnclosuresToTemplate ( object $objTemplate, array $arrItem, string $strKey = 'enclosure' )	Add enclosures to a template
addImageToTemplate ( object $objTemplate, array $arrItem, integer $intMaxWidth = null, string $strLightboxId = null )	Add an image to a template
addStaticUrlTo ( string $script ) : string	Add a static URL to a script
addToUrl ( string $strRequest, boolean $blnAddRef = true, array $arrUnset = [] ) : string	Add a request string to the current URL
convertRelativeUrls ( string $strContent, string $strBase = '', boolean $blnHrefOnly = false ) : string	Convert relative URLs in href and src attributes to absolute URLs
findContentElement ( string $strName ) : string	Find a content element in the TL_CTE array and return the class name
findFrontendModule ( string $strName ) : string	Find a front end module in the FE_MOD array and return the class name
generateFrontendUrl ( array $arrRow, string $strParams = null, string $strForceLang = null, boolean $blnFixDomain = false ) : string	Generate a front end URL
generateImage ( string $src, string $alt = '', string $attributes = '' ) : string	Generate an image tag and return it as string
generateMargin ( array $arrValues, string $strType = 'margin' ) : string	Compile the margin format definition based on an array of values
getArticle ( mixed $varId, boolean $blnMultiMode = false, boolean $blnIsInsertTag = false, string $strColumn = 'main' ) : string | boolean	Generate an article and return it as string
getBackendThemes ( ) : array	Return the back end themes as array
getContentElement ( mixed $intId, string $strColumn = 'main' ) : string	Generate a content element and return it as string
getForm ( mixed $varId, string $strColumn = 'main' ) : string	Generate a form and return it as string
getFrontendModule ( mixed $intId, string $strColumn = 'main' ) : string	Generate a front end module and return it as string
getPageDetails ( mixed $intId ) : PageModel	Get the details of a page including inherited parameters
getPageSections ( ) : array	Return all page sections as array
getPageStatusIcon ( PageModel | Result | object $objPage ) : string	Calculate the page status icon name based on the page parameters
getTemplate ( string $strTemplate, string $strFormat = 'html5' ) : string	Find a particular template file and return its path
getTemplateGroup ( string $strPrefix ) : array	Return all template files of a particular group as array
getTheme ( ) : string	Return the current theme as string
isVisibleElement ( Model $objElement ) : boolean	Check whether an element is visible in the front end
loadDataContainer ( string $strTable, boolean $blnNoCache = false )	Load a set of DCA files
optionChecked ( string $strOption, mixed $varValues ) : string	Return a "checked" attribute if the option is checked
optionSelected ( string $strOption, mixed $varValues ) : string	Return a "selected" attribute if the option is selected
redirect ( string $strLocation, integer $intStatus = 303 )	Redirect to another page
reload ( )	Reload the current page
replaceDynamicScriptTags ( string $strBuffer ) : string	Replace the dynamic script tags (see #4203)
replaceInsertTags ( string $strBuffer, boolean $blnCache = true ) : string	Replace insert tags with their values
restoreBasicEntities ( string $strBuffer ) : string	Restore basic entities
sendFileToBrowser ( string $strFile )	Send a file to the browser so the "save as …" dialogue opens
setStaticUrls ( PageModel $objPage = null )	Set the static URL constants

Protected Methods

Method	Description
classFileExists ( string $strClass ) : boolean	Return true if a class exists (tries to autoload the class)
createInitialVersion ( string $strTable, integer $intId )	Create an initial version of a record
createNewVersion ( string $strTable, integer $intId )	Create a new version of a record
eliminateNestedPages ( array $arrPages, string $strTable = null, boolean $blnSorting = false ) : array	Take an array of pages and eliminate the nested ones
eliminateNestedPaths ( array $arrPaths ) : array	Take an array of file paths and eliminate the nested ones
getBackendLanguages ( ) : array	Return the installed back end languages as array
getChildRecords ( mixed $arrParentIds, string $strTable, boolean $blnSorting = false, array $arrReturn = [], string $strWhere = '' ) : array	Return the IDs of all child records of a particular record (see #2475)
getDatePickerString ( ) : boolean	Return the date picker string (see #3218)
getImage ( string $image, integer $width, integer $height, string $mode = '', string $target = null, boolean $force = false ) : string | null	Resize an image and crop it if necessary
getParentEntries ( string $strTable, integer $intId ) : string	Get the parent records of an entry and return them as string which can be used in a log message
getParentRecords ( integer $intId, string $strTable ) : array	Return the IDs of all parent records of a particular record
getSpellcheckerString ( ) : string	Return the languages for the TinyMCE spellchecker
parseSimpleTokens ( string $strBuffer, array $arrData ) : string	Parse simple tokens that can be used to personalize newsletters
prepareForWidget ( array $arrData, string $strName, mixed $varValue = null, string $strField = '', string $strTable = '' ) : array	Convert a DCA file configuration to be used with widgets
printArticleAsPdf ( ModuleModel $objArticle )	Print an article as PDF and stream it to the browser
redirectToFrontendPage ( integer $intPage, mixed $varArticle = null, boolean $blnReturn = false ) : string	Redirect to a front end page
removeOldFeeds ( boolean $blnReturn = false ) : array	Remove old XML files from the share directory
replaceOldBePaths ( string $strContext ) : string	Replace the old back end paths
resizeImage ( string $image, integer $width, integer $height, string $mode = '' ) : boolean	Resize an image and crop it if necessary

Method Details