PageFields::metaBox() - Code Metrics - Inspection of "Added default message for new empty pages" - LIN3S/WPFoundation - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d43673...9c9fd4 )

by Beñat

created 2015-12-10 11:21 UTC

PageFields::metaBox() A

↳ Parent: PageFields

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	8
rs	9.4286
cc	1
eloc	4
nc	1
nop	2

<?php

/*
 * This file is part of the WPFoundation library.
 *
 * Copyright (c) 2015 LIN3S <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace LIN3S\WPFoundation\PostTypes\Fields\Templates;

use LIN3S\WPFoundation\PostTypes\Fields\Fields;

/**
 * Abstract page fields class that extends the fields basic
 * behaviour, implementing the "connector" and "removeScreenAttributes"
 * methods with the common use case.
 *
 * @author Beñat Espiña <[email protected]>
 */
abstract class PageFields extends Fields
{
    /**
     * Constructor.
     */
    public function __construct()
    {
        parent::__construct();

        $newPostId = filter_input(INPUT_GET, 'post', FILTER_SANITIZE_NUMBER_INT);
        $updatePostId = filter_input(INPUT_POST, 'post_ID', FILTER_SANITIZE_NUMBER_INT);

        if (isset($newPostId)) {
            $postId = absint($newPostId);
        } elseif (isset($updatePostId)) {
            $postId = absint($updatePostId);
        }
        if (false === isset($postId) || $this->name === get_post_meta($postId, '_wp_page_template', true)) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            add_action('add_meta_boxes', [$this, 'addMetaBox']);

            add_action('admin_init', [$this, 'removeScreenAttributes']);

        }
    }

    /**
     * {@inheritdoc}
     */
    public function connector()

    {
        return [
            [
                [
                    'param'    => 'post_type',
                    'operator' => '==',
                    'value'    => 'page',
                ],
                [
                    'param'    => 'page_template',
                    'operator' => '==',
                    'value'    => $this->name,
                ],
            ],
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function removeScreenAttributes()
    {
        remove_post_type_support('page', 'comments');

        remove_post_type_support('page', 'custom-fields');

        remove_post_type_support('page', 'editor');

    }

    /**
     * Callback that adds the meta box.
     */
    protected function addMetaBox()
    {
        add_meta_box(
            'lin3s-id-default-meta-box',
            'LIN3S INFO',
            [$this, 'metaBox'],
            'page'
        );
    }

    /**
     * Callback that prints the meta box.
     *
     * @param mixed  $post The post
     * @param string $box  The box
     */
    protected function metaBox($post, $box)

    {
        echo <<<EOF
<h1 style="text-align: center;">
    PLEASE ADD <strong>PAGE TITLE</strong> AND SELECT A TEMPLATE IN THE <strong>TEMPLATE SELECTOR</strong>
</h1>
EOF;
    }
}


1		<?php
2
3		/*
4		* This file is part of the WPFoundation library.
5		*
6		* Copyright (c) 2015 LIN3S <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace LIN3S\WPFoundation\PostTypes\Fields\Templates;
13
14		use LIN3S\WPFoundation\PostTypes\Fields\Fields;
15
16		/**
17		* Abstract page fields class that extends the fields basic
18		* behaviour, implementing the "connector" and "removeScreenAttributes"
19		* methods with the common use case.
20		*
21		* @author Beñat Espiña <[email protected]>
22		*/
23		abstract class PageFields extends Fields
24		{
25		/**
26		* Constructor.
27		*/
28		public function __construct()
29		{
30		parent::__construct();
31
32		$newPostId = filter_input(INPUT_GET, 'post', FILTER_SANITIZE_NUMBER_INT);
33		$updatePostId = filter_input(INPUT_POST, 'post_ID', FILTER_SANITIZE_NUMBER_INT);
34
35		if (isset($newPostId)) {
36		$postId = absint($newPostId);
37		} elseif (isset($updatePostId)) {
38		$postId = absint($updatePostId);
39		}
40		if (false === isset($postId) \|\| $this->name === get_post_meta($postId, '_wp_page_template', true)) {
		0 ignored issues – show Bug introduced 2015-12-10 10:35 UTC by Report Bug Copy Issue Report The variable `$postId` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
41		add_action('add_meta_boxes', [$this, 'addMetaBox']);
		0 ignored issues – show Unused Code introduced 2015-12-10 11:33 UTC by Report Bug Copy Issue Report The call to the function `add_action()` seems unnecessary as the function has no side-effects. Loading history...
42		add_action('admin_init', [$this, 'removeScreenAttributes']);
		0 ignored issues – show Unused Code introduced 2015-11-21 16:59 UTC by Report Bug Copy Issue Report The call to the function `add_action()` seems unnecessary as the function has no side-effects. Loading history...
43		}
44		}
45
46		/**
47		* {@inheritdoc}
48		*/
49	View Code Duplication	public function connector()
		0 ignored issues – show Duplication introduced 2015-11-30 11:27 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
50		{
51		return [
52		[
53		[
54		'param' => 'post_type',
55		'operator' => '==',
56		'value' => 'page',
57		],
58		[
59		'param' => 'page_template',
60		'operator' => '==',
61		'value' => $this->name,
62		],
63		],
64		];
65		}
66
67		/**
68		* {@inheritdoc}
69		*/
70		public function removeScreenAttributes()
71		{
72		remove_post_type_support('page', 'comments');
		0 ignored issues – show Unused Code introduced 2015-12-10 10:35 UTC by Report Bug Copy Issue Report The call to `remove_post_type_support()` has too many arguments starting with `'page'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history... Unused Code introduced 2015-12-10 10:35 UTC by Report Bug Copy Issue Report The call to the function `remove_post_type_support()` seems unnecessary as the function has no side-effects. Loading history...
73		remove_post_type_support('page', 'custom-fields');
		0 ignored issues – show Unused Code introduced 2015-12-10 10:35 UTC by Report Bug Copy Issue Report The call to `remove_post_type_support()` has too many arguments starting with `'page'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history... Unused Code introduced 2015-12-10 10:35 UTC by Report Bug Copy Issue Report The call to the function `remove_post_type_support()` seems unnecessary as the function has no side-effects. Loading history...
74		remove_post_type_support('page', 'editor');
		0 ignored issues – show Unused Code introduced 2015-12-10 10:35 UTC by Report Bug Copy Issue Report The call to `remove_post_type_support()` has too many arguments starting with `'page'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history... Unused Code introduced 2015-12-10 10:35 UTC by Report Bug Copy Issue Report The call to the function `remove_post_type_support()` seems unnecessary as the function has no side-effects. Loading history...
75		}
76
77		/**
78		* Callback that adds the meta box.
79		*/
80		protected function addMetaBox()
81		{
82		add_meta_box(
83		'lin3s-id-default-meta-box',
84		'LIN3S INFO',
85		[$this, 'metaBox'],
86		'page'
87		);
88		}
89
90		/**
91		* Callback that prints the meta box.
92		*
93		* @param mixed $post The post
94		* @param string $box The box
95		*/
96		protected function metaBox($post, $box)
		0 ignored issues – show Unused Code introduced 2015-12-10 11:33 UTC by Report Bug Copy Issue Report The parameter `$post` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2015-12-10 11:33 UTC by Report Bug Copy Issue Report The parameter `$box` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
97		{
98		echo <<<EOF
99		<h1 style="text-align: center;">
100		PLEASE ADD <strong>PAGE TITLE</strong> AND SELECT A TEMPLATE IN THE <strong>TEMPLATE SELECTOR</strong>
101		</h1>
102		EOF;
103		}
104		}
105

LIN3S / WPFoundation

Push — master ( d43673...9c9fd4 )

PageFields::metaBox() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like