‪TYPO3CMS  ‪main
AbstractTableConfigurationTreeDataProvider.php
Go to the documentation of this file.
1 <?php
2 
3 /*
4  * This file is part of the TYPO3 CMS project.
5  *
6  * It is free software; you can redistribute it and/or modify it under
7  * the terms of the GNU General Public License, either version 2
8  * of the License, or any later version.
9  *
10  * For the full copyright and license information, please read the
11  * LICENSE.txt file that was distributed with this source code.
12  *
13  * The TYPO3 project - inspiring people to share!
14  */
15 
17 
21 
26 {
30  protected ‪$expandAll = false;
31 
35  protected ‪$levelMaximum = 4;
36 
40  protected ‪$treeData;
41 
45  protected ‪$treeId;
46 
50  protected ‪$nonSelectableLevelList = '0';
51 
55  protected ‪$expandedList = '';
56 
60  protected ‪$selectedList = '';
61 
68  protected ‪$itemWhiteList = [];
69 
74  protected ‪$itemUnselectableList = [];
75 
81  protected array ‪$availableItems = [];
82 
88  public function ‪setTreeId(‪$treeId)
89  {
90  $this->treeId = ‪$treeId;
91  }
92 
98  public function ‪getTreeId()
99  {
100  return ‪$this->treeId;
101  }
102 
108  public function ‪setExpandAll(‪$expandAll)
109  {
110  $this->expandAll = ‪$expandAll;
111  }
112 
118  public function ‪getExpandAll()
119  {
120  return ‪$this->expandAll;
121  }
122 
128  public function ‪setLevelMaximum(‪$levelMaximum)
129  {
130  $this->levelMaximum = ‪$levelMaximum;
131  }
132 
138  public function ‪getLevelMaximum()
139  {
140  return ‪$this->levelMaximum;
141  }
142 
148  protected function ‪isExpanded(‪TreeNode $node)
149  {
150  return $this->‪getExpandAll() || ‪GeneralUtility::inList($this->expandedList, $node->‪getId());
151  }
152 
156  public function ‪initializeTreeData() {}
157 
163  public function ‪setSelectedList(‪$selectedList)
164  {
165  $this->selectedList = ‪$selectedList;
166  }
167 
173  public function ‪getSelectedList()
174  {
175  return ‪$this->selectedList;
176  }
177 
184  {
185  $this->nonSelectableLevelList = ‪$nonSelectableLevelList;
186  }
187 
193  public function ‪getNonSelectableLevelList()
194  {
196  }
197 
201  public function ‪setItemWhiteList(array ‪$itemWhiteList)
202  {
203  $this->itemWhiteList = ‪$itemWhiteList;
204  }
205 
211  public function ‪getItemWhiteList()
212  {
214  }
215 
220  {
221  $this->itemUnselectableList = ‪$itemUnselectableList;
222  }
223 
229  public function ‪getItemUnselectableList()
230  {
232  }
233 
237  public function ‪setAvailableItems(array ‪$availableItems)
238  {
239  $this->availableItems = ‪$availableItems;
240  }
241 }
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\initializeTreeData
‪initializeTreeData()
Definition: AbstractTableConfigurationTreeDataProvider.php:147
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$expandAll
‪bool $expandAll
Definition: AbstractTableConfigurationTreeDataProvider.php:29
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$treeData
‪TreeNode $treeData
Definition: AbstractTableConfigurationTreeDataProvider.php:37
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$expandedList
‪string $expandedList
Definition: AbstractTableConfigurationTreeDataProvider.php:49
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setAvailableItems
‪setAvailableItems(array $availableItems)
Definition: AbstractTableConfigurationTreeDataProvider.php:228
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setLevelMaximum
‪setLevelMaximum($levelMaximum)
Definition: AbstractTableConfigurationTreeDataProvider.php:119
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setExpandAll
‪setExpandAll($expandAll)
Definition: AbstractTableConfigurationTreeDataProvider.php:99
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$itemWhiteList
‪array $itemWhiteList
Definition: AbstractTableConfigurationTreeDataProvider.php:60
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$treeId
‪string $treeId
Definition: AbstractTableConfigurationTreeDataProvider.php:41
‪TYPO3\CMS\Backend\Tree\AbstractTreeDataProvider
Definition: AbstractTreeDataProvider.php:22
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider
Definition: AbstractTableConfigurationTreeDataProvider.php:26
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getSelectedList
‪string getSelectedList()
Definition: AbstractTableConfigurationTreeDataProvider.php:164
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\isExpanded
‪bool isExpanded(TreeNode $node)
Definition: AbstractTableConfigurationTreeDataProvider.php:139
‪TYPO3\CMS\Backend\Tree\TreeNode
Definition: TreeNode.php:25
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getExpandAll
‪bool getExpandAll()
Definition: AbstractTableConfigurationTreeDataProvider.php:109
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getItemWhiteList
‪array getItemWhiteList()
Definition: AbstractTableConfigurationTreeDataProvider.php:202
‪TYPO3\CMS\Core\Tree\TableConfiguration
Definition: AbstractTableConfigurationTreeDataProvider.php:16
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$availableItems
‪array $availableItems
Definition: AbstractTableConfigurationTreeDataProvider.php:72
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setTreeId
‪setTreeId($treeId)
Definition: AbstractTableConfigurationTreeDataProvider.php:79
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getNonSelectableLevelList
‪string getNonSelectableLevelList()
Definition: AbstractTableConfigurationTreeDataProvider.php:184
‪TYPO3\CMS\Backend\Tree\TreeNode\getId
‪string int getId()
Definition: TreeNode.php:121
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getItemUnselectableList
‪array getItemUnselectableList()
Definition: AbstractTableConfigurationTreeDataProvider.php:220
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$levelMaximum
‪int $levelMaximum
Definition: AbstractTableConfigurationTreeDataProvider.php:33
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getTreeId
‪string getTreeId()
Definition: AbstractTableConfigurationTreeDataProvider.php:89
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setSelectedList
‪setSelectedList($selectedList)
Definition: AbstractTableConfigurationTreeDataProvider.php:154
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$itemUnselectableList
‪mixed[] $itemUnselectableList
Definition: AbstractTableConfigurationTreeDataProvider.php:65
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setItemUnselectableList
‪setItemUnselectableList(array $itemUnselectableList)
Definition: AbstractTableConfigurationTreeDataProvider.php:210
‪TYPO3\CMS\Core\Utility\GeneralUtility\inList
‪static bool inList($list, $item)
Definition: GeneralUtility.php:422
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setNonSelectableLevelList
‪setNonSelectableLevelList($nonSelectableLevelList)
Definition: AbstractTableConfigurationTreeDataProvider.php:174
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setItemWhiteList
‪setItemWhiteList(array $itemWhiteList)
Definition: AbstractTableConfigurationTreeDataProvider.php:192
‪TYPO3\CMS\Core\Utility\GeneralUtility
Definition: GeneralUtility.php:52
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$selectedList
‪string $selectedList
Definition: AbstractTableConfigurationTreeDataProvider.php:53
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$nonSelectableLevelList
‪string $nonSelectableLevelList
Definition: AbstractTableConfigurationTreeDataProvider.php:45
‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getLevelMaximum
‪int getLevelMaximum()
Definition: AbstractTableConfigurationTreeDataProvider.php:129