Class Rule¶
abstract Class \Klitsche\Dog\Analyzer\Rule
- implements \Klitsche\Dog\Analyzer\RuleInterface
Methods¶
__construct()¶
public __construct (
string $id,
string $issueLevel,
array $match = []
):
- Parameters
- id
string
- issueLevel
string
- match
array
analyze()¶
public analyze (
\Klitsche\Dog\Elements\ElementInterface $element
): \Klitsche\Dog\Analyzer\Issue[]
- Parameters
- element
\Klitsche\Dog\Elements\ElementInterface
- Returns
\Klitsche\Dog\Analyzer\Issue[]
create()¶
public static create (
string $id,
string $issueLevel,
array $match = []
): self
- Parameters
- id
string
- issueLevel
string
- match
array
- Returns
self
getId()¶
public getId ( ): string
- Returns
string
matches()¶
public matches (
\Klitsche\Dog\Elements\ElementInterface $element
): bool
- Parameters
- element
\Klitsche\Dog\Elements\ElementInterface
- Returns
bool
Test Coverage 💚¶
- 💚 Lines: 93.33% (14 / 15)
- 💛 Methods: 80% (4 / 5)
Extended by¶
- \Klitsche\Dog\Analyzer\Rules\DocBlockApiNoDescriptionRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockApiNotInternalRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockApiVisibilityPublicRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockAuthorEmailRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockAuthorNameMissingRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockCopyrightMissingRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockCopyrightYearRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockDeprecatedCorrespondingSeeRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockDeprecatedDescriptionRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockDeprecatedVersionRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockDescriptionMissingRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockInvalidTagRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockLicenseMissingRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockLinkDescriptionRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockLinkMissingRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockLinkUrlRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockMethodAllowedRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockMissingRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockParamAllowedRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockParamDescriptionRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockParamNameOnlyOnceRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockParamTypeRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockParamUnknownRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockPropertyAllowedRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockReturnAllowedRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockReturnDescriptionRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockReturnOnlyOnceRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockSeeDescriptionRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockSinceDescriptionRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockSinceVersionRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockSummaryMissingRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockVersionDescriptionRule
- \Klitsche\Dog\Analyzer\Rules\DocBlockVersionVersionRule
- \Klitsche\Dog\Analyzer\Rules\TypeMissingRule