TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn Class Reference

Inheritance diagram for TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn:

Public Member Functions
	__construct (PageLayoutContext $context, array $columnDefinition)
	isActive ()
	addItem (GridColumnItem $item)
GridColumnItem[]	getItems ()
	getColumnNumber ()
	getColumnName ()
	getIcon ()
	getColSpan ()
	getRowSpan ()
int[]	getAllContainedItemUids ()
	getEditUrl ()
	getNewContentUrl ()
	getTitle ()
	getTitleInaccessible ()
	getTitleUnassigned ()
	isUnassigned ()
	isContentEditable ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject
	__construct (PageLayoutContext $context)
	getUniqueId ()
	getContext ()

Protected Attributes
GridColumnItem[]	$items = array( )
int null	$columnNumber
string	$columnName = 'default'
string null	$icon
int	$colSpan = 1
int	$rowSpan = 1
‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject
PageLayoutContext	$context
IconFactory	$iconFactory

Additional Inherited Members
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject
	getLanguageService ()
	getBackendUser ()

Detailed Description

Grid Column

Object representation (model/proxy) for a single column from a grid defined in a BackendLayout. Stores GridColumnItem representations of content records and provides getter methods which return various properties associated with a single column, e.g. the "edit all elements in content" URL and the "add new content element" URL of the button that is placed in the top of columns in the page layout.

Accessed from Fluid templates.

this is experimental and subject to change in TYPO3 v10 / v11

Definition at line 40 of file GridColumn.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::__construct	(	PageLayoutContext	$context,
		array	$columnDefinition
	)

Definition at line 66 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$columnName, TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\$context, and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$icon.

Member Function Documentation

addItem()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::addItem

(

GridColumnItem

$item

)

Definition at line 81 of file GridColumn.php.

getAllContainedItemUids()

int [] TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getAllContainedItemUids

(

)

Returns

‪int[]

Definition at line 128 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getEditUrl().

getColSpan()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getColSpan

(

)

Definition at line 109 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$colSpan.

getColumnName()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getColumnName

(

)

Definition at line 99 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$columnName.

getColumnNumber()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getColumnNumber

(

)

Definition at line 94 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$columnNumber.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridRow\addColumn(), TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getNewContentUrl(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getTitle().

getEditUrl()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getEditUrl

(

)

Definition at line 137 of file GridColumn.php.

References TYPO3\CMS\Core\Type\Bitmask\Permission\CONTENT_EDIT, TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getAllContainedItemUids(), TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\getBackendUser(), and TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle().

getIcon()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getIcon

(

)

Definition at line 104 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$icon.

getItems()

GridColumnItem [] TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getItems

(

)

Returns

‪GridColumnItem[]

Definition at line 89 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$items.

getNewContentUrl()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getNewContentUrl

(

)

Definition at line 155 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getColumnNumber(), and TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig().

getRowSpan()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getRowSpan

(

)

Definition at line 117 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$rowSpan.

getTitle()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getTitle

(

)

Definition at line 191 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$columnNumber, TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$title, TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getColumnNumber(), TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\getLanguageService(), and TYPO3\CMS\Backend\Utility\BackendUtility\getProcessedValue().

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getTitleUnassigned().

getTitleInaccessible()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getTitleInaccessible

(

)

Definition at line 203 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\getLanguageService().

getTitleUnassigned()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getTitleUnassigned

(

)

Definition at line 208 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\getLanguageService(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getTitle().

isActive()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::isActive

(

)

Definition at line 76 of file GridColumn.php.

isContentEditable()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::isContentEditable

(

)

Definition at line 218 of file GridColumn.php.

References TYPO3\CMS\Core\Type\Bitmask\Permission\CONTENT_EDIT, and TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\getBackendUser().

isUnassigned()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::isUnassigned

(

)

Definition at line 213 of file GridColumn.php.

Member Data Documentation

$colSpan

int TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$colSpan = 1

protected

Definition at line 60 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getColSpan().

$columnName

string TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$columnName = 'default'

protected

Definition at line 52 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\__construct(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getColumnName().

$columnNumber

int null TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$columnNumber

protected

Definition at line 48 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getColumnNumber(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getTitle().

$icon

string null TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$icon

protected

Definition at line 56 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\__construct(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getIcon().

$items

GridColumnItem [] TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$items = array( )

protected

Definition at line 44 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getItems().

$rowSpan

int TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$rowSpan = 1

protected

Definition at line 64 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getRowSpan().