\phpDocumentor\Descriptor\ProjectDescriptorSettings

setVisibility()

setVisibility(int  $visibilityFlag) : void

Stores the visibilities that are allowed to be executed as a bitflag.

Parameters

getVisibility()

getVisibility() : int

Returns the bit flag representing which visibilities are allowed.

Returns

isModified()

isModified() : bool

Returns whether one of the values of this object was modified.

Returns

clearModifiedFlag()

clearModifiedFlag() : void

Resets the flag indicating whether the settings have changed.

includeSource()

includeSource() : void

excludeSource()

excludeSource() : void

shouldIncludeSource()

shouldIncludeSource() : bool

Returns

getCustom()

getCustom() : array<string,bool|string>

A flexible list of settings that can be used by Writers, templates and more as additional settings.

Some writers or templates can have their own specific settings; this can be registered here and accessed in various locations through the accessor {@see \phpDocumentor\Descriptor\ProjectDescriptor\ProjectDescriptor::getSettings()} or in the templates using the project.settings.other variable.

Returns

setCustom()

setCustom(array<string,bool|string>  $settings) : void

Parameters

setValueAndCheckIfModified()

setValueAndCheckIfModified(string  $propertyName, int|bool|array<string,bool|string>  $value) : void

Sets a property's value and if it differs from the previous then mark these settings as modified.

Parameters