PHP Class tl_article

Provide miscellaneous methods that are used by the data configuration array.
Inheritance: extends Backend
Show file Open project: contao/core-bundle Class Usage Examples

Public Methods

Method Description
__construct ( ) Import the back end user object
addAliasButton ( array $arrButtons ) : array Automatically generate the folder URL aliases
addIcon ( array $row, string $label ) : string Add an image to each page in the tree
checkPermission ( ) Check permissions to edit table tl_page
copyArticle ( array $row, string $href, string $label, string $title, string $icon, string $attributes, string $table ) : string Return the copy article button
cutArticle ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string Return the cut article button
deleteArticle ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string Return the delete article button
editArticle ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string Return the edit article button
editHeader ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string Return the edit header button
generateAlias ( mixed $varValue, DataContainer $dc ) : string Auto-generate an article alias if it has not been set yet
getActiveLayoutSections ( DataContainer $dc ) : array Return all active layout sections as array
getArticleTemplates ( ) : array Return all module templates as array
pasteArticle ( DataContainer $dc, array $row, string $table, boolean $cr, array $arrClipboard = null ) : string Return the paste article button
toggleIcon ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string Return the "toggle visibility" button
toggleVisibility ( integer $intId, boolean $blnVisible, DataContainer $dc = null ) Disable/enable a user group

Method Details

__construct() public method

Import the back end user object
public __construct ( )

addAliasButton() public method

Automatically generate the folder URL aliases
public addAliasButton ( array $arrButtons ) : array
$arrButtons array
return array

addIcon() public method

Add an image to each page in the tree
public addIcon ( array $row, string $label ) : string
$row array
$label string
return string

checkPermission() public method

Check permissions to edit table tl_page
public checkPermission ( )

copyArticle() public method

Return the copy article button
public copyArticle ( array $row, string $href, string $label, string $title, string $icon, string $attributes, string $table ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
$table string
return string

cutArticle() public method

Return the cut article button
public cutArticle ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
return string

deleteArticle() public method

Return the delete article button
public deleteArticle ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
return string

editArticle() public method

Return the edit article button
public editArticle ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
return string

editHeader() public method

Return the edit header button
public editHeader ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
return string

generateAlias() public method

Auto-generate an article alias if it has not been set yet
public generateAlias ( mixed $varValue, DataContainer $dc ) : string
$varValue mixed
$dc DataContainer
return string

getActiveLayoutSections() public method

Return all active layout sections as array
public getActiveLayoutSections ( DataContainer $dc ) : array
$dc DataContainer
return array

getArticleTemplates() public method

Return all module templates as array
public getArticleTemplates ( ) : array
return array

pasteArticle() public method

Return the paste article button
public pasteArticle ( DataContainer $dc, array $row, string $table, boolean $cr, array $arrClipboard = null ) : string
$dc DataContainer
$row array
$table string
$cr boolean
$arrClipboard array
return string

toggleIcon() public method

Return the "toggle visibility" button
public toggleIcon ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
return string

toggleVisibility() public method

Disable/enable a user group
public toggleVisibility ( integer $intId, boolean $blnVisible, DataContainer $dc = null )
$intId integer
$blnVisible boolean
$dc DataContainer