‪TYPO3CMS  11.5
BackendModule.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 
22 {
26  protected ‪$title = '';
27 
31  protected ‪$name = '';
32 
36  protected ‪$icon = '';
37 
41  protected ‪$link = '';
42 
46  protected ‪$component = '';
47 
52  protected ‪$onClick = '';
53 
57  protected ‪$description = '';
58 
62  protected ‪$navigationComponentId = '';
63 
68  protected ‪$navigationFrameScript = '';
69 
75 
79  protected ‪$children;
80 
84  protected ‪$collapsed = false;
85 
91  protected ‪$standalone = false;
92 
96  public function ‪__construct()
97  {
98  $this->children = new \SplObjectStorage();
99  }
100 
106  public function ‪setChildren(‪$children)
107  {
108  $this->children = ‪$children;
109  }
110 
116  public function ‪getChildren()
117  {
118  return ‪$this->children;
119  }
120 
126  public function ‪addChild(\‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule $child)
127  {
128  $this->children->attach($child);
129  }
130 
136  public function ‪setIcon(‪$icon)
137  {
138  $this->icon = ‪$icon;
139  }
140 
146  public function ‪getIcon()
147  {
148  return ‪$this->icon;
149  }
150 
156  public function ‪setName(‪$name)
157  {
158  $this->name = ‪$name;
159  }
160 
166  public function ‪getName()
167  {
168  return ‪$this->name;
169  }
170 
176  public function ‪setTitle(‪$title)
177  {
178  $this->title = ‪$title;
179  }
180 
186  public function ‪getTitle()
187  {
188  return ‪$this->title;
189  }
190 
196  public function ‪setLink(‪$link)
197  {
198  $this->link = ‪$link;
199  }
200 
206  public function ‪getLink()
207  {
208  return ‪$this->link;
209  }
210 
216  public function ‪setComponent(‪$component)
217  {
218  $this->component = ‪$component;
219  }
220 
226  public function ‪getComponent()
227  {
228  return ‪$this->component;
229  }
230 
236  public function ‪setDescription(‪$description)
237  {
238  $this->description = ‪$description;
239  }
240 
246  public function ‪getDescription()
247  {
248  return ‪$this->description;
249  }
250 
257  {
258  $this->navigationComponentId = ‪$navigationComponentId;
259  }
260 
266  public function ‪getNavigationComponentId()
267  {
269  }
270 
276  {
277  $this->navigationFrameScript = ‪$navigationFrameScript;
278  }
279 
284  public function ‪getNavigationFrameScript()
285  {
287  }
288 
294  {
295  $this->navigationFrameScriptParameters = ‪$navigationFrameScriptParameters;
296  }
297 
302  public function ‪getNavigationFrameScriptParameters()
303  {
305  }
306 
313  public function ‪setOnClick(‪$onClick)
314  {
315  trigger_error('BackendModule::setOnClick() is deprecated and will be removed in v12.', E_USER_DEPRECATED);
316  $this->onClick = ‪$onClick;
317  }
318 
325  public function ‪getOnClick()
326  {
327  trigger_error('BackendModule::getOnClick() is deprecated and will be removed in v12.', E_USER_DEPRECATED);
328  return ‪$this->onClick;
329  }
330 
331  public function ‪setCollapsed(bool ‪$collapsed): void
332  {
333  $this->collapsed = ‪$collapsed;
334  }
335 
336  public function ‪getCollapsed(): bool
337  {
338  return ‪$this->collapsed;
339  }
340 
344  public function ‪isStandalone(): bool
345  {
346  return ‪$this->standalone;
347  }
348 
352  public function ‪setStandalone(bool ‪$standalone): void
353  {
354  $this->standalone = ‪$standalone;
355  }
356 }
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setLink
‪setLink($link)
Definition: BackendModule.php:183
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getNavigationFrameScriptParameters
‪string getNavigationFrameScriptParameters()
Definition: BackendModule.php:289
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setChildren
‪setChildren($children)
Definition: BackendModule.php:93
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setComponent
‪setComponent($component)
Definition: BackendModule.php:203
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$standalone
‪bool $standalone
Definition: BackendModule.php:78
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getDescription
‪string getDescription()
Definition: BackendModule.php:233
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\__construct
‪__construct()
Definition: BackendModule.php:83
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getComponent
‪string getComponent()
Definition: BackendModule.php:213
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getOnClick
‪string getOnClick()
Definition: BackendModule.php:312
‪TYPO3\CMS\Backend\Domain\Model\Module
Definition: BackendModule.php:16
‪TYPO3
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setNavigationFrameScriptParameters
‪setNavigationFrameScriptParameters($navigationFrameScriptParameters)
Definition: BackendModule.php:280
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$link
‪string $link
Definition: BackendModule.php:37
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setIcon
‪setIcon($icon)
Definition: BackendModule.php:123
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$icon
‪string $icon
Definition: BackendModule.php:33
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getIcon
‪string getIcon()
Definition: BackendModule.php:133
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getName
‪string getName()
Definition: BackendModule.php:153
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\isStandalone
‪bool isStandalone()
Definition: BackendModule.php:331
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getNavigationComponentId
‪string getNavigationComponentId()
Definition: BackendModule.php:253
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getLink
‪string getLink()
Definition: BackendModule.php:193
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$name
‪string $name
Definition: BackendModule.php:29
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$navigationFrameScriptParameters
‪string $navigationFrameScriptParameters
Definition: BackendModule.php:64
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$navigationComponentId
‪string $navigationComponentId
Definition: BackendModule.php:54
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getCollapsed
‪getCollapsed()
Definition: BackendModule.php:323
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setStandalone
‪setStandalone(bool $standalone)
Definition: BackendModule.php:339
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setNavigationFrameScript
‪setNavigationFrameScript($navigationFrameScript)
Definition: BackendModule.php:262
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$children
‪SplObjectStorage $children
Definition: BackendModule.php:68
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getTitle
‪string getTitle()
Definition: BackendModule.php:173
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$title
‪string $title
Definition: BackendModule.php:25
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getChildren
‪SplObjectStorage getChildren()
Definition: BackendModule.php:103
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setCollapsed
‪setCollapsed(bool $collapsed)
Definition: BackendModule.php:318
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\addChild
‪addChild(\TYPO3\CMS\Backend\Domain\Model\Module\BackendModule $child)
Definition: BackendModule.php:113
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setNavigationComponentId
‪setNavigationComponentId($navigationComponentId)
Definition: BackendModule.php:243
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$navigationFrameScript
‪string $navigationFrameScript
Definition: BackendModule.php:59
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$collapsed
‪bool $collapsed
Definition: BackendModule.php:72
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$description
‪string $description
Definition: BackendModule.php:50
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule
Definition: BackendModule.php:22
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$component
‪string $component
Definition: BackendModule.php:41
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\$onClick
‪string $onClick
Definition: BackendModule.php:46
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getNavigationFrameScript
‪string getNavigationFrameScript()
Definition: BackendModule.php:271
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setName
‪setName($name)
Definition: BackendModule.php:143
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setTitle
‪setTitle($title)
Definition: BackendModule.php:163
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setOnClick
‪setOnClick($onClick)
Definition: BackendModule.php:300
‪TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\setDescription
‪setDescription($description)
Definition: BackendModule.php:223