PageView::getType() - Code Metrics - Inspection of "Restructure core namespaces for the projects" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3442f8...f4ff57 )

by Vladimir

created 2017-03-25 04:27 UTC

PageView::getType() A

↳ Parent: PageView

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

/**
 * @copyright 2017 Vladimir Jimenez
 * @license   https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
 */

namespace allejo\stakx\Document;

use allejo\stakx\FrontMatter\Document;
use allejo\stakx\System\Filesystem;
use allejo\stakx\System\StakxResource;
use org\bovigo\vfs\vfsStream;
use org\bovigo\vfs\vfsStreamWrapper;
use Symfony\Component\Yaml\Yaml;

class PageView extends Document
{
    const REPEATER_TYPE = 0;
    const DYNAMIC_TYPE = 1;
$a = "a";
$ab = "ab";
$abc = "abc";
    const STATIC_TYPE = 2;
$a = "a";
$ab = "ab";
$abc = "abc";

    /**
     * @var Filesystem
     */
    private static $fileSys;

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

    /**
     * @var PageView[]
     */
    private $children;

    /**
     * @var JailedDocument
     */
    private $jailInstance;

    /**
     * {@inheritdoc}
     */
    public function __construct($filePath)
    {
        parent::__construct($filePath);

        $this->children = array();
        $this->type = self::STATIC_TYPE;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
    }

    //
    // Twig Jail
    // =========

    /**
     * {@inheritdoc}
     */
    public function createJail()
    {
        if (is_null($this->jailInstance))
        {
            $this->jailInstance = (new JailedDocument($this, array_merge(self::$whiteListFunctions, array(
                'getUrl',
            )), array('getChildren' => 'getJailedChildren')));
        }

        return $this->jailInstance;
    }

    public function getJailedChildren()
    {
        $children = $this->children;

        foreach ($children as &$child)
        {
            $child = $child->createJail();
        }

        return $children;
    }

    //
    // Getters
    // =======

    /**
     * Get child PageViews.
     *
     * A child is defined as a static PageView whose URL has a parent. For example, a PageView with a URL of
     * `/gallery/france/` would have the PageView whose URL is `/gallery` as a parent.
     *
     * @return PageView[]
     */
    public function &getChildren()
    {
        return $this->children;
    }

    /**
     * @return string Twig body
     */
    public function getContent()
    {
        return $this->bodyContent;
    }

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

    /**
     * A fallback for the site menus that use the `url` field.
     *
     * @deprecated 0.1.0
     *
     * @todo       Remove this in the next major release
     */
    public function getUrl()
    {
        return $this->getPermalink();
    }

    //
    // Factory
    // =======

    /**
     * Create the appropriate object type when parsing a PageView.
     *
     * @param string $filePath The path to the file that will be parsed into a PageView
     *
     * @return DynamicPageView|PageView|RepeaterPageView
     */
    public static function create($filePath)
    {
        $instance = new self($filePath);

        if (isset($instance->getFrontMatter(false)['collection']))
        {
            return new DynamicPageView($filePath);
        }

        $instance->getFrontMatter();

        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 PageView
     */
    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());

        return new self($redirectFile->url());
    }

    /**
     * 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 PageView A virtual PageView with the redirection template
     */
    public static function createRedirect($redirectFrom, $redirectTo, $redirectTemplate = false)
    {
        if (is_null(self::$fileSys))
        {
            self::$fileSys = new Filesystem();
        }

        $frontMatter = array(
            'permalink' => $redirectFrom,
            'redirect'  => $redirectTo,
            'menu'      => false,
        );

        if (!$redirectTemplate || !self::$fileSys->exists(self::$fileSys->absolutePath($redirectTemplate)))
        {
            $contentItemBody = StakxResource::getResource('redirect.html.twig');
        }
        else
        {
            $contentItemBody = file_get_contents(self::$fileSys->absolutePath($redirectTemplate));
        }

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


1		<?php
2
3		/**
4		* @copyright 2017 Vladimir Jimenez
5		* @license https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
6		*/
7
8		namespace allejo\stakx\Document;
9
10		use allejo\stakx\FrontMatter\Document;
11		use allejo\stakx\System\Filesystem;
12		use allejo\stakx\System\StakxResource;
13		use org\bovigo\vfs\vfsStream;
14		use org\bovigo\vfs\vfsStreamWrapper;
15		use Symfony\Component\Yaml\Yaml;
16
17		class PageView extends Document
18		{
19		const REPEATER_TYPE = 0;
20		const DYNAMIC_TYPE = 1;
		0 ignored issues – show Coding Style introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
21		const STATIC_TYPE = 2;
		0 ignored issues – show Coding Style introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
22
23		/**
24		* @var Filesystem
25		*/
26		private static $fileSys;
27
28		/**
29		* @var string
30		*/
31		protected $type;
32
33		/**
34		* @var PageView[]
35		*/
36		private $children;
37
38		/**
39		* @var JailedDocument
40		*/
41		private $jailInstance;
42
43		/**
44		* {@inheritdoc}
45		*/
46	31	public function __construct($filePath)
47		{
48	31	parent::__construct($filePath);
49
50	31	$this->children = array();
51	31	$this->type = self::STATIC_TYPE;
		0 ignored issues – show Documentation Bug introduced 2017-03-22 09:58 UTC by Report Bug Copy Issue Report The property `$type` was declared of type `string`, but `self::STATIC_TYPE` is of type `integer`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history... Coding Style introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
52	31	}
53
54		//
55		// Twig Jail
56		// =========
57
58		/**
59		* {@inheritdoc}
60		*/
61	24	public function createJail()
62		{
63	24	if (is_null($this->jailInstance))
64		{
65	24	$this->jailInstance = (new JailedDocument($this, array_merge(self::$whiteListFunctions, array(
66	24	'getUrl',
67	24	)), array('getChildren' => 'getJailedChildren')));
68		}
69
70	24	return $this->jailInstance;
71		}
72
73	3	public function getJailedChildren()
74		{
75	3	$children = $this->children;
76
77	3	foreach ($children as &$child)
78		{
79	3	$child = $child->createJail();
80		}
81
82	3	return $children;
83		}
84
85		//
86		// Getters
87		// =======
88
89		/**
90		* Get child PageViews.
91		*
92		* A child is defined as a static PageView whose URL has a parent. For example, a PageView with a URL of
93		* `/gallery/france/` would have the PageView whose URL is `/gallery` as a parent.
94		*
95		* @return PageView[]
96		*/
97	3	public function &getChildren()
98		{
99	3	return $this->children;
100		}
101
102		/**
103		* @return string Twig body
104		*/
105	13	public function getContent()
106		{
107	13	return $this->bodyContent;
108		}
109
110		/**
111		* Returns the type of the PageView.
112		*
113		* @return string
114		*/
115	19	public function getType()
116		{
117	19	return $this->type;
118		}
119
120		/**
121		* A fallback for the site menus that use the `url` field.
122		*
123		* @deprecated 0.1.0
124		*
125		* @todo Remove this in the next major release
126		*/
127		public function getUrl()
128		{
129		return $this->getPermalink();
130		}
131
132		//
133		// Factory
134		// =======
135
136		/**
137		* Create the appropriate object type when parsing a PageView.
138		*
139		* @param string $filePath The path to the file that will be parsed into a PageView
140		*
141		* @return DynamicPageView\|PageView\|RepeaterPageView
142		*/
143	6	public static function create($filePath)
144		{
145	6	$instance = new self($filePath);
146
147	6	if (isset($instance->getFrontMatter(false)['collection']))
148		{
149	4	return new DynamicPageView($filePath);
150		}
151
152	2	$instance->getFrontMatter();
153
154	2	if ($instance->hasExpandedFrontMatter())
155		{
156		return new RepeaterPageView($filePath);
157		}
158
159	2	return $instance;
160		}
161
162		//
163		// Virtual PageViews
164		// =================
165
166		/**
167		* Create a virtual PageView.
168		*
169		* @param array $frontMatter The Front Matter that this virtual PageView will have
170		* @param string $body The body of the virtual PageView
171		*
172		* @return PageView
173		*/
174	4	public static function createVirtual($frontMatter, $body)
175		{
176	4	if (vfsStreamWrapper::getRoot() == null)
177		{
178		vfsStream::setup();
179		}
180
181	4	$redirectFile = vfsStream::newFile(sprintf('redirect_%s.html.twig', uniqid()));
182		$redirectFile
183	4	->setContent(sprintf(self::TEMPLATE, Yaml::dump($frontMatter, 2), $body))
184	4	->at(vfsStreamWrapper::getRoot());
185
186	4	return new self($redirectFile->url());
187		}
188
189		/**
190		* Create a virtual PageView to create redirect files.
191		*
192		* @param string $redirectFrom The URL that will be redirecting to the target location
193		* @param string $redirectTo The URL of the destination
194		* @param string\|bool $redirectTemplate The path to the template
195		*
196		* @return PageView A virtual PageView with the redirection template
197		*/
198	4	public static function createRedirect($redirectFrom, $redirectTo, $redirectTemplate = false)
199		{
200	4	if (is_null(self::$fileSys))
201		{
202	1	self::$fileSys = new Filesystem();
203		}
204
205		$frontMatter = array(
206	4	'permalink' => $redirectFrom,
207	4	'redirect' => $redirectTo,
208		'menu' => false,
209		);
210
211	4	if (!$redirectTemplate \|\| !self::$fileSys->exists(self::$fileSys->absolutePath($redirectTemplate)))
212		{
213	4	$contentItemBody = StakxResource::getResource('redirect.html.twig');
214		}
215		else
216		{
217		$contentItemBody = file_get_contents(self::$fileSys->absolutePath($redirectTemplate));
218		}
219
220	4	return self::createVirtual($frontMatter, $contentItemBody);
221		}
222		}
223

stakx-io / stakx

Push — master ( 3442f8...f4ff57 )

PageView::getType() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like