ICalendarService::injectFluidStandaloneService() - Code Metrics - Inspection of "[TASK] Refactored DI for several services" - derhansen/sf_event_mgt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — development ( 178cf5...deb2fc )

by Torben

created 2017-12-27 18:42 UTC

ICalendarService::injectFluidStandaloneService() A

↳ Parent: ICalendarService

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	5
ccs	4
cts	4
cp	1
rs	9.4285
cc	1
eloc	3
nc	1
nop	1
crap	1

<?php
namespace DERHANSEN\SfEventMgt\Service;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use \TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Fluid\View\StandaloneView;
use \DERHANSEN\SfEventMgt\Exception;

/**
 * ICalenderService
 *
 * @author Torben Hansen <[email protected]>
 */
class ICalendarService
{
    /**
     * The object manager
     *
     * @var \TYPO3\CMS\Extbase\Object\ObjectManager
     */
    protected $objectManager;

    /**
     * The configuration manager
     *
     * @var \TYPO3\CMS\Extbase\Configuration\ConfigurationManager
     */
    protected $configurationManager;

    /**
     * ResourceFactory
     *
     * @var \TYPO3\CMS\Core\Resource\ResourceFactory
     */
    protected $resourceFactory = null;

    /**
     * FluidStandaloneService
     *
     * @var \DERHANSEN\SfEventMgt\Service\FluidStandaloneService
     */
    protected $fluidStandaloneService;

    /**
     * DI for $configurationManager
     *
     * @param \TYPO3\CMS\Extbase\Configuration\ConfigurationManager $configurationManager
     */
    public function injectConfigurationManager(
        \TYPO3\CMS\Extbase\Configuration\ConfigurationManager $configurationManager
    ) {
        $this->configurationManager = $configurationManager;
    }

    /**
     * DI for $fluidStandaloneService
     *
     * @param FluidStandaloneService $fluidStandaloneService
     */
    public function injectFluidStandaloneService(
        \DERHANSEN\SfEventMgt\Service\FluidStandaloneService $fluidStandaloneService
    ) {
        $this->fluidStandaloneService = $fluidStandaloneService;
    }

    /**
     * DI for $objectManager
     *
     * @param \TYPO3\CMS\Extbase\Object\ObjectManager $objectManager
     */
    public function injectObjectManager(\TYPO3\CMS\Extbase\Object\ObjectManager $objectManager)
    {
        $this->objectManager = $objectManager;
    }

    /**
     * DI for $resourceFactory
     *
     * @param \TYPO3\CMS\Core\Resource\ResourceFactory $resourceFactory
     */
    public function injectResourceFactory(\TYPO3\CMS\Core\Resource\ResourceFactory $resourceFactory)
    {
        $this->resourceFactory = $resourceFactory;
    }

    /**
     * Initiates the ICS download for the given event
     *
     * @param \DERHANSEN\SfEventMgt\Domain\Model\Event $event The event
     * @throws Exception Exception
     * @return void
     */
    public function downloadiCalendarFile(\DERHANSEN\SfEventMgt\Domain\Model\Event $event)
    {
        $storage = $this->resourceFactory->getDefaultStorage();
        if ($storage === null) {
            throw new Exception('Could not get the default storage', 1475590001);
        }
        $icalContent = $this->getICalendarContent($event);
        $tempFolder = $storage->getFolder('_temp_');
        $tempFile = $storage->createFile('event.ics', $tempFolder);
        $tempFile->setContents($icalContent);
        $storage->dumpFileContents($tempFile, true, 'event_' . $event->getUid() . '.ics');
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Returns the rendered iCalendar entry for the given event
     * according to RFC 2445
     *
     * @param \DERHANSEN\SfEventMgt\Domain\Model\Event $event The event
     *
     * @return string
     */
    public function getiCalendarContent(\DERHANSEN\SfEventMgt\Domain\Model\Event $event)
    {
        /** @var \TYPO3\CMS\Fluid\View\StandaloneView $icalView */
        $icalView = $this->objectManager->get(StandaloneView::class);
        $icalView->setFormat('txt');
        $layoutRootPaths = $this->fluidStandaloneService->getTemplateFolders('layout');
        $partialRootPaths = $this->fluidStandaloneService->getTemplateFolders('partial');
        $icalView->setLayoutRootPaths($layoutRootPaths);
        $icalView->setPartialRootPaths($partialRootPaths);
        $icalView->setTemplatePathAndFilename($this->fluidStandaloneService->getTemplatePath('Event/ICalendar.txt'));
        $icalView->assignMultiple([
            'event' => $event,
            'typo3Host' => GeneralUtility::getIndpEnv('TYPO3_HOST_ONLY')
        ]);
        // Render view and remove empty lines
        $icalContent = preg_replace('/^\h*\v+/m', '', $icalView->render());
        // Finally replace new lines with CRLF
        $icalContent = str_replace(chr(10), chr(13) . chr(10), $icalContent);
        return $icalContent;
    }
}


1		<?php
2		namespace DERHANSEN\SfEventMgt\Service;
3
4		/*
5		* This file is part of the TYPO3 CMS project.
6		*
7		* It is free software; you can redistribute it and/or modify it under
8		* the terms of the GNU General Public License, either version 2
9		* of the License, or any later version.
10		*
11		* For the full copyright and license information, please read the
12		* LICENSE.txt file that was distributed with this source code.
13		*
14		* The TYPO3 project - inspiring people to share!
15		*/
16
17		use \TYPO3\CMS\Core\Utility\GeneralUtility;
18		use TYPO3\CMS\Fluid\View\StandaloneView;
19		use \DERHANSEN\SfEventMgt\Exception;
20
21		/**
22		* ICalenderService
23		*
24		* @author Torben Hansen <[email protected]>
25		*/
26		class ICalendarService
27		{
28		/**
29		* The object manager
30		*
31		* @var \TYPO3\CMS\Extbase\Object\ObjectManager
32		*/
33		protected $objectManager;
34
35		/**
36		* The configuration manager
37		*
38		* @var \TYPO3\CMS\Extbase\Configuration\ConfigurationManager
39		*/
40		protected $configurationManager;
41
42		/**
43		* ResourceFactory
44		*
45		* @var \TYPO3\CMS\Core\Resource\ResourceFactory
46		*/
47		protected $resourceFactory = null;
48
49		/**
50		* FluidStandaloneService
51		*
52		* @var \DERHANSEN\SfEventMgt\Service\FluidStandaloneService
53		*/
54		protected $fluidStandaloneService;
55
56		/**
57		* DI for $configurationManager
58		*
59		* @param \TYPO3\CMS\Extbase\Configuration\ConfigurationManager $configurationManager
60		*/
61		public function injectConfigurationManager(
62		\TYPO3\CMS\Extbase\Configuration\ConfigurationManager $configurationManager
63		) {
64		$this->configurationManager = $configurationManager;
65		}
66
67		/**
68	2	* DI for $fluidStandaloneService
69		*
70	2	* @param FluidStandaloneService $fluidStandaloneService
71	2	*/
72	1	public function injectFluidStandaloneService(
73		\DERHANSEN\SfEventMgt\Service\FluidStandaloneService $fluidStandaloneService
74	1	) {
75	1	$this->fluidStandaloneService = $fluidStandaloneService;
76	1	}
77	1
78	1	/**
79	1	* DI for $objectManager
80		*
81		* @param \TYPO3\CMS\Extbase\Object\ObjectManager $objectManager
82		*/
83		public function injectObjectManager(\TYPO3\CMS\Extbase\Object\ObjectManager $objectManager)
84		{
85		$this->objectManager = $objectManager;
86		}
87
88		/**
89	1	* DI for $resourceFactory
90		*
91		* @param \TYPO3\CMS\Core\Resource\ResourceFactory $resourceFactory
92	1	*/
93	1	public function injectResourceFactory(\TYPO3\CMS\Core\Resource\ResourceFactory $resourceFactory)
94	1	{
95	1	$this->resourceFactory = $resourceFactory;
96		}
97	1
98	1	/**
99	1	* Initiates the ICS download for the given event
100	1	*
101	1	* @param \DERHANSEN\SfEventMgt\Domain\Model\Event $event The event
102	1	* @throws Exception Exception
103	1	* @return void
104		*/
105	1	public function downloadiCalendarFile(\DERHANSEN\SfEventMgt\Domain\Model\Event $event)
106		{
107	1	$storage = $this->resourceFactory->getDefaultStorage();
108	1	if ($storage === null) {
109		throw new Exception('Could not get the default storage', 1475590001);
110		}
111		$icalContent = $this->getICalendarContent($event);
112		$tempFolder = $storage->getFolder('_temp_');
113		$tempFile = $storage->createFile('event.ics', $tempFolder);
114		$tempFile->setContents($icalContent);
115		$storage->dumpFileContents($tempFile, true, 'event_' . $event->getUid() . '.ics');
		0 ignored issues – show Bug introduced 2017-07-02 05:21 UTC by Report Bug Copy Issue Report It seems like `$tempFile` defined by `$storage->createFile('event.ics', $tempFolder)` on line `113` can also be of type `null`; however, `TYPO3\CMS\Core\Resource\...age::dumpFileContents()` does only seem to accept `object<TYPO3\CMS\Core\Resource\FileInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
116		}
117
118		/**
119		* Returns the rendered iCalendar entry for the given event
120		* according to RFC 2445
121		*
122		* @param \DERHANSEN\SfEventMgt\Domain\Model\Event $event The event
123		*
124		* @return string
125		*/
126		public function getiCalendarContent(\DERHANSEN\SfEventMgt\Domain\Model\Event $event)
127		{
128		/** @var \TYPO3\CMS\Fluid\View\StandaloneView $icalView */
129		$icalView = $this->objectManager->get(StandaloneView::class);
130		$icalView->setFormat('txt');
131		$layoutRootPaths = $this->fluidStandaloneService->getTemplateFolders('layout');
132		$partialRootPaths = $this->fluidStandaloneService->getTemplateFolders('partial');
133		$icalView->setLayoutRootPaths($layoutRootPaths);
134		$icalView->setPartialRootPaths($partialRootPaths);
135		$icalView->setTemplatePathAndFilename($this->fluidStandaloneService->getTemplatePath('Event/ICalendar.txt'));
136		$icalView->assignMultiple([
137		'event' => $event,
138		'typo3Host' => GeneralUtility::getIndpEnv('TYPO3_HOST_ONLY')
139		]);
140		// Render view and remove empty lines
141		$icalContent = preg_replace('/^\h*\v+/m', '', $icalView->render());
142		// Finally replace new lines with CRLF
143		$icalContent = str_replace(chr(10), chr(13) . chr(10), $icalContent);
144		return $icalContent;
145		}
146		}
147

derhansen / sf_event_mgt

Push — development ( 178cf5...deb2fc )

ICalendarService::injectFluidStandaloneService() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like