phpDocumentor

Settings
in package

Contains the Settings for the current Project.

Table of Contents

$custom  : array<string|int, string|bool>
A flexible list of settings that can be used by Writers, templates and more as additional settings.
$includeSource  : bool
$isModified  : bool
$visibility  : int
clearModifiedFlag()  : void
Resets the flag indicating whether the settings have changed.
excludeSource()  : void
getCustom()  : array<string, bool|string>
A flexible list of settings that can be used by Writers, templates and more as additional settings.
getVisibility()  : int
Returns the bit flag representing which visibilities are allowed.
includeSource()  : void
isModified()  : bool
Returns whether one of the values of this object was modified.
setCustom()  : void
setVisibility()  : void
Stores the visibilities that are allowed to be executed as a bitflag.
shouldIncludeSource()  : bool
setValueAndCheckIfModified()  : void
Sets a property's value and if it differs from the previous then mark these settings as modified.

Properties

$custom

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

private array<string|int, string|bool> $custom = []

$includeSource

private bool $includeSource = false

$isModified

private bool $isModified = false

Represents whether this settings object has been modified

$visibility

private int $visibility = \phpDocumentor\Configuration\ApiSpecification::VISIBILITY_DEFAULT

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

Methods

clearModifiedFlag()

Resets the flag indicating whether the settings have changed.

public clearModifiedFlag() : void
Return values
void

excludeSource()

public excludeSource() : void
Return values
void

getCustom()

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

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

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

Return values
array<string, bool|string>

getVisibility()

Returns the bit flag representing which visibilities are allowed.

public getVisibility() : int
Tags
see
self::isVisibilityAllowed()

for a convenience method to easily check against a specific visibility.

Return values
int

includeSource()

public includeSource() : void
Return values
void

isModified()

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

public isModified() : bool
Return values
bool

setCustom()

public setCustom(array<string, bool|string> $settings) : void
Parameters
$settings : array<string, bool|string>
Return values
void

setVisibility()

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

public setVisibility(int $visibilityFlag) : void
Parameters
$visibilityFlag : int

A bitflag combining the VISIBILITY_* constants.

Return values
void

shouldIncludeSource()

public shouldIncludeSource() : bool
Return values
bool

setValueAndCheckIfModified()

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

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

Search results