[TASK] Clean up the phpDoc of t3lib/tree/
[Packages/TYPO3.CMS.git] / t3lib / tree / pagetree / class.t3lib_tree_pagetree_indicator.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2010-2011 Susanne Moog <typo3@susanne-moog.de>
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28 /**
29 * Class for pagetree indicator
30 *
31 * @author Susanne Moog <typo3@susanne-moog.de>
32 * @package TYPO3
33 * @subpackage t3lib
34 */
35 class t3lib_tree_pagetree_Indicator {
36 /**
37 * Indicator Providers
38 *
39 * @var array
40 */
41 protected $indicatorProviders = array();
42
43 /**
44 * Constructor for class tx_reports_report_Status
45 */
46 public function __construct() {
47 $this->getIndicatorProviders();
48 }
49
50 /**
51 * Gets all registered indicator providers and instantiates them
52 */
53 protected function getIndicatorProviders() {
54 $providers = $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['pagetree']['t3lib_tree_pagetree']['indicator']['providers'];
55 if (!is_array($providers)) {
56 return;
57 }
58
59 foreach ($providers as $indicatorProvider) {
60 /** @var $indicatorProviderInstance t3lib_tree_pagetree_interfaces_IndicatorProvider */
61 $indicatorProviderInstance = t3lib_div::makeInstance($indicatorProvider);
62 if ($indicatorProviderInstance instanceof t3lib_tree_pagetree_interfaces_IndicatorProvider) {
63 $this->indicatorProviders[] = $indicatorProviderInstance;
64 }
65 }
66 }
67
68 /**
69 * Runs through all indicator providers and returns all indicators collected.
70 *
71 * @return array An array of
72 */
73 public function getAllIndicators() {
74 $indicators = array();
75 foreach ($this->indicatorProviders as $indicatorProvider) {
76 $indicator = $indicatorProvider->getIndicator();
77 if($indicator) {
78 $indicators[] = $indicator;
79 }
80 }
81
82 return $indicators;
83 }
84 }
85
86 ?>