AbstractViewHelper::processTemplate() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/1.4'" - zikula/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2fb092...058edd )

by Craig

created 2017-01-08 19:21 UTC

AbstractViewHelper::processTemplate() C

↳ Parent: AbstractViewHelper

Complexity

Conditions	8
Paths	26

Size

Total Lines	41
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	24
nc	26
nop	4
dl	0
loc	41
rs	5.3846
c	0
b	0
f	0

<?php
/**
 * Routes.
 *
 * @copyright Zikula contributors (Zikula)
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
 * @author Zikula contributors <[email protected]>.
 * @link http://www.zikula.org
 * @link http://zikula.org
 * @version Generated by ModuleStudio 0.7.1 (http://modulestudio.de).
 */

namespace Zikula\RoutesModule\Helper\Base;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Templating\EngineInterface;
use Zikula\Core\Response\PlainResponse;
use Zikula\ExtensionsModule\Api\VariableApi;
use Zikula\PermissionsModule\Api\PermissionApi;
use Zikula\RoutesModule\Helper\ControllerHelper;

/**
 * Helper base class for view layer methods.
 */
abstract class AbstractViewHelper
{
    /**
     * @var EngineInterface
     */
    protected $templating;

    /**
     * @var Request
     */
    protected $request;

    /**
     * @var PermissionApi
     */
    protected $permissionApi;

    /**
     * @var VariableApi
     */
    protected $variableApi;

    /**
     * @var ControllerHelper
     */
    protected $controllerHelper;

    /**
     * ViewHelper constructor.
     *
     * @param EngineInterface  $templating       EngineInterface service instance
     * @param RequestStack     $requestStack     RequestStack service instance
     * @param PermissionApi    $permissionApi    PermissionApi service instance
     * @param VariableApi      $variableApi      VariableApi service instance
     * @param ControllerHelper $controllerHelper ControllerHelper service instance
     *
     * @return void

     */
    public function __construct(EngineInterface $templating, RequestStack $requestStack, PermissionApi $permissionApi, VariableApi $variableApi, ControllerHelper $controllerHelper)
    {
        $this->templating = $templating;
        $this->request = $requestStack->getCurrentRequest();
        $this->permissionApi = $permissionApi;
        $this->variableApi = $variableApi;
        $this->controllerHelper = $controllerHelper;
    }

    /**
     * Determines the view template for a certain method with given parameters.
     *
     * @param string $type Current controller (name of currently treated entity)
     * @param string $func Current function (index, view, ...)
     *
     * @return string name of template file
     */
    public function getViewTemplate($type, $func)
    {
        // create the base template name
        $template = '@ZikulaRoutesModule/' . ucfirst($type) . '/' . $func;
    
        // check for template extension
        $templateExtension = '.' . $this->determineExtension($type, $func);
    
        // check whether a special template is used
        $tpl = $this->request->query->getAlnum('tpl', '');
        if (!empty($tpl)) {
            // check if custom template exists
            $customTemplate = $template . ucfirst($tpl);
            if ($this->templating->exists($customTemplate . $templateExtension)) {
                $template = $customTemplate;
            }
        }
    
        $template .= $templateExtension;
    
        return $template;
    }

    /**
     * Helper method for managing view templates.
     *
     * @param string  $type               Current controller (name of currently treated entity)
     * @param string  $func               Current function (index, view, ...)
     * @param array   $templateParameters Template data
     * @param string  $template           Optional assignment of precalculated template file
     *
     * @return mixed Output
     */
    public function processTemplate($type, $func, array $templateParameters = [], $template = '')
    {
        $templateExtension = $this->determineExtension($type, $func);
        if (empty($template)) {
            $template = $this->getViewTemplate($type, $func);
        }
    
        if ($templateExtension == 'pdf.twig') {
            $template = str_replace('.pdf', '.html', $template);
    
            return $this->processPdf($templateParameters, $template);
        }
    
        // look whether we need output with or without the theme
        $raw = $this->request->query->getBoolean('raw', false);
        if (!$raw && $templateExtension != 'html.twig') {
            $raw = true;
        }
    
        $output = $this->templating->render($template, $templateParameters);
        $response = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        if (true === $raw) {
            // standalone output
            $response = new PlainResponse($output);
        } else {
            // normal output
            $response = new Response($output);
        }
    
        // check if we need to set any custom headers
        switch ($templateExtension) {
            case 'ics.twig':
                $response->headers->set('Content-Type', 'text/calendar; charset=utf-8');
                break;
            case 'kml.twig':
                $response->headers->set('Content-Type', 'application/vnd.google-earth.kml+xml');
                break;
        }
    
        return $response;
    }

    /**
     * Get extension of the currently treated template.
     *
     * @param string $type Current controller (name of currently treated entity)
     * @param string $func Current function (index, view, ...)
     *
     * @return array List of allowed template extensions
     */
    protected function determineExtension($type, $func)
    {
        $templateExtension = 'html.twig';
        if (!in_array($func, ['view', 'display'])) {
            return $templateExtension;
        }
    
        $extensions = $this->availableExtensions($type, $func);
        $format = $this->request->getRequestFormat();
        if ($format != 'html' && in_array($format, $extensions)) {
            $templateExtension = $format . '.twig';
        }
    
        return $templateExtension;
    }

    /**
     * Get list of available template extensions.
     *
     * @param string $type Current controller (name of currently treated entity)
     * @param string $func Current function (index, view, ...)
     *
     * @return array List of allowed template extensions
     */
    public function availableExtensions($type, $func)
    {
        $extensions = [];
        $hasAdminAccess = $this->permissionApi->hasPermission('ZikulaRoutesModule:' . ucfirst($type) . ':', '::', ACCESS_ADMIN);
        if ($func == 'view') {
            if ($hasAdminAccess) {
                $extensions = ['kml'];
            } else {
                $extensions = [];
            }
        } elseif ($func == 'display') {
            if ($hasAdminAccess) {
                $extensions = ['kml', 'ics'];
            } else {
                $extensions = ['ics'];
            }
        }
    
        return $extensions;
    }

    /**
     * Processes a template file using dompdf (LGPL).
     *
     * @param array  $templateParameters Template data
     * @param string $template           Name of template to use
     *
     * @return mixed Output
     */
    protected function processPdf(array $templateParameters = [], $template)
    {
        // first the content, to set page vars
        $output = $this->templating->render($template, $templateParameters);
    
        // make local images absolute
        $output = str_replace('img src="/', 'img src="' . $this->request->server->get('DOCUMENT_ROOT') . '/', $output);
    
        // see http://codeigniter.com/forums/viewthread/69388/P15/#561214
        //$output = utf8_decode($output);

    
        // then the surrounding
        $output = $this->templating->render('includePdfHeader.html.twig') . $output . '</body></html>';
    
        $siteName = $this->variableApi->getSystemVar('sitename');
    
        // create name of the pdf output file
        $fileTitle = $this->controllerHelper->formatPermalink($siteName)

                   . '-'
                   . $this->controllerHelper->formatPermalink(\PageUtil::getVar('title'))

                   . '-' . date('Ymd') . '.pdf';
    
        /*

        if (true === $this->request->query->getBoolean('dbg', false)) {
            die($output);
        }
        */
    
        // instantiate pdf object
        $pdf = new \DOMPDF();
        // define page properties
        $pdf->set_paper('A4');
        // load html input data
        $pdf->load_html($output);
        // create the actual pdf file
        $pdf->render();
        // stream output to browser
        $pdf->stream($fileTitle);
    
        return new Response(); 
    }
}


1			<?php
2			/**
3			* Routes.
4			*
5			* @copyright Zikula contributors (Zikula)
6			* @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
7			* @author Zikula contributors <[email protected]>.
8			* @link http://www.zikula.org
9			* @link http://zikula.org
10			* @version Generated by ModuleStudio 0.7.1 (http://modulestudio.de).
11			*/
12
13			namespace Zikula\RoutesModule\Helper\Base;
14
15			use Symfony\Component\HttpFoundation\Request;
16			use Symfony\Component\HttpFoundation\RequestStack;
17			use Symfony\Component\HttpFoundation\Response;
18			use Symfony\Component\Templating\EngineInterface;
19			use Zikula\Core\Response\PlainResponse;
20			use Zikula\ExtensionsModule\Api\VariableApi;
21			use Zikula\PermissionsModule\Api\PermissionApi;
22			use Zikula\RoutesModule\Helper\ControllerHelper;
23
24			/**
25			* Helper base class for view layer methods.
26			*/
27			abstract class AbstractViewHelper
28			{
29			/**
30			* @var EngineInterface
31			*/
32			protected $templating;
33
34			/**
35			* @var Request
36			*/
37			protected $request;
38
39			/**
40			* @var PermissionApi
41			*/
42			protected $permissionApi;
43
44			/**
45			* @var VariableApi
46			*/
47			protected $variableApi;
48
49			/**
50			* @var ControllerHelper
51			*/
52			protected $controllerHelper;
53
54			/**
55			* ViewHelper constructor.
56			*
57			* @param EngineInterface $templating EngineInterface service instance
58			* @param RequestStack $requestStack RequestStack service instance
59			* @param PermissionApi $permissionApi PermissionApi service instance
60			* @param VariableApi $variableApi VariableApi service instance
61			* @param ControllerHelper $controllerHelper ControllerHelper service instance
62			*
63			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2016-12-17 15:07 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
64			*/
65			public function __construct(EngineInterface $templating, RequestStack $requestStack, PermissionApi $permissionApi, VariableApi $variableApi, ControllerHelper $controllerHelper)
66			{
67			$this->templating = $templating;
68			$this->request = $requestStack->getCurrentRequest();
69			$this->permissionApi = $permissionApi;
70			$this->variableApi = $variableApi;
71			$this->controllerHelper = $controllerHelper;
72			}
73
74			/**
75			* Determines the view template for a certain method with given parameters.
76			*
77			* @param string $type Current controller (name of currently treated entity)
78			* @param string $func Current function (index, view, ...)
79			*
80			* @return string name of template file
81			*/
82			public function getViewTemplate($type, $func)
83			{
84			// create the base template name
85			$template = '@ZikulaRoutesModule/' . ucfirst($type) . '/' . $func;
86
87			// check for template extension
88			$templateExtension = '.' . $this->determineExtension($type, $func);
89
90			// check whether a special template is used
91			$tpl = $this->request->query->getAlnum('tpl', '');
92			if (!empty($tpl)) {
93			// check if custom template exists
94			$customTemplate = $template . ucfirst($tpl);
95			if ($this->templating->exists($customTemplate . $templateExtension)) {
96			$template = $customTemplate;
97			}
98			}
99
100			$template .= $templateExtension;
101
102			return $template;
103			}
104
105			/**
106			* Helper method for managing view templates.
107			*
108			* @param string $type Current controller (name of currently treated entity)
109			* @param string $func Current function (index, view, ...)
110			* @param array $templateParameters Template data
111			* @param string $template Optional assignment of precalculated template file
112			*
113			* @return mixed Output
114			*/
115			public function processTemplate($type, $func, array $templateParameters = [], $template = '')
116			{
117			$templateExtension = $this->determineExtension($type, $func);
118			if (empty($template)) {
119			$template = $this->getViewTemplate($type, $func);
120			}
121
122			if ($templateExtension == 'pdf.twig') {
123			$template = str_replace('.pdf', '.html', $template);
124
125			return $this->processPdf($templateParameters, $template);
126			}
127
128			// look whether we need output with or without the theme
129			$raw = $this->request->query->getBoolean('raw', false);
130			if (!$raw && $templateExtension != 'html.twig') {
131			$raw = true;
132			}
133
134			$output = $this->templating->render($template, $templateParameters);
135			$response = null;
			0 ignored issues – show Unused Code introduced 2016-12-17 15:07 UTC by Report Bug Copy Issue Report `$response` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
136			if (true === $raw) {
137			// standalone output
138			$response = new PlainResponse($output);
139			} else {
140			// normal output
141			$response = new Response($output);
142			}
143
144			// check if we need to set any custom headers
145			switch ($templateExtension) {
146			case 'ics.twig':
147			$response->headers->set('Content-Type', 'text/calendar; charset=utf-8');
148			break;
149			case 'kml.twig':
150			$response->headers->set('Content-Type', 'application/vnd.google-earth.kml+xml');
151			break;
152			}
153
154			return $response;
155			}
156
157			/**
158			* Get extension of the currently treated template.
159			*
160			* @param string $type Current controller (name of currently treated entity)
161			* @param string $func Current function (index, view, ...)
162			*
163			* @return array List of allowed template extensions
164			*/
165			protected function determineExtension($type, $func)
166			{
167			$templateExtension = 'html.twig';
168			if (!in_array($func, ['view', 'display'])) {
169			return $templateExtension;
170			}
171
172			$extensions = $this->availableExtensions($type, $func);
173			$format = $this->request->getRequestFormat();
174			if ($format != 'html' && in_array($format, $extensions)) {
175			$templateExtension = $format . '.twig';
176			}
177
178			return $templateExtension;
179			}
180
181			/**
182			* Get list of available template extensions.
183			*
184			* @param string $type Current controller (name of currently treated entity)
185			* @param string $func Current function (index, view, ...)
186			*
187			* @return array List of allowed template extensions
188			*/
189			public function availableExtensions($type, $func)
190			{
191			$extensions = [];
192			$hasAdminAccess = $this->permissionApi->hasPermission('ZikulaRoutesModule:' . ucfirst($type) . ':', '::', ACCESS_ADMIN);
193			if ($func == 'view') {
194			if ($hasAdminAccess) {
195			$extensions = ['kml'];
196			} else {
197			$extensions = [];
198			}
199			} elseif ($func == 'display') {
200			if ($hasAdminAccess) {
201			$extensions = ['kml', 'ics'];
202			} else {
203			$extensions = ['ics'];
204			}
205			}
206
207			return $extensions;
208			}
209
210			/**
211			* Processes a template file using dompdf (LGPL).
212			*
213			* @param array $templateParameters Template data
214			* @param string $template Name of template to use
215			*
216			* @return mixed Output
217			*/
218			protected function processPdf(array $templateParameters = [], $template)
219			{
220			// first the content, to set page vars
221			$output = $this->templating->render($template, $templateParameters);
222
223			// make local images absolute
224			$output = str_replace('img src="/', 'img src="' . $this->request->server->get('DOCUMENT_ROOT') . '/', $output);
225
226			// see http://codeigniter.com/forums/viewthread/69388/P15/#561214
227			//$output = utf8_decode($output);
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-12-17 15:07 UTC by Report Bug Copy Issue Report `56%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
228
229			// then the surrounding
230			$output = $this->templating->render('includePdfHeader.html.twig') . $output . '</body></html>';
231
232			$siteName = $this->variableApi->getSystemVar('sitename');
233
234			// create name of the pdf output file
235			$fileTitle = $this->controllerHelper->formatPermalink($siteName)
			0 ignored issues – show Deprecated Code introduced 2017-01-08 19:27 UTC by Report Bug Copy Issue Report The method `Zikula\RoutesModule\Help...lper::formatPermalink()` has been deprecated with message: made obsolete by Doctrine extensions This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
236			. '-'
237			. $this->controllerHelper->formatPermalink(\PageUtil::getVar('title'))
			0 ignored issues – show Deprecated Code introduced 2017-01-08 19:27 UTC by Report Bug Copy Issue Report The method `Zikula\RoutesModule\Help...lper::formatPermalink()` has been deprecated with message: made obsolete by Doctrine extensions This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
238			. '-' . date('Ymd') . '.pdf';
239
240			/*
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-01-08 19:27 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
241			if (true === $this->request->query->getBoolean('dbg', false)) {
242			die($output);
243			}
244			*/
245
246			// instantiate pdf object
247			$pdf = new \DOMPDF();
248			// define page properties
249			$pdf->set_paper('A4');
250			// load html input data
251			$pdf->load_html($output);
252			// create the actual pdf file
253			$pdf->render();
254			// stream output to browser
255			$pdf->stream($fileTitle);
256
257			return new Response();
258			}
259			}
260

zikula / core

Push — master ( 2fb092...058edd )

AbstractViewHelper::processTemplate() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like