Constants
VISIBILITY_PUBLIC Line 21
mixed VISIBILITY_PUBLIC = 1
VISIBILITY_PROTECTED Line 23
mixed VISIBILITY_PROTECTED = 2
VISIBILITY_PRIVATE Line 25
mixed VISIBILITY_PRIVATE = 4
VISIBILITY_INTERNAL Line 27
mixed VISIBILITY_INTERNAL = 8
VISIBILITY_API Line 29
mixed VISIBILITY_API = 16
VISIBILITY_DEFAULT Line 32
int VISIBILITY_DEFAULT = 7
Properties
$isModified Line 35
private$isModified : bool
$visibility Line 38
private$visibility : int
$includeSource Line 41
private$includeSource : bool
$markers Line 44
private$markers : string[]
$custom Line 51
private$custom : (string|bool)[]
A flexible list of settings that can be used by Writers, templates and more as additional settings.
Methods
setVisibility() Line 58
Stores the visibilities that are allowed to be executed as a bitflag.
publicsetVisibility(int $visibilityFlag) : void
Parameters
A bitflag combining the VISIBILITY_* constants.
getVisibility() Line 68
Returns the bit flag representing which visibilities are allowed.
publicgetVisibility() : int
Returns
int —
isModified() Line 76
Returns whether one of the values of this object was modified.
publicisModified() : bool
Returns
bool —
clearModifiedFlag() Line 84
Resets the flag indicating whether the settings have changed.
publicclearModifiedFlag() : void
includeSource() Line 89
publicincludeSource() : void
excludeSource() Line 94
publicexcludeSource() : void
shouldIncludeSource() Line 99
publicshouldIncludeSource() : bool
Returns
bool —
setMarkers() Line 107
publicsetMarkers(string[] $markers) : void
Parameters
getMarkers() Line 115
publicgetMarkers() : string[]
Returns
string[] —
getCustom() Line 129
A flexible list of settings that can be used by Writers, templates and more as additional settings.
publicgetCustom() : (string|bool)[]
Some writers or templates can have their own specific settings; this can be registered here and accessed in
various locations through the accessor \phpDocumentor\Descriptor\ProjectDescriptor\ProjectDescriptor::getSettings() or in the templates using
the project.settings.other
variable.
Returns
(string|bool)[] —
setCustom() Line 137
publicsetCustom(array $settings) : void
Parameters
setValueAndCheckIfModified() Line 147
Sets a property's value and if it differs from the previous then mark these settings as modified.
privatesetValueAndCheckIfModified(string $propertyName, int|bool|array$value) : void