API Documentation
\
Horde
Refactor
Config
Exception
Rule

\Horde\Refactor\ConfigFileLevelDocBlock

Configuration for the FileLevelDocBlock refactoring rule.

The following placeholders are supported in the templates for new DocBlocks: %year%, %license%, %licenseUrl%.

Summary

Methods
Properties
Constants
__construct()
$fileSummary
$fileSummaryRegexp
$fileSummaryExtractRegexp
$fileDescription
$fileDescriptionRegexp
$fileDescriptionExtractRegexp
$fileStripText
$fileTags
$fileForbiddenTags
$classSummary
$classSummaryRegexp
$classSummaryExtractRegexp
$classDescription
$classDescriptionRegexp
$classDescriptionExtractRegexp
$classStripText
$classTags
$classForbiddenTags
$copyrightExtractRegexp
$license
$licenseExtractRegexp
$licenseUrl
$licenseUrlExtractRegexp
$year
$yearExtractRegexp
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$fileSummary

$fileSummary : string

Default summary for new, empty file-level DocBlocks.

Type

string

$fileSummaryRegexp

$fileSummaryRegexp : string

Regular expression to verify summary for file-level DocBlocks.

Type

string

$fileSummaryExtractRegexp

$fileSummaryExtractRegexp : string

Regular expression to extract summary for file-level DocBlocks, if other than $fileSummaryRegexp.

Type

string

$fileDescription

$fileDescription : string

Default description for new, empty file-level DocBlocks.

Type

string

$fileDescriptionRegexp

$fileDescriptionRegexp : string

Regular expression to verify description for file-level DocBlocks.

Type

string

$fileDescriptionExtractRegexp

$fileDescriptionExtractRegexp : string

Regular expression to extract description for file-level DocBlocks, if other than $fileDescriptionRegexp.

Type

string

$fileStripText

$fileStripText : string

Text to strip from file summaries and descriptions.

Type

string

$fileTags

$fileTags : string

Default tags for new, empty file-level DocBlocks.

Type

string

$fileForbiddenTags

$fileForbiddenTags : string

Forbidden tags for file-level DocBlocks.

Type

string

$classSummary

$classSummary : string

Default summary for new, empty class-level DocBlocks.

Type

string

$classSummaryRegexp

$classSummaryRegexp : string

Regular expression to verify summary for file-level DocBlocks.

Type

string

$classSummaryExtractRegexp

$classSummaryExtractRegexp : string

Regular expression to extract summary for class-level DocBlocks, if other than $classSummaryRegexp.

Type

string

$classDescription

$classDescription : string

Default description for new, empty class-level DocBlocks.

Type

string

$classDescriptionRegexp

$classDescriptionRegexp : string

Regular expression to verify description for file-level DocBlocks.

Type

string

$classDescriptionExtractRegexp

$classDescriptionExtractRegexp : string

Regular expression to extract summary for class-level DocBlocks, if other than $classDescriptionRegexp.

Type

string

$classStripText

$classStripText : string

Text to strip from file summaries and descriptions.

Type

string

$classTags

$classTags : string

Default tags for new, empty class-level DocBlocks.

Type

string

$classForbiddenTags

$classForbiddenTags : string

Forbidden tags for class-level DocBlocks.

Type

string

$copyrightExtractRegexp

$copyrightExtractRegexp : string

Regular expression to extract copyrights from description.

Type

string

$license

$license : string

Default license name for new, empty DocBlocks.

Type

string

$licenseExtractRegexp

$licenseExtractRegexp : string

Regular expression to extract license name from description.

Type

string

$licenseUrl

$licenseUrl : string

Default license URL for new, empty DocBlocks.

Type

string

$licenseUrlExtractRegexp

$licenseUrlExtractRegexp : string

Regular expression to extract license URL from description.

Type

string

$year

$year : string

Default copyright year for new, empty DocBlocks.

Type

string

$yearExtractRegexp

$yearExtractRegexp : string

Regular expression to extract year from description.

Type

string

Methods

__construct()

__construct(array  $params = array())

Constructor.

Parameters

array $params

Configuration parameters.