\phpDocumentor\Descriptor\ProjectDescriptorSettings

Contains the Settings for the current Project.

Summary

Methods
Properties
Constants
setVisibility()
getVisibility()
isModified()
clearModifiedFlag()
includeSource()
excludeSource()
shouldIncludeSource()
setMarkers()
getMarkers()
getCustom()
setCustom()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
setValueAndCheckIfModified()
$isModified
$visibility
$includeSource
$markers
$custom
N/A

Properties

$isModified

$isModified : bool

Type

bool — Represents whether this settings object has been modified

$visibility

$visibility : int

Type

int — a bitflag representing which visibilities are contained and allowed in this project

$includeSource

$includeSource : bool

Type

bool

$markers

$markers : string[]

Type

string[]

$custom

$custom : (string|bool)[]

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

Type

(string|bool)[]

Methods

setVisibility()

setVisibility(int  $visibilityFlag) : void

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

Parameters

int $visibilityFlag

A bitflag combining the VISIBILITY_* constants.

getVisibility()

getVisibility() : int

Returns the bit flag representing which visibilities are allowed.

Returns

int —

isModified()

isModified() : bool

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

Returns

bool —

clearModifiedFlag()

clearModifiedFlag() : void

Resets the flag indicating whether the settings have changed.

includeSource()

includeSource() : void

excludeSource()

excludeSource() : void

shouldIncludeSource()

shouldIncludeSource() : bool

Returns

bool —

setMarkers()

setMarkers(string[]  $markers) : void

Parameters

string[] $markers

getMarkers()

getMarkers() : string[]

Returns

string[] —

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} or in the templates using the project.settings.other variable.

Returns

array

setCustom()

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

Parameters

array $settings

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

string $propertyName
int|bool|array $value