PHP Class Contao\Backend

Provide methods to manage back end controllers.

Inheritance: extends Controller

Mostra file Open project: contao/core-bundle Class Usage Examples

Public Methods

Method	Description
addFileMetaInformationToRequest ( string $strUuid, string $strPtable, integer $intPid )	Add the file meta information to the request
addFilesBreadcrumb ( string $strKey = 'tl_files_node' )	Add a breadcrumb menu to the file tree
addPageIcon ( array $row, string $label, DataContainer $dc = null, string $imageAttribute = '', boolean $blnReturnImage = false, boolean $blnProtected = false ) : string	Add an image to each page in the tree
addPagesBreadcrumb ( string $strKey = 'tl_page_node' )	Add a breadcrumb menu to the page tree
addToUrl ( string $strRequest, boolean $blnAddRef = true, array $arrUnset = [] ) : string	Add the request token to the URL
createFileList ( string $strFilter = '', boolean $filemount = false ) : string	Get all allowed files and return them as string
createPageList ( ) : string	Get all allowed pages and return them as string
findSearchablePages ( integer $pid, string $domain = '', boolean $blnIsSitemap = false ) : array	Get all searchable pages and return them as array
getAceType ( string $ext ) : string	Get the Ace code editor type from a file extension
getSystemMessages ( ) : string	Return the system messages as HTML
getTheme ( ) : string	Return the current theme as string
getThemes ( ) : array	Return the back end themes as array
getTinyMceLanguage ( ) : string	Return the TinyMCE language
getTinyTemplates ( ) : string	Return a list of TinyMCE templates as JSON string
handleRunOnce ( )	Handle "runonce" files

Protected Methods

Method	Description
__construct ( )	Load the database object
doCreateFileList ( string $strFolder = null, integer $level, string $strFilter = '' ) : string	Recursively get all allowed files and return them as string
doCreatePageList ( integer $intId, integer $level ) : string	Recursively get all allowed pages and return them as string
getBackendModule ( string $module ) : string	Open a back end module and return it as HTML

Method Details

__construct() protected method

Load the database object

protected __construct ( )

addFileMetaInformationToRequest() public static method

Add the file meta information to the request

public static addFileMetaInformationToRequest ( string $strUuid, string $strPtable, integer $intPid )
$strUuid	string
$strPtable	string
$intPid	integer

addFilesBreadcrumb() public static method

Add a breadcrumb menu to the file tree

public static addFilesBreadcrumb ( string $strKey = 'tl_files_node' )
$strKey	string

addPageIcon() public static method

Add an image to each page in the tree

public static addPageIcon ( array $row, string $label, DataContainer $dc = null, string $imageAttribute = '', boolean $blnReturnImage = false, boolean $blnProtected = false ) : string
$row	array
$label	string
$dc	DataContainer
$imageAttribute	string
$blnReturnImage	boolean
$blnProtected	boolean
return	string

addPagesBreadcrumb() public static method

Add a breadcrumb menu to the page tree

public static addPagesBreadcrumb ( string $strKey = 'tl_page_node' )
$strKey	string

addToUrl() public static method

Add the request token to the URL

public static addToUrl ( string $strRequest, boolean $blnAddRef = true, array $arrUnset = [] ) : string
$strRequest	string
$blnAddRef	boolean
$arrUnset	array
return	string

createFileList() public method

Get all allowed files and return them as string

public createFileList ( string $strFilter = '', boolean $filemount = false ) : string
$strFilter	string
$filemount	boolean
return	string

createPageList() public method

Get all allowed pages and return them as string

public createPageList ( ) : string
return	string

doCreateFileList() protected method

Recursively get all allowed files and return them as string

protected doCreateFileList ( string $strFolder = null, integer $level, string $strFilter = '' ) : string
$strFolder	string
$level	integer
$strFilter	string
return	string

doCreatePageList() protected method

Recursively get all allowed pages and return them as string

protected doCreatePageList ( integer $intId, integer $level ) : string
$intId	integer
$level	integer
return	string

findSearchablePages() public static method

Get all searchable pages and return them as array

public static findSearchablePages ( integer $pid, string $domain = '', boolean $blnIsSitemap = false ) : array
$pid	integer
$domain	string
$blnIsSitemap	boolean
return	array

getAceType() public static method

Get the Ace code editor type from a file extension

public static getAceType ( string $ext ) : string
$ext	string
return	string

getBackendModule() protected method

Open a back end module and return it as HTML

protected getBackendModule ( string $module ) : string
$module	string
return	string

getSystemMessages() public static method

Return the system messages as HTML

public static getSystemMessages ( ) : string
return	string	The messages HTML markup

getTheme() public static method

Return the current theme as string

public static getTheme ( ) : string
return	string	The name of the theme

getThemes() public static method

Return the back end themes as array

public static getThemes ( ) : array
return	array	An array of available back end themes

getTinyMceLanguage() public static method

Return the TinyMCE language

public static getTinyMceLanguage ( ) : string
return	string

getTinyTemplates() public static method

Return a list of TinyMCE templates as JSON string

public static getTinyTemplates ( ) : string
return	string

handleRunOnce() public static method

Handle "runonce" files

public static handleRunOnce ( )