FluidTYPO3 / fluidcontent / 538

pending completion

Build # 538

Build Type

push

travis-ci

Committed by

NamelessCoder

Commit Message

<a href="https://github.com/FluidTYPO3/fluidcontent/commit/<a class=hub.com/FluidTYPO3/fluidcontent/commit/<a class="double-link" href="https://git"><a class=hub.com/FluidTYPO3/fluidcontent/commit/<a class="double-link" href="https://git"><a class=hub.com/FluidTYPO3/fluidcontent/commit/<a class="double-link" href="https://git"><a class=hub.com/FluidTYPO3/fluidcontent/commit/5b2e41b6d5a52c87d8fecc908c1cb751aa6aaa42">5b2e41b6d">&lt;a href=&quot;https://github.com/FluidTYPO3/fluidcontent/commit/</a><a class="double-link" href="https://github.com/FluidTYPO3/fluidcontent/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/FluidTYPO3/fluidcontent/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/FluidTYPO3/fluidcontent/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/FluidTYPO3/fluidcontent/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/FluidTYPO3/fluidcontent/commit/5b2e41b6d5a52c87d8fecc908c1cb751aa6aaa42">5b2e41b6d</a><a href="https://github.com/FluidTYPO3/fluidcontent/commit/5b2e41b6d5a52c87d8fecc908c1cb751aa6aaa42">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/FluidTYPO3/fluidcontent/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/FluidTYPO3/fluidcontent/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/FluidTYPO3/fluidcontent/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/FluidTYPO3/fluidcontent/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/FluidTYPO3/fluidcontent/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/FluidTYPO3/fluidcontent/commit/5b2e41b6d5a52c87d8fecc908c1cb751aa6aaa42&quot;&gt;5b2e41b6d&lt;/a&gt;&lt;a href=&quot;https://github.com/FluidTYPO3/fluidcontent/commit/5b2e41b6d5a52c87d8fecc908c1cb751aa6aaa42&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/FluidTYPO3/fluidcontent/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot... (continued)

Run Details

287 of 327 relevant lines covered (87.77%)

2.4 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

84.18

Classes/Service/ConfigurationService.php

<?php
namespace FluidTYPO3\Fluidcontent\Service;

/*
 * This file is part of the FluidTYPO3/Fluidcontent project under GPLv2 or later.
 *
 * For the full copyright and license information, please read the
 * LICENSE.md file that was distributed with this source code.
 */

use FluidTYPO3\Flux\Configuration\ConfigurationManager;
use FluidTYPO3\Flux\Core;
use FluidTYPO3\Flux\Form;
use FluidTYPO3\Flux\View\TemplatePaths;
use FluidTYPO3\Flux\View\ViewContext;
use FluidTYPO3\Flux\Service\FluxService;
use FluidTYPO3\Flux\Service\WorkspacesAwareRecordService;
use FluidTYPO3\Flux\Utility\ExtensionNamingUtility;
use FluidTYPO3\Flux\Utility\MiscellaneousUtility;
use TYPO3\CMS\Core\Cache\CacheManager;
use TYPO3\CMS\Core\Cache\Frontend\StringFrontend;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Configuration Service
 *
 * Provides methods to read various configuration related
 * to Fluid Content Elements.
 */
class ConfigurationService extends FluxService implements SingletonInterface {

        /**
         * Default Width for icon
         */
        const ICON_WIDTH = '24m';

        /**
         * Default Height for icon
         */
        const ICON_HEIGHT = '24m';

        /**
         * @var array
         */
        protected $extConf;

        /**
         * @var CacheManager
         */
        protected $manager;

        /**
         * @var WorkspacesAwareRecordService
         */
        protected $recordService;

        /**
         * @var string
         */
        protected $defaultIcon;

        /**
         * Storage for the current page UID to restore after this Service abuses
         * ConfigurationManager to override the page UID used when resolving
         * configurations for all TypoScript templates defined in the site.
         *
         * @var integer
         */
        protected $pageUidBackup;

        /**
         * @param CacheManager $manager
         * @return void
         */
        public function injectCacheManager(CacheManager $manager) {
                $this->manager = $manager;
        }

        /**
         * @param WorkspacesAwareRecordService $recordService
         * @return void
         */
        public function injectRecordService(WorkspacesAwareRecordService $recordService) {
                $this->recordService = $recordService;
        }

        /**
         * Constructor
         */
        public function __construct() {
                $this->defaultIcon = '../' . ExtensionManagementUtility::siteRelPath('fluidcontent') . 'Resources/Public/Icons/Plugin.svg';

                $this->extConf = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['fluidcontent']);
                $this->extConf['iconWidth'] = $this->extConf['iconWidth'] ? : self::ICON_WIDTH;
                $this->extConf['iconHeight'] = $this->extConf['iconHeight'] ? : self::ICON_HEIGHT;
        }

        /**
         * @return string
         */
        public function getDefaultIcon() {
                return $this->defaultIcon;
        }

        /**
         * @return boolean
         */
        protected function isBackendMode() {
                return ('BE' === TYPO3_MODE);
        }

        /**
         * Get definitions of paths for FCEs defined in TypoScript
         *
         * @param string $extensionName
         * @return array
         * @api
         */
        public function getContentConfiguration($extensionName = NULL) {
                if (NULL !== $extensionName) {
                        return $this->getViewConfigurationForExtensionName($extensionName);
                }
                $registeredExtensionKeys = (array) Core::getRegisteredProviderExtensionKeys('Content');
                $configuration = array();
                foreach ($registeredExtensionKeys as $registeredExtensionKey) {
                        $configuration[$registeredExtensionKey] = $this->getContentConfiguration($registeredExtensionKey);
                }
                return $configuration;
        }

        /**
         * @return string
         */
        public function getPageTsConfig() {
        $cache = $this->manager->getCache('fluidcontent');
        if (!$cache->has('pageTsConfig')) {
            $pageTsConfig = '';
            $templates = $this->getAllRootTypoScriptTemplates();
            $processed = array();
            foreach ($templates as $template) {
                $pageUid = (integer) $template['pid'];
                if (isset($processed[$pageUid])) {
                    continue;
                }
                $pageTsConfig .= $this->renderPageTypoScriptForPageUid($pageUid);
                $processed[$pageUid] = 1;
            }
            $cache->set('pageTsConfig', $pageTsConfig, array(), 86400);
        }
        return $cache->get('pageTsConfig');
    }

        /**
     * Delegates to $this->getPageTsConfig() which pre-warms the cached TS
     *
     * @return void
         */
        public function writeCachedConfigurationIfMissing() {
        $this->getPageTsConfig();
    }

        /**
         * @param $pageUid
         * @return string
         */
        protected function renderPageTypoScriptForPageUid($pageUid) {
                $this->backupPageUidForConfigurationManager();
                $this->overrideCurrentPageUidForConfigurationManager($pageUid);
                $pageTsConfig = '';
                try {
                        $collection = $this->getContentConfiguration();
                        $wizardTabs = $this->buildAllWizardTabGroups($collection);
                        $collectionPageTsConfig = $this->buildAllWizardTabsPageTsConfig($wizardTabs);
                        $pageTsConfig .= '[PIDinRootline = ' . strval($pageUid) . ']' . LF;
                        $pageTsConfig .= $collectionPageTsConfig . LF;
                        $pageTsConfig .= '[GLOBAL]' . LF;
                        $this->message('Built content setup for page ' . $pageUid, GeneralUtility::SYSLOG_SEVERITY_INFO, 'Fluidcontent');
                } catch (\RuntimeException $error) {
                        $this->debug($error);
                }
                $this->restorePageUidForConfigurationManager();
                return $pageTsConfig;
        }

        /**
         * @param integer $newPageUid
         * @return void
         */
        protected function overrideCurrentPageUidForConfigurationManager($newPageUid) {
                if (TRUE === $this->configurationManager instanceof ConfigurationManager) {
                        $this->configurationManager->setCurrentPageUid($newPageUid);
                }
        }

        /**
         * @return void
         */
        protected function backupPageUidForConfigurationManager() {
                if (TRUE === $this->configurationManager instanceof ConfigurationManager) {
                        $this->pageUidBackup = $this->configurationManager->getCurrentPageId();
                }
        }

        /**
         * @return void
         */
        protected function restorePageUidForConfigurationManager() {
                if (TRUE === $this->configurationManager instanceof ConfigurationManager) {
                        $this->configurationManager->setCurrentPageUid($this->pageUidBackup);
                }
        }

        /**
         * @return array
         */
        protected function getAllRootTypoScriptTemplates() {
                $condition = 'deleted = 0 AND hidden = 0 AND starttime <= :starttime AND (endtime = 0 OR endtime > :endtime)';
                $parameters = array(
                        ':starttime' => $GLOBALS['SIM_ACCESS_TIME'],
                        ':endtime' => $GLOBALS['SIM_ACCESS_TIME']
                );
                $rootTypoScriptTemplates = $this->recordService->preparedGet('sys_template', 'pid', $condition, $parameters);
                return $rootTypoScriptTemplates;
        }

        /**
         * Scans all folders in $allTemplatePaths for template
         * files, reads information about each file and collects
         * the groups of files into groups of pageTSconfig setup.
         *
         * @param array $allTemplatePaths
         * @return array
         */
        protected function buildAllWizardTabGroups($allTemplatePaths) {
                $wizardTabs = array();
                $forms = $this->getContentElementFormInstances();
                foreach ($forms as $extensionKey => $formSet) {
                        $formSet = $this->sortObjectsByProperty($formSet, 'options.Fluidcontent.sorting', 'ASC');
                        foreach ($formSet as $id => $form) {
                                /** @var Form $form */
                                $group = $form->getOption(Form::OPTION_GROUP);
                                if (TRUE === empty($group)) {
                                        $group = 'Content';
                                }
                                $tabId = $this->sanitizeString($group);
                                $wizardTabs[$tabId]['title'] = $group;
                                $contentElementId = $form->getOption('contentElementId');
                                $elementTsConfig = $this->buildWizardTabItem($tabId, $id, $form, $contentElementId);
                                $wizardTabs[$tabId]['elements'][$id] = $elementTsConfig;
                                $wizardTabs[$tabId]['key'] = $extensionKey;
                        }
                }
                return $wizardTabs;
        }

        /**
         * @return Form[][]
         */
        public function getContentElementFormInstances() {
                $elements = array();
                $allTemplatePaths = $this->getContentConfiguration();
                $controllerName = 'Content';
                foreach ($allTemplatePaths as $registeredExtensionKey => $templatePathSet) {
                        $files = array();
                        $extensionKey = TRUE === isset($templatePathSet['extensionKey']) ? $templatePathSet['extensionKey'] : $registeredExtensionKey;
                        $extensionKey = ExtensionNamingUtility::getExtensionKey($extensionKey);
                        $templatePaths = new TemplatePaths($templatePathSet);
                        $viewContext = new ViewContext(NULL, $extensionKey);
                        $viewContext->setTemplatePaths($templatePaths);
                        $viewContext->setSectionName('Configuration');
                        foreach ($templatePaths->getTemplateRootPaths() as $templateRootPath) {
                                $files = GeneralUtility::getAllFilesAndFoldersInPath($files, $templateRootPath . '/' . $controllerName .'/', 'html');
                                if (0 < count($files)) {
                                        foreach ($files as $templateFilename) {
                                                $actionName = pathinfo($templateFilename, PATHINFO_FILENAME);
                                                $fileRelPath = $actionName . '.html';
                                                $viewContext->setTemplatePathAndFilename($templateFilename);
                                                $form = $this->getFormFromTemplateFile($viewContext);
                                                if (TRUE === empty($form)) {
                                                        $this->sendDisabledContentWarning($templateFilename);
                                                        continue;
                                                }
                                                if (FALSE === $form->getEnabled()) {
                                                        $this->sendDisabledContentWarning($templateFilename);
                                                        continue;
                                                }
                                                $id = preg_replace('/[\.\/]/', '_', $registeredExtensionKey . '/' . $actionName . '.html');
                                                $form->setOption('contentElementId', $registeredExtensionKey . ':' . $fileRelPath);
                                                $elements[$registeredExtensionKey][$id] = $form;
                                        }
                                }
                        }
                }
                return $elements;
        }

        /**
         * Builds a big piece of pageTSconfig setup, defining
         * every detected content element's wizard tabs and items.
         *
         * @param array $wizardTabs
         * @return string
         */
        protected function buildAllWizardTabsPageTsConfig($wizardTabs) {
                $pageTsConfig = '';
                foreach ($wizardTabs as $tab) {
                        foreach ($tab['elements'] as $elementTsConfig) {
                                $pageTsConfig .= $elementTsConfig;
                        }
                }
                foreach ($wizardTabs as $tabId => $tab) {
                        $pageTsConfig .= sprintf('
                                mod.wizards.newContentElement.wizardItems.%s {
                                        header = %s
                                        show = %s
                                        position = 0
                                        key = %s
                                }
                                ',
                                $tabId,
                                $tab['title'],
                                implode(',', array_keys($tab['elements'])),
                                $tab['key']
                        );
                }
                return $pageTsConfig;
        }

        /**
         * Builds a single Wizard item (one FCE) based on the
         * tab id, element id, configuration array and special
         * template identity (groupName:Relative/Path/File.html)
         *
         * @param string $tabId
         * @param string $id
         * @param Form $form
         * @param string $templateFileIdentity
         * @return string
         */
        protected function buildWizardTabItem($tabId, $id, $form, $templateFileIdentity) {
                if (TRUE === method_exists('FluidTYPO3\\Flux\\Utility\\MiscellaneousUtility', 'getIconForTemplate')) {
                        $icon = MiscellaneousUtility::getIconForTemplate($form);
                        $icon = ($icon ? $icon : $this->defaultIcon);
                } else {
                        $icon = $this->defaultIcon;
                }
                $description = $form->getDescription();
                if (0 === strpos($icon, '../')) {
                        $icon = substr($icon, 2);
                }

                $icon = '../' . $icon;

                return sprintf('
                        mod.wizards.newContentElement.wizardItems.%s.elements.%s {
                                icon = %s
                                title = %s
                                description = %s
                                tt_content_defValues {
                                        CType = fluidcontent_content
                                        tx_fed_fcefile = %s
                                }
                        }
                        ',
                        $tabId,
                        $id,
                        $icon,
                        $form->getLabel(),
                        $description,
                        $templateFileIdentity
                );
        }

        /**
         * @param string $string
         * @return string
         */
        protected function sanitizeString($string) {
                $pattern = '/([^a-z0-9\-]){1,}/i';
                $string = preg_replace($pattern, '-', $string);
                return trim($string, '-');
        }

        /**
         * @param string $templatePathAndFilename
         * @return void
         */
        protected function sendDisabledContentWarning($templatePathAndFilename) {
                $this->message('Disabled Fluid Content Element: ' . $templatePathAndFilename, GeneralUtility::SYSLOG_SEVERITY_NOTICE);
        }

}

1	<?php
2	namespace FluidTYPO3\Fluidcontent\Service;
3
4	/*
5	* This file is part of the FluidTYPO3/Fluidcontent project under GPLv2 or later.
6	*
7	* For the full copyright and license information, please read the
8	* LICENSE.md file that was distributed with this source code.
9	*/
10
11	use FluidTYPO3\Flux\Configuration\ConfigurationManager;
12	use FluidTYPO3\Flux\Core;
13	use FluidTYPO3\Flux\Form;
14	use FluidTYPO3\Flux\View\TemplatePaths;
15	use FluidTYPO3\Flux\View\ViewContext;
16	use FluidTYPO3\Flux\Service\FluxService;
17	use FluidTYPO3\Flux\Service\WorkspacesAwareRecordService;
18	use FluidTYPO3\Flux\Utility\ExtensionNamingUtility;
19	use FluidTYPO3\Flux\Utility\MiscellaneousUtility;
20	use TYPO3\CMS\Core\Cache\CacheManager;
21	use TYPO3\CMS\Core\Cache\Frontend\StringFrontend;
22	use TYPO3\CMS\Core\SingletonInterface;
23	use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
24	use TYPO3\CMS\Core\Utility\GeneralUtility;
25
26	/**
27	* Configuration Service
28	*
29	* Provides methods to read various configuration related
30	* to Fluid Content Elements.
31	*/
32	class ConfigurationService extends FluxService implements SingletonInterface {
33
34	/**
35	* Default Width for icon
36	*/
37	const ICON_WIDTH = '24m';
38
39	/**
40	* Default Height for icon
41	*/
42	const ICON_HEIGHT = '24m';
43
44	/**
45	* @var array
46	*/
47	protected $extConf;
48
49	/**
50	* @var CacheManager
51	*/
52	protected $manager;
53
54	/**
55	* @var WorkspacesAwareRecordService
56	*/
57	protected $recordService;
58
59	/**
60	* @var string
61	*/
62	protected $defaultIcon;
63
64	/**
65	* Storage for the current page UID to restore after this Service abuses
66	* ConfigurationManager to override the page UID used when resolving
67	* configurations for all TypoScript templates defined in the site.
68	*
69	* @var integer
70	*/
71	protected $pageUidBackup;
72
73	/**
74	* @param CacheManager $manager
75	* @return void
76	*/
77	public function injectCacheManager(CacheManager $manager) {
78	$this->manager = $manager;	1✔
79	}	1✔
80
81	/**
82	* @param WorkspacesAwareRecordService $recordService
83	* @return void
84	*/
85	public function injectRecordService(WorkspacesAwareRecordService $recordService) {
86	$this->recordService = $recordService;	1✔
87	}	1✔
88
89	/**
90	* Constructor
91	*/
92	public function __construct() {
93	$this->defaultIcon = '../' . ExtensionManagementUtility::siteRelPath('fluidcontent') . 'Resources/Public/Icons/Plugin.svg';	16✔
94
95	$this->extConf = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['fluidcontent']);	16✔
96	$this->extConf['iconWidth'] = $this->extConf['iconWidth'] ? : self::ICON_WIDTH;	16✔
97	$this->extConf['iconHeight'] = $this->extConf['iconHeight'] ? : self::ICON_HEIGHT;	16✔
98	}	16✔
99
100	/**
101	* @return string
102	*/
103	public function getDefaultIcon() {
104	return $this->defaultIcon;	2✔
105	}
106
107	/**
108	* @return boolean
109	*/
110	protected function isBackendMode() {
111	return ('BE' === TYPO3_MODE);	×
112	}
113
114	/**
115	* Get definitions of paths for FCEs defined in TypoScript
116	*
117	* @param string $extensionName
118	* @return array
119	* @api
120	*/
121	public function getContentConfiguration($extensionName = NULL) {
122	if (NULL !== $extensionName) {	6✔
123	return $this->getViewConfigurationForExtensionName($extensionName);	5✔
124	}
125	$registeredExtensionKeys = (array) Core::getRegisteredProviderExtensionKeys('Content');	2✔
126	$configuration = array();	2✔
127	foreach ($registeredExtensionKeys as $registeredExtensionKey) {	2✔
128	$configuration[$registeredExtensionKey] = $this->getContentConfiguration($registeredExtensionKey);	1✔
129	}	2✔
130	return $configuration;	2✔
131	}
132
133	/**
134	* @return string
135	*/
136	public function getPageTsConfig() {
137	$cache = $this->manager->getCache('fluidcontent');	×
138	if (!$cache->has('pageTsConfig')) {	×
139	$pageTsConfig = '';	×
140	$templates = $this->getAllRootTypoScriptTemplates();	×
141	$processed = array();	×
142	foreach ($templates as $template) {	×
143	$pageUid = (integer) $template['pid'];	×
144	if (isset($processed[$pageUid])) {	×
145	continue;	×
146	}
147	$pageTsConfig .= $this->renderPageTypoScriptForPageUid($pageUid);	×
148	$processed[$pageUid] = 1;	×
149	}	×
150	$cache->set('pageTsConfig', $pageTsConfig, array(), 86400);	×
151	}	×
152	return $cache->get('pageTsConfig');	×
153	}
154
155	/**
156	* Delegates to $this->getPageTsConfig() which pre-warms the cached TS
157	*
158	* @return void
159	*/
160	public function writeCachedConfigurationIfMissing() {
161	$this->getPageTsConfig();	×
162	}	×
163
164	/**
165	* @param $pageUid
166	* @return string
167	*/
168	protected function renderPageTypoScriptForPageUid($pageUid) {
169	$this->backupPageUidForConfigurationManager();	3✔
170	$this->overrideCurrentPageUidForConfigurationManager($pageUid);	3✔
171	$pageTsConfig = '';	3✔
172	try {
173	$collection = $this->getContentConfiguration();	3✔
174	$wizardTabs = $this->buildAllWizardTabGroups($collection);	2✔
175	$collectionPageTsConfig = $this->buildAllWizardTabsPageTsConfig($wizardTabs);	2✔
176	$pageTsConfig .= '[PIDinRootline = ' . strval($pageUid) . ']' . LF;	2✔
177	$pageTsConfig .= $collectionPageTsConfig . LF;	2✔
178	$pageTsConfig .= '[GLOBAL]' . LF;	2✔
179	$this->message('Built content setup for page ' . $pageUid, GeneralUtility::SYSLOG_SEVERITY_INFO, 'Fluidcontent');	2✔
180	} catch (\RuntimeException $error) {	3✔
181	$this->debug($error);	1✔
182	}
183	$this->restorePageUidForConfigurationManager();	3✔
184	return $pageTsConfig;	3✔
185	}
186
187	/**
188	* @param integer $newPageUid
189	* @return void
190	*/
191	protected function overrideCurrentPageUidForConfigurationManager($newPageUid) {
192	if (TRUE === $this->configurationManager instanceof ConfigurationManager) {	2✔
193	$this->configurationManager->setCurrentPageUid($newPageUid);	1✔
194	}	1✔
195	}	2✔
196
197	/**
198	* @return void
199	*/
200	protected function backupPageUidForConfigurationManager() {
201	if (TRUE === $this->configurationManager instanceof ConfigurationManager) {	4✔
202	$this->pageUidBackup = $this->configurationManager->getCurrentPageId();	1✔
203	}	1✔
204	}	4✔
205
206	/**
207	* @return void
208	*/
209	protected function restorePageUidForConfigurationManager() {
210	if (TRUE === $this->configurationManager instanceof ConfigurationManager) {	4✔
211	$this->configurationManager->setCurrentPageUid($this->pageUidBackup);	1✔
212	}	1✔
213	}	4✔
214
215	/**
216	* @return array
217	*/
218	protected function getAllRootTypoScriptTemplates() {
219	$condition = 'deleted = 0 AND hidden = 0 AND starttime <= :starttime AND (endtime = 0 OR endtime > :endtime)';	×
220	$parameters = array(
221	':starttime' => $GLOBALS['SIM_ACCESS_TIME'],	×
222	':endtime' => $GLOBALS['SIM_ACCESS_TIME']	×
223	);	×
224	$rootTypoScriptTemplates = $this->recordService->preparedGet('sys_template', 'pid', $condition, $parameters);	×
225	return $rootTypoScriptTemplates;	×
226	}
227
228	/**
229	* Scans all folders in $allTemplatePaths for template
230	* files, reads information about each file and collects
231	* the groups of files into groups of pageTSconfig setup.
232	*
233	* @param array $allTemplatePaths
234	* @return array
235	*/
236	protected function buildAllWizardTabGroups($allTemplatePaths) {
237	$wizardTabs = array();	1✔
238	$forms = $this->getContentElementFormInstances();	1✔
239	foreach ($forms as $extensionKey => $formSet) {	1✔
240	$formSet = $this->sortObjectsByProperty($formSet, 'options.Fluidcontent.sorting', 'ASC');	1✔
241	foreach ($formSet as $id => $form) {	1✔
242	/** @var Form $form */
243	$group = $form->getOption(Form::OPTION_GROUP);	1✔
244	if (TRUE === empty($group)) {	1✔
245	$group = 'Content';	1✔
246	}	1✔
247	$tabId = $this->sanitizeString($group);	1✔
248	$wizardTabs[$tabId]['title'] = $group;	1✔
249	$contentElementId = $form->getOption('contentElementId');	1✔
250	$elementTsConfig = $this->buildWizardTabItem($tabId, $id, $form, $contentElementId);	1✔
251	$wizardTabs[$tabId]['elements'][$id] = $elementTsConfig;	1✔
252	$wizardTabs[$tabId]['key'] = $extensionKey;	1✔
253	}	1✔
254	}	1✔
255	return $wizardTabs;	1✔
256	}
257
258	/**
259	* @return Form[][]
260	*/
261	public function getContentElementFormInstances() {
262	$elements = array();	3✔
263	$allTemplatePaths = $this->getContentConfiguration();	3✔
264	$controllerName = 'Content';	3✔
265	foreach ($allTemplatePaths as $registeredExtensionKey => $templatePathSet) {	3✔
266	$files = array();	2✔
267	$extensionKey = TRUE === isset($templatePathSet['extensionKey']) ? $templatePathSet['extensionKey'] : $registeredExtensionKey;	2✔
268	$extensionKey = ExtensionNamingUtility::getExtensionKey($extensionKey);	2✔
269	$templatePaths = new TemplatePaths($templatePathSet);	2✔
270	$viewContext = new ViewContext(NULL, $extensionKey);	2✔
271	$viewContext->setTemplatePaths($templatePaths);	2✔
272	$viewContext->setSectionName('Configuration');	2✔
273	foreach ($templatePaths->getTemplateRootPaths() as $templateRootPath) {	2✔
274	$files = GeneralUtility::getAllFilesAndFoldersInPath($files, $templateRootPath . '/' . $controllerName .'/', 'html');	2✔
275	if (0 < count($files)) {	2✔
276	foreach ($files as $templateFilename) {	2✔
277	$actionName = pathinfo($templateFilename, PATHINFO_FILENAME);	2✔
278	$fileRelPath = $actionName . '.html';	2✔
279	$viewContext->setTemplatePathAndFilename($templateFilename);	2✔
280	$form = $this->getFormFromTemplateFile($viewContext);	2✔
281	if (TRUE === empty($form)) {	2✔
282	$this->sendDisabledContentWarning($templateFilename);	2✔
283	continue;	2✔
284	}
285	if (FALSE === $form->getEnabled()) {	2✔
286	$this->sendDisabledContentWarning($templateFilename);	2✔
287	continue;	2✔
288	}
289	$id = preg_replace('/[\.\/]/', '_', $registeredExtensionKey . '/' . $actionName . '.html');	2✔
290	$form->setOption('contentElementId', $registeredExtensionKey . ':' . $fileRelPath);	2✔
291	$elements[$registeredExtensionKey][$id] = $form;	2✔
292	}	2✔
293	}	2✔
294	}	2✔
295	}	3✔
296	return $elements;	4✔
297	}
298
299	/**
300	* Builds a big piece of pageTSconfig setup, defining
301	* every detected content element's wizard tabs and items.
302	*
303	* @param array $wizardTabs
304	* @return string
305	*/
306	protected function buildAllWizardTabsPageTsConfig($wizardTabs) {
307	$pageTsConfig = '';	1✔
308	foreach ($wizardTabs as $tab) {	1✔
309	foreach ($tab['elements'] as $elementTsConfig) {	1✔
310	$pageTsConfig .= $elementTsConfig;	1✔
311	}	1✔
312	}	1✔
313	foreach ($wizardTabs as $tabId => $tab) {	1✔
314	$pageTsConfig .= sprintf('	1✔
315	mod.wizards.newContentElement.wizardItems.%s {
316	header = %s
317	show = %s
318	position = 0
319	key = %s
320	}
321	',	1✔
322	$tabId,	1✔
323	$tab['title'],	1✔
324	implode(',', array_keys($tab['elements'])),	1✔
325	$tab['key']	1✔
326	);	1✔
327	}	1✔
328	return $pageTsConfig;	1✔
329	}
330
331	/**
332	* Builds a single Wizard item (one FCE) based on the
333	* tab id, element id, configuration array and special
334	* template identity (groupName:Relative/Path/File.html)
335	*
336	* @param string $tabId
337	* @param string $id
338	* @param Form $form
339	* @param string $templateFileIdentity
340	* @return string
341	*/
342	protected function buildWizardTabItem($tabId, $id, $form, $templateFileIdentity) {
343	if (TRUE === method_exists('FluidTYPO3\\Flux\\Utility\\MiscellaneousUtility', 'getIconForTemplate')) {	2✔
344	$icon = MiscellaneousUtility::getIconForTemplate($form);	2✔
345	$icon = ($icon ? $icon : $this->defaultIcon);	2✔
346	} else {	2✔
347	$icon = $this->defaultIcon;	×
348	}
349	$description = $form->getDescription();	2✔
350	if (0 === strpos($icon, '../')) {	2✔
351	$icon = substr($icon, 2);	1✔
352	}	1✔
353
354	$icon = '../' . $icon;	2✔
355
356	return sprintf('	2✔
357	mod.wizards.newContentElement.wizardItems.%s.elements.%s {
358	icon = %s
359	title = %s
360	description = %s
361	tt_content_defValues {
362	CType = fluidcontent_content
363	tx_fed_fcefile = %s
364	}
365	}
366	',	2✔
367	$tabId,	2✔
368	$id,	2✔
369	$icon,	2✔
370	$form->getLabel(),	2✔
371	$description,	2✔
372	$templateFileIdentity
373	);	2✔
374	}
375
376	/**
377	* @param string $string
378	* @return string
379	*/
380	protected function sanitizeString($string) {
381	$pattern = '/([^a-z0-9\-]){1,}/i';	2✔
382	$string = preg_replace($pattern, '-', $string);	2✔
383	return trim($string, '-');	2✔
384	}
385
386	/**
387	* @param string $templatePathAndFilename
388	* @return void
389	*/
390	protected function sendDisabledContentWarning($templatePathAndFilename) {
391	$this->message('Disabled Fluid Content Element: ' . $templatePathAndFilename, GeneralUtility::SYSLOG_SEVERITY_NOTICE);	2✔
392	}	2✔
393
394	}

FluidTYPO3 / fluidcontent / 538

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous