BasePageView::getType() - Code Metrics - Inspection of "Let's get sassy" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#69)

by Vladimir

created 2018-06-26 06:21 UTC

BasePageView::getType() A

↳ Parent: BasePageView

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
rs	10
ccs	0
cts	2
cp	0
cc	1
nc	1
nop	0
crap	2

<?php

/**
 * @copyright 2018 Vladimir Jimenez
 * @license   https://github.com/stakx-io/stakx/blob/master/LICENSE.md MIT
 */

namespace allejo\stakx\Document;

use allejo\stakx\Filesystem\File;
use allejo\stakx\Filesystem\FilesystemLoader as fs;
use org\bovigo\vfs\vfsStream;
use org\bovigo\vfs\vfsStreamWrapper;
use Symfony\Component\Yaml\Yaml;

abstract class BasePageView extends PermalinkFrontMatterDocument implements PermalinkDocument
{
    use TemplateEngineDependent;

    const REPEATER_TYPE = 'repeater';
    const DYNAMIC_TYPE = 'dynamic';
    const STATIC_TYPE = 'static';

    protected $type;

    /**
     * Returns the type of PageView.
     *
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    ///
    // Static utilities
    ///

    /**
     * Create the appropriate object type when parsing a PageView.
     *
     * @return DynamicPageView|StaticPageView|RepeaterPageView
     */
    public static function create(File $filePath, array $complexVariables = [])
    {
        $instance = new StaticPageView($filePath);

        if (isset($instance->getRawFrontMatter()['collection']) ||
            isset($instance->getRawFrontMatter()['dataset'])
        ) {
            return new DynamicPageView($filePath);
        }

        $instance->evaluateFrontMatter([], $complexVariables);

        if ($instance->hasExpandedFrontMatter())
        {
            return new RepeaterPageView($filePath);
        }

        return $instance;
    }

    ///
    // Virtual PageViews
    ///

    /**
     * Create a virtual PageView.
     *
     * @param array  $frontMatter The Front Matter that this virtual PageView will have
     * @param string $body        The body of the virtual PageView
     *
     * @return StaticPageView
     */
    public static function createVirtual($frontMatter, $body)
    {
        if (vfsStreamWrapper::getRoot() == null)
        {
            vfsStream::setup();
        }

        $redirectFile = vfsStream::newFile(sprintf('redirect_%s.html.twig', uniqid()));
        $redirectFile
            ->setContent(sprintf(self::TEMPLATE, Yaml::dump($frontMatter, 2), $body))
            ->at(vfsStreamWrapper::getRoot())
        ;

        $file = new File($redirectFile->url());

        return new StaticPageView($file);
    }

    /**
     * Create a virtual PageView to create redirect files.
     *
     * @param string      $redirectFrom     The URL that will be redirecting to the target location
     * @param string      $redirectTo       The URL of the destination
     * @param string|bool $redirectTemplate The path to the template
     *
     * @return StaticPageView A virtual PageView with the redirection template
     */
    public static function createRedirect($redirectFrom, $redirectTo, $redirectTemplate = false)
    {
        $frontMatter = [
            'permalink' => $redirectFrom,
            'redirect' => $redirectTo,
            'menu' => false,
        ];

        $contentItemBody = fs::getInternalResource('redirect.html.twig');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        try
        {
            if (!empty($redirectTemplate))
            {
                $redirectView = new File($redirectTemplate);

                $contentItemBody = $redirectView->getContents();
            }
        }
        catch (\Exception $e)
        {
            trigger_error($e->getMessage(), E_USER_WARNING);
        }

        return self::createVirtual($frontMatter, $contentItemBody);
    }
}


1			<?php
2
3			/**
4			* @copyright 2018 Vladimir Jimenez
5			* @license https://github.com/stakx-io/stakx/blob/master/LICENSE.md MIT
6			*/
7
8			namespace allejo\stakx\Document;
9
10			use allejo\stakx\Filesystem\File;
11			use allejo\stakx\Filesystem\FilesystemLoader as fs;
12			use org\bovigo\vfs\vfsStream;
13			use org\bovigo\vfs\vfsStreamWrapper;
14			use Symfony\Component\Yaml\Yaml;
15
16			abstract class BasePageView extends PermalinkFrontMatterDocument implements PermalinkDocument
17			{
18			use TemplateEngineDependent;
19
20			const REPEATER_TYPE = 'repeater';
21			const DYNAMIC_TYPE = 'dynamic';
22			const STATIC_TYPE = 'static';
23
24			protected $type;
25
26			/**
27			* Returns the type of PageView.
28			*
29			* @return string
30			*/
31			public function getType()
32			{
33			return $this->type;
34			}
35
36			///
37			// Static utilities
38			///
39
40			/**
41			* Create the appropriate object type when parsing a PageView.
42			*
43			* @return DynamicPageView\|StaticPageView\|RepeaterPageView
44			*/
45			public static function create(File $filePath, array $complexVariables = [])
46			{
47			$instance = new StaticPageView($filePath);
48
49			if (isset($instance->getRawFrontMatter()['collection']) \|\|
50			isset($instance->getRawFrontMatter()['dataset'])
51			) {
52			return new DynamicPageView($filePath);
53			}
54
55			$instance->evaluateFrontMatter([], $complexVariables);
56
57			if ($instance->hasExpandedFrontMatter())
58			{
59			return new RepeaterPageView($filePath);
60			}
61
62			return $instance;
63			}
64
65			///
66			// Virtual PageViews
67			///
68
69			/**
70			* Create a virtual PageView.
71			*
72			* @param array $frontMatter The Front Matter that this virtual PageView will have
73			* @param string $body The body of the virtual PageView
74			*
75			* @return StaticPageView
76			*/
77			public static function createVirtual($frontMatter, $body)
78			{
79			if (vfsStreamWrapper::getRoot() == null)
80			{
81			vfsStream::setup();
82			}
83
84			$redirectFile = vfsStream::newFile(sprintf('redirect_%s.html.twig', uniqid()));
85			$redirectFile
86			->setContent(sprintf(self::TEMPLATE, Yaml::dump($frontMatter, 2), $body))
87			->at(vfsStreamWrapper::getRoot())
88			;
89
90			$file = new File($redirectFile->url());
91
92			return new StaticPageView($file);
93			}
94
95			/**
96			* Create a virtual PageView to create redirect files.
97			*
98			* @param string $redirectFrom The URL that will be redirecting to the target location
99			* @param string $redirectTo The URL of the destination
100			* @param string\|bool $redirectTemplate The path to the template
101			*
102			* @return StaticPageView A virtual PageView with the redirection template
103			*/
104			public static function createRedirect($redirectFrom, $redirectTo, $redirectTemplate = false)
105			{
106			$frontMatter = [
107			'permalink' => $redirectFrom,
108			'redirect' => $redirectTo,
109			'menu' => false,
110			];
111
112			$contentItemBody = fs::getInternalResource('redirect.html.twig');
			0 ignored issues – show Documentation introduced 2018-05-10 07:09 UTC by Report Bug Copy Issue Report `'redirect.html.twig'` is of type `string`, but the function expects a `object<string>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
113
114			try
115			{
116			if (!empty($redirectTemplate))
117			{
118			$redirectView = new File($redirectTemplate);
			0 ignored issues – show Bug introduced 2018-05-10 07:09 UTC by Report Bug Copy Issue Report It seems like `$redirectTemplate` defined by parameter `$redirectTemplate` on line 104 can also be of type `boolean`; however, `allejo\stakx\Filesystem\File::__construct()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
119			$contentItemBody = $redirectView->getContents();
120			}
121			}
122			catch (\Exception $e)
123			{
124			trigger_error($e->getMessage(), E_USER_WARNING);
125			}
126
127			return self::createVirtual($frontMatter, $contentItemBody);
128			}
129			}
130

stakx-io / stakx

Pull Request — master (#69)

BasePageView::getType() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like