Skip to content

Tag reference

@phan-constructor-used-for-side-effects

The @phan-constructor-used-for-side-effects tag declares that a constructor’s return value is intentionally discarded by callers, suppressing the issue Phan would otherwise raise for an unused new expression.

Grammar

"@phan-constructor-used-for-side-effects" [ <Description> ]

Examples

A constructor called only for what it does.
/**
* @phan-constructor-used-for-side-effects
*/
public function __construct()

Names by platform

phan
@phan-constructor-used-for-side-effects

Parsing a @phan-constructor-used-for-side-effects tag produces a PhanConstructorUsedForSideEffectsTag instance. Being a pure marker, it adds nothing beyond the $name and optional $description every Tag already carries.

final class PhanConstructorUsedForSideEffectsTag extends FlagTag {}

See Phan’s Annotating Your Source Code wiki.