VIP-Coding-Standards icon indicating copy to clipboard operation
VIP-Coding-Standards copied to clipboard

Bump VariableAnalysis to ^2.9.0 to allow use of the backported options

Open GaryJones opened this issue 5 years ago • 0 comments
trafficstars

What problem would the enhancement address for VIP?

When template partials are require'd from within a class, then the partial may use $this-> to insert display a value. At PHP runtime, it works, but for PHPCS analysis, it sees a PHP file with an undefined $this and so reports it via the VariableAnalysis package. Technically it's correct, and while it could be ignored, it's not practical or desirable to do that.

Describe the solution you'd like

VariableAnalysis 2.9.0 includes two new options that can control whether these violations are raised. I'd like to have VIPCS require this update in package, so to be able to make use of these options in the default configuration of VIPCS.

VIPCS currently requires ^2.8.3, so we'd need to bump the minimum version.

What code should be reported as a violation?

What code should not be reported as a violation?

Don't report on $this:

<?php
// Example foo.php template.

if ( ! empty( $this->vars['video-id'] ) ) {
	echo '<video...></video>';
}

Don't report on $args (new feature in WP 5.5):

<?php
// Example foo.php template.
 
// Set defaults.
$args = wp_parse_args(
    $args,
    array(
        'class'          => '',
        'arbitrary_data' => array(
            'foo' => 'fooval',
            'bar' => false,
        ),
        ...
    )
);
?>
 
<div class="widget <?php echo esc_html_class( $args['class'] ); ?>">
    <?php echo esc_html( $args['arbitrary_data']['foo'] ); ?>
</div>

GaryJones avatar Oct 12 '20 11:10 GaryJones