Issues (20)

Security Analysis    no request data  

This project does not seem to handle request data directly as such no vulnerable execution paths were found.

  Cross-Site Scripting
Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.
  File Exposure
File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.
  File Manipulation
File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.
  Object Injection
Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.
  Code Injection
Code Injection enables an attacker to execute arbitrary code on the server.
  Response Splitting
Response Splitting can be used to send arbitrary responses.
  File Inclusion
File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.
  Command Injection
Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.
  SQL Injection
SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.
  XPath Injection
XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.
  LDAP Injection
LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.
  Header Injection
  Other Vulnerability
This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.
  Regex Injection
Regex Injection enables an attacker to execute arbitrary code in your PHP process.
  XML Injection
XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.
  Variable Injection
Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.
Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

Form.php (16 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
namespace Amarkal\Taxonomy;
4
5
/**
6
 * WordPress taxonomy form utilities
7
 */
8
class Form
9
{
10
    /**
11
     * @var Singleton The reference to *Singleton* instance of this class
12
     */
13
    private static $instance;
14
    
15
    /**
16
     * @var Array Stores a form for each taxonomy
17
     */
18
    private $forms = array();
19
    
20
    /**
21
     * Returns the *Singleton* instance of this class.
22
     *
23
     * @return Singleton The *Singleton* instance.
24
     */
25
    public static function get_instance()
26
    {
27
        if( null === static::$instance ) 
0 ignored issues
show
Since $instance is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $instance to at least protected.

Let’s assume you have a class which uses late-static binding:

class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}

The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the getSomeVariable() on that sub-class, you will receive a runtime error:

class YourSubClass extends YourClass { }

YourSubClass::getSomeVariable(); // Will cause an access error.

In the case above, it makes sense to update SomeClass to use self instead:

class SomeClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return self::$someVariable; // self works fine with private.
    }
}
Loading history...
28
        {
29
            static::$instance = new static();
0 ignored issues
show
Since $instance is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $instance to at least protected.

Let’s assume you have a class which uses late-static binding:

class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}

The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the getSomeVariable() on that sub-class, you will receive a runtime error:

class YourSubClass extends YourClass { }

YourSubClass::getSomeVariable(); // Will cause an access error.

In the case above, it makes sense to update SomeClass to use self instead:

class SomeClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return self::$someVariable; // self works fine with private.
    }
}
Loading history...
Documentation Bug introduced by
It seems like new static() of type this<Amarkal\Taxonomy\Form> is incompatible with the declared type object<Amarkal\Taxonomy\Singleton> of property $instance.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
30
        }
31
        return static::$instance;
0 ignored issues
show
Since $instance is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $instance to at least protected.

Let’s assume you have a class which uses late-static binding:

class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}

The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the getSomeVariable() on that sub-class, you will receive a runtime error:

class YourSubClass extends YourClass { }

YourSubClass::getSomeVariable(); // Will cause an access error.

In the case above, it makes sense to update SomeClass to use self instead:

class SomeClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return self::$someVariable; // self works fine with private.
    }
}
Loading history...
Bug Compatibility introduced by
The expression static::$instance; of type Amarkal\Taxonomy\Form|Amarkal\Taxonomy\Singleton adds the type Amarkal\Taxonomy\Form to the return on line 31 which is incompatible with the return type documented by Amarkal\Taxonomy\Form::get_instance of type Amarkal\Taxonomy\Singleton.
Loading history...
32
    }
33
    
34
    /**
35
     * Add a form field to both the add & edit forms for a given taxonomy.
36
     * 
37
     * @param string $taxonomy_name
38
     * @param array $component
39
     * @throws \RuntimeException if duplicate names are registered under the same taxonomy
40
     */
41
    public function add_field( $taxonomy_name, $component )
42
    {
43
        if( !isset($this->forms[$taxonomy_name]) )
44
        {
45
            // Add fields to taxonomy add and edit forms 
46
            add_action( "{$taxonomy_name}_add_form_fields", array($this, 'render_add_form') );
47
            add_action( "{$taxonomy_name}_edit_form_fields", array($this, 'render_edit_form') );
48
            
49
            // Save the data from taxonomy add and edit forms
50
            add_action( "create_{$taxonomy_name}", array($this, 'update_term') );
51
            add_action( "edited_{$taxonomy_name}", array($this, 'update_term') );
52
            
53
            // Modify the taxonomy term table
54
            add_filter( "manage_edit-{$taxonomy_name}_columns", array($this, 'modify_table_columns') );
55
            add_filter( "manage_{$taxonomy_name}_custom_column", array($this, 'modify_table_content'), 10, 3 );
56
            add_filter( "manage_edit-{$taxonomy_name}_sortable_columns", array($this, 'modify_table_sortable_columns') );
57
            add_filter( 'terms_clauses', array($this, 'sort_custom_column'), 10, 3 );
58
            
59
            $this->forms[$taxonomy_name] = new \Amarkal\UI\Form();
60
        }
61
        
62
        $this->forms[$taxonomy_name]->add_component(
63
            array_merge( $this->default_props(), $component )
64
        );
65
    }
66
    
67
    /**
68
     * Render the 'edit term' form for a given taxonomy
69
     * 
70
     * @param object $term Taxonomy term
71
     */
72
    public function render_edit_form( $term )
73
    {
74
        $form = $this->forms[$term->taxonomy];
75
        $new_instance = array();
76
        
77
        foreach( $form->get_components() as $component )
78
        {
79
            $new_instance[$component->name] = \get_term_meta($term->term_id, $component->name, true);
80
        }
81
        
82
        $form->update($new_instance);
83
        
84
        include __DIR__.'/EditForm.phtml';
85
    }
86
    
87
    /**
88
     * Render the 'add new term' form for a given taxonomy
89
     * 
90
     * @param string $taxonomy Taxonomy name
91
     */
92
    public function render_add_form( $taxonomy )
93
    {
94
        $form = $this->forms[$taxonomy];
95
        $form->update();
96
        
97
        include __DIR__.'/AddForm.phtml';
98
    }
99
    
100
    /**
101
     * Update the meta values for a given term. Called once one of the add/edit
102
     * forms is saved.
103
     * 
104
     * @param type $term_id
105
     */
106
    function update_term( $term_id ) 
0 ignored issues
show
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
107
    {
108
        $term = \get_term( $term_id );
109
        
110
        foreach( $this->forms[$term->taxonomy]->get_components() as $component )
111
        {
112
            $term_meta = filter_input(INPUT_POST, $component->name);
113
            if( null !== $term_meta )
114
            {
115
                \update_term_meta($term_id, $component->name, $term_meta);
116
            }
117
        }
118
    }
119
    
120
    /**
121
     * Add additional columns to the term table.
122
     * 
123
     * @param array $columns
124
     * @return array
125
     */
126 View Code Duplication
    function modify_table_columns( $columns )
0 ignored issues
show
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
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...
127
    {   
128
        $this->traverse_components(function( $taxonomy, $component ) use ( &$columns ) 
0 ignored issues
show
function ($taxonomy, $co...mponent->title; } } is of type object<Closure>, but the function expects a object<Amarkal\Taxonomy\collable>.

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...
129
        {
130
            if( $component->table['show'] )
131
            {
132
                $columns[$component->name] = $component->title;
133
            }
134
        });
135
        return $columns;
136
    }
137
    
138
    /**
139
     * Retrieve the data for a given column in the term table.
140
     * 
141
     * @see https://developer.wordpress.org/reference/hooks/manage_this-screen-taxonomy_custom_column/
142
     * 
143
     * @param type $content
144
     * @param type $column_name
145
     * @param type $term_id
146
     * @return type
147
     */
148
    function modify_table_content( $content, $column_name, $term_id )
0 ignored issues
show
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
149
    {   
150
        $term = \get_term($term_id);
151
        $this->traverse_components(function( $taxonomy, $component ) use ( &$content, $column_name, $term ) 
0 ignored issues
show
function ($taxonomy, $co...t->name, true); } } is of type object<Closure>, but the function expects a object<Amarkal\Taxonomy\collable>.

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...
152
        {
153
            if( $component->table['show'] && 
154
                $term->taxonomy === $taxonomy &&
155
                $component->name === $column_name
156
            ) {
157
                $content = \get_term_meta($term->term_id, $component->name, true);
158
            }
159
        });
160
        return $content;
161
    }
162
    
163
    /**
164
     * Make custom table columns sortable.
165
     * 
166
     * @param array $columns
167
     * @return string
168
     */
169 View Code Duplication
    function modify_table_sortable_columns( $columns )
0 ignored issues
show
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
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...
170
    {
171
        $this->traverse_components(function( $taxonomy, $component ) use ( &$columns ) 
0 ignored issues
show
function ($taxonomy, $co...omponent->name; } } is of type object<Closure>, but the function expects a object<Amarkal\Taxonomy\collable>.

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...
172
        {
173
            if( $component->table['show'] && 
174
                $component->table['sortable']
175
            ) {
176
                $columns[$component->name] = $component->name;
177
            }
178
        });
179
        return $columns;
180
    }
181
    
182
    /**
183
     * Modify terms_clauses to allow sorting custom WordPress Admin Table Columns by a custom Taxonomy Term meta
184
     * 
185
     * @see https://developer.wordpress.org/reference/hooks/terms_clauses/
186
     * 
187
     * @global type $wpdb
188
     * @param type $clauses
189
     * @param type $taxonomies
190
     * @param type $args
191
     * @return string
192
     */
193
    public function sort_custom_column( $clauses, $taxonomies, $args )
194
    {
195
        $this->traverse_components(function( $taxonomy, $component ) use ( &$clauses, $args ) 
0 ignored issues
show
function ($taxonomy, $co...tm.meta_value'; } } is of type object<Closure>, but the function expects a object<Amarkal\Taxonomy\collable>.

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...
196
        {
197
            if( in_array($taxonomy, $args['taxonomy']) && 
198
                $component->table['sortable'] &&
199
                $component->name === $args['orderby']
200
            )
201
            {
202
                global $wpdb;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
203
                // tt refers to the $wpdb->term_taxonomy table
204
                $clauses['join'] .= " LEFT JOIN {$wpdb->termmeta} AS tm ON t.term_id = tm.term_id";
205
                $clauses['where'] = "tt.taxonomy = '{$taxonomy}' AND (tm.meta_key = '{$component->name}' OR tm.meta_key IS NULL)";
206
                $clauses['orderby'] = "ORDER BY tm.meta_value";
207
            }
208
        });
209
        return $clauses;
210
    }
211
    
212
    /**
213
     * The default form field properties. This is merged with the user given 
214
     * properties. When the component is rendered, this will be merged with the
215
     * component's properties as well.
216
     * 
217
     * @return array
218
     */
219
    private function default_props()
220
    {
221
        return array(
222
            'type'          => null,
223
            'title'         => null,
224
            'description'   => null,
225
            'table'         => array(
226
                'show'      => false,
227
                'sortable'  => false
228
            )
229
        );
230
    }
231
    
232
    /**
233
     * Treverse the $fields array.
234
     * 
235
     * @param collable $callback Called on each iteration
236
     */
237
    private function traverse_components( $callback )
238
    {
239
        foreach( $this->forms as $taxonomy => $form )
240
        {
241
            foreach( $form->get_components() as $component )
242
            {
243
                $callback( $taxonomy, $component );
244
            }
245
        }
246
    }
247
}