Page MenuHomeWickedGov Phorge
Files F4148165

NoEmptyIfDefinedVisitor.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

NoEmptyIfDefinedVisitor.php
View Options

<?php
declare( strict_types=1 );
namespace MediaWikiPhanConfig\Plugin;
use ast\Node;
use Phan\AST\ASTReverter;
use Phan\AST\ContextNode;
use Phan\AST\PhanAnnotationAdder;
use Phan\AST\UnionTypeVisitor;
use Phan\Exception\IssueException;
use Phan\Exception\NodeException;
use Phan\Exception\UnanalyzableException;
use Phan\PluginV3\PluginAwarePostAnalysisVisitor;
use const ast\AST_DIM;
use const ast\AST_PROP;
use const ast\AST_STATIC_PROP;
class NoEmptyIfDefinedVisitor extends PluginAwarePostAnalysisVisitor {
/**
* @inheritDoc
*/
public function visitEmpty( Node $node ): void {
if ( $this->context->isInGlobalScope() ) {
// Bail out immediately to avoid any chance of fun false positives.
return;
}
$expr = $node->children['expr'];
if ( !$expr instanceof Node || !$this->exprIsPossiblyUndefined( $expr ) ) {
self::emitPluginIssue(
$this->code_base,
$this->context,
NoEmptyIfDefinedPlugin::ISSUE_TYPE,
// Links to https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP#empty()
'Found usage of {FUNCTIONLIKE} on expression {CODE} that appears to be always set. ' .
'{FUNCTIONLIKE} should only be used to suppress errors. See https://w.wiki/6paE',
[ 'empty()', ASTReverter::toShortString( $expr ), 'empty()' ]
);
}
}
private function exprIsPossiblyUndefined( Node $expr ): bool {
if ( $expr->kind === AST_DIM ) {
// Skip this case, because it's a lesser issue even if the array element is guaranteed to be set, and also,
// it's not possible to analyze it properly given the FLAG_IGNORE_UNDEF trickery below.
return true;
}
if ( $expr->kind === AST_PROP || $expr->kind === AST_STATIC_PROP ) {
try {
$property = ( new ContextNode(
$this->code_base,
$this->context,
$expr
) )->getProperty( $expr->kind === AST_STATIC_PROP );
} catch ( IssueException | NodeException | UnanalyzableException $_ ) {
// Bail out if the expr is a property that phan can't resolve. In this scenario the union type will
// be empty, but not possibly undefined, yet we shouldn't emit an issue.
return true;
}
if ( $property->getClass( $this->code_base )->hasDynamicProperties( $this->code_base ) ) {
// stdClass or another class with dynamic properties. These are always possibly undefined.
return true;
}
}
$prevIgnoreUndefFlag = $expr->flags & PhanAnnotationAdder::FLAG_IGNORE_UNDEF;
try {
$expr->flags &= ~PhanAnnotationAdder::FLAG_IGNORE_UNDEF;
$type = UnionTypeVisitor::unionTypeFromNode(
$this->code_base,
$this->context,
$expr,
false
);
} catch ( IssueException $_ ) {
// Ignore, because we're removing FLAG_IGNORE_UNDEF in a hacky way.
return true;
} finally {
$expr->flags |= $prevIgnoreUndefFlag;
}
return $type->isPossiblyUndefined();
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 19 2026, 18:40 (6 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
57/35/3fe6f44e2b51fa9ac26fab1af547
Default Alt Text
NoEmptyIfDefinedVisitor.php (2 KB)

Event Timeline