PagesRender::getAlternates() - Code Metrics - Inspection of "Fix excluded alternates" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — collection-position ( 636ee4...426961 )

by Arnaud

created 2019-04-01 16:24 UTC

PagesRender::getAlternates() A

↳ Parent: PagesRender

Complexity

Conditions	5
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	18
rs	9.3554
c	0
b	0
f	0
cc	5
nc	2
nop	1

<?php
/*
 * Copyright (c) Arnaud Ligny <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cecil\Step;

use Cecil\Collection\Page\Page;
use Cecil\Exception\Exception;
use Cecil\Renderer\Layout;
use Cecil\Renderer\Twig;

/**
 * Pages rendering.
 */
class PagesRender extends AbstractStep
{
    /**
     * {@inheritdoc}
     *
     * @throws Exception
     */
    public function init($options)
    {
        if (!is_dir($this->config->getLayoutsPath()) && !$this->config->hasTheme()) {
            throw new Exception(sprintf(
                "'%s' is not a valid layouts directory",
                $this->config->getLayoutsPath()
            ));
        }

        $this->process = true;
    }

    /**
     * {@inheritdoc}
     *
     * @throws Exception
     */
    public function process()
    {
        // prepares renderer
        $this->builder->setRenderer(new Twig($this->getAllLayoutsPaths(), $this->builder));

        // add globals variables
        $this->addGlobals();

        call_user_func_array($this->builder->getMessageCb(), ['RENDER', 'Rendering pages']);

        // collect published pages
        /* @var $page Page */
        $filteredPages = $this->builder->getPages()->filter(function (Page $page) {
            return !empty($page->getVariable('published'));
        });
        $max = count($filteredPages);

        // render each page
        $count = 0;
        /* @var $page Page */
        foreach ($filteredPages as $page) {
            $count++;
            $formats = ['html'];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            $rendered = null;
            $alternates = [];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

            // get page's output formats
            $formats = $this->getOutputFormats($page);
            $page->setVariable('output', $formats);

            // excluded format(s)?
            foreach ($formats as $key => $format) {
                if ($exclude = $this->config->get("site.output.formats.$format.exclude")) {
                    // ie:
                    //   formats:
                    //     atom:
                    //       [...]
                    //       exclude: [paginated]
                    foreach ($exclude as $variable) {
                        if ($page->hasVariable($variable)) {
                            unset($formats[$key]);
                        }
                    }
                }
            }

            // get alternates links
            $alternates = $this->getAlternates($formats);
            $page->setVariable('alternates', $alternates);

            // render each output format
            foreach ($formats as $format) {
                // search for the template
                $layout = Layout::finder($page, $format, $this->config);
                // render with Twig
                try {
                    $rendered[$format]['output'] = $this->builder->getRenderer()->render(
                        $layout,
                        ['page' => $page]
                    );
                    $rendered[$format]['template'] = $layout;
                } catch (\Exception $e) {
                    throw new Exception(sprintf(
                        "Error in template \"%s\" for page \"%s\":\n%s",
                        $layout,
                        $page->getId(),
                        $e->getMessage()
                    ));
                }
            }
            $page->setVariable('rendered', $rendered);
            $this->builder->getPages()->replace($page->getId(), $page);

            $layouts = implode(', ', array_column($rendered, 'template'));
            $message = sprintf('%s [%s]', ($page->getId() ?: 'index'), $layouts);
            call_user_func_array($this->builder->getMessageCb(), ['RENDER_PROGRESS', $message, $count, $max]);
        }
    }

    /**
     * Return an array of layouts directories.
     *
     * @return array
     */
    protected function getAllLayoutsPaths(): array
    {
        $paths = [];

        // layouts/
        if (is_dir($this->config->getLayoutsPath())) {
            $paths[] = $this->config->getLayoutsPath();
        }
        // <theme>/layouts/
        if ($this->config->hasTheme()) {
            $themes = $this->config->getTheme();
            foreach ($themes as $theme) {
                $paths[] = $this->config->getThemeDirPath($theme);
            }
        }
        // res/layouts/
        if (is_dir($this->config->getInternalLayoutsPath())) {
            $paths[] = $this->config->getInternalLayoutsPath();
        }

        return $paths;
    }

    /**
     * Add globals variables.
     */
    protected function addGlobals()
    {
        // adds global variables
        $this->builder->getRenderer()->addGlobal('site', array_merge(
            $this->config->get('site'),
            ['menus' => $this->builder->getMenus()],
            ['pages' => $this->builder->getPages()->filter(function (Page $page) {
                return $page->getVariable('published');
            })],
            ['time' => time()]
        ));
        $this->builder->getRenderer()->addGlobal('cecil', [
            'url'       => sprintf('https://cecil.app/#%s', $this->builder->getVersion()),
            'version'   => $this->builder->getVersion(),
            'poweredby' => sprintf('Cecil v%s', $this->builder->getVersion()),
        ]);
    }

    /**
     * Get available output formats.
     *
     * @param Page $page
     *
     * @return array
     */
    protected function getOutputFormats(Page $page): array
    {
        $formats = [];

        // get available output formats for the page type
        // ie: "'page' => ['html', 'json']"
        if (\is_array($this->config->get('site.output.pagetypeformats.'.$page->getType()))) {
            $formats = $this->config->get('site.output.pagetypeformats.'.$page->getType());
        }
        // Get page output format(s).
        // ie: "output: txt"
        if ($page->getVariable('output')) {
            $formats = $page->getVariable('output');
            if (!\is_array($formats)) {
                $formats = [$formats];
            }
        }

        return $formats;
    }

    /**
     * Get alternates.
     *
     * @param array $formats
     *
     * @return array
     */
    protected function getAlternates(array $formats): array
    {
        $alternates = [];

        if (count($formats) > 1 && in_array('html', $formats)) {
            foreach ($formats as $format) {
                $format == 'html' ? $rel = 'canonical' : $rel = 'alternate';
                $alternates[] = [
                    'rel'    => $rel,
                    'type'   => $this->config->get("site.output.formats.$format.mediatype"),
                    'title'  => strtoupper($format),
                    'format' => $format,
                ];
            }
        }

        return $alternates;
    }
}


1			<?php
2			/*
3			* Copyright (c) Arnaud Ligny <[email protected]>
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*/
8
9			namespace Cecil\Step;
10
11			use Cecil\Collection\Page\Page;
12			use Cecil\Exception\Exception;
13			use Cecil\Renderer\Layout;
14			use Cecil\Renderer\Twig;
15
16			/**
17			* Pages rendering.
18			*/
19			class PagesRender extends AbstractStep
20			{
21			/**
22			* {@inheritdoc}
23			*
24			* @throws Exception
25			*/
26			public function init($options)
27			{
28			if (!is_dir($this->config->getLayoutsPath()) && !$this->config->hasTheme()) {
29			throw new Exception(sprintf(
30			"'%s' is not a valid layouts directory",
31			$this->config->getLayoutsPath()
32			));
33			}
34
35			$this->process = true;
36			}
37
38			/**
39			* {@inheritdoc}
40			*
41			* @throws Exception
42			*/
43			public function process()
44			{
45			// prepares renderer
46			$this->builder->setRenderer(new Twig($this->getAllLayoutsPaths(), $this->builder));
47
48			// add globals variables
49			$this->addGlobals();
50
51			call_user_func_array($this->builder->getMessageCb(), ['RENDER', 'Rendering pages']);
52
53			// collect published pages
54			/* @var $page Page */
55			$filteredPages = $this->builder->getPages()->filter(function (Page $page) {
56			return !empty($page->getVariable('published'));
57			});
58			$max = count($filteredPages);
59
60			// render each page
61			$count = 0;
62			/* @var $page Page */
63			foreach ($filteredPages as $page) {
64			$count++;
65			$formats = ['html'];
			0 ignored issues – show Unused Code introduced 2019-02-12 00:25 UTC by Report Bug Copy Issue Report `$formats` 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...
66			$rendered = null;
67			$alternates = [];
			0 ignored issues – show Unused Code introduced 2019-02-12 00:25 UTC by Report Bug Copy Issue Report `$alternates` 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...
68
69			// get page's output formats
70			$formats = $this->getOutputFormats($page);
71			$page->setVariable('output', $formats);
72
73			// excluded format(s)?
74			foreach ($formats as $key => $format) {
75			if ($exclude = $this->config->get("site.output.formats.$format.exclude")) {
76			// ie:
77			// formats:
78			// atom:
79			// [...]
80			// exclude: [paginated]
81			foreach ($exclude as $variable) {
82			if ($page->hasVariable($variable)) {
83			unset($formats[$key]);
84			}
85			}
86			}
87			}
88
89			// get alternates links
90			$alternates = $this->getAlternates($formats);
91			$page->setVariable('alternates', $alternates);
92
93			// render each output format
94			foreach ($formats as $format) {
95			// search for the template
96			$layout = Layout::finder($page, $format, $this->config);
97			// render with Twig
98			try {
99			$rendered[$format]['output'] = $this->builder->getRenderer()->render(
100			$layout,
101			['page' => $page]
102			);
103			$rendered[$format]['template'] = $layout;
104			} catch (\Exception $e) {
105			throw new Exception(sprintf(
106			"Error in template \"%s\" for page \"%s\":\n%s",
107			$layout,
108			$page->getId(),
109			$e->getMessage()
110			));
111			}
112			}
113			$page->setVariable('rendered', $rendered);
114			$this->builder->getPages()->replace($page->getId(), $page);
115
116			$layouts = implode(', ', array_column($rendered, 'template'));
117			$message = sprintf('%s [%s]', ($page->getId() ?: 'index'), $layouts);
118			call_user_func_array($this->builder->getMessageCb(), ['RENDER_PROGRESS', $message, $count, $max]);
119			}
120			}
121
122			/**
123			* Return an array of layouts directories.
124			*
125			* @return array
126			*/
127			protected function getAllLayoutsPaths(): array
128			{
129			$paths = [];
130
131			// layouts/
132			if (is_dir($this->config->getLayoutsPath())) {
133			$paths[] = $this->config->getLayoutsPath();
134			}
135			// <theme>/layouts/
136			if ($this->config->hasTheme()) {
137			$themes = $this->config->getTheme();
138			foreach ($themes as $theme) {
139			$paths[] = $this->config->getThemeDirPath($theme);
140			}
141			}
142			// res/layouts/
143			if (is_dir($this->config->getInternalLayoutsPath())) {
144			$paths[] = $this->config->getInternalLayoutsPath();
145			}
146
147			return $paths;
148			}
149
150			/**
151			* Add globals variables.
152			*/
153			protected function addGlobals()
154			{
155			// adds global variables
156			$this->builder->getRenderer()->addGlobal('site', array_merge(
157			$this->config->get('site'),
158			['menus' => $this->builder->getMenus()],
159			['pages' => $this->builder->getPages()->filter(function (Page $page) {
160			return $page->getVariable('published');
161			})],
162			['time' => time()]
163			));
164			$this->builder->getRenderer()->addGlobal('cecil', [
165			'url' => sprintf('https://cecil.app/#%s', $this->builder->getVersion()),
166			'version' => $this->builder->getVersion(),
167			'poweredby' => sprintf('Cecil v%s', $this->builder->getVersion()),
168			]);
169			}
170
171			/**
172			* Get available output formats.
173			*
174			* @param Page $page
175			*
176			* @return array
177			*/
178			protected function getOutputFormats(Page $page): array
179			{
180			$formats = [];
181
182			// get available output formats for the page type
183			// ie: "'page' => ['html', 'json']"
184			if (\is_array($this->config->get('site.output.pagetypeformats.'.$page->getType()))) {
185			$formats = $this->config->get('site.output.pagetypeformats.'.$page->getType());
186			}
187			// Get page output format(s).
188			// ie: "output: txt"
189			if ($page->getVariable('output')) {
190			$formats = $page->getVariable('output');
191			if (!\is_array($formats)) {
192			$formats = [$formats];
193			}
194			}
195
196			return $formats;
197			}
198
199			/**
200			* Get alternates.
201			*
202			* @param array $formats
203			*
204			* @return array
205			*/
206			protected function getAlternates(array $formats): array
207			{
208			$alternates = [];
209
210			if (count($formats) > 1 && in_array('html', $formats)) {
211			foreach ($formats as $format) {
212			$format == 'html' ? $rel = 'canonical' : $rel = 'alternate';
213			$alternates[] = [
214			'rel' => $rel,
215			'type' => $this->config->get("site.output.formats.$format.mediatype"),
216			'title' => strtoupper($format),
217			'format' => $format,
218			];
219			}
220			}
221
222			return $alternates;
223			}
224			}
225

Cecilapp / Cecil

Push — collection-position ( 636ee4...426961 )

PagesRender::getAlternates() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like