Settings

in package

Contains the Settings for the current Project.

Settings.php

Constants

Properties

private$isModified  : bool                

private$visibility  : int                

private$includeSource  : bool                

private$markers  : string[]                

private$custom  : (string|bool)[]

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

Methods

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

publicsetVisibility(int $visibilityFlag) : void

Parameters

$visibilityFlag : int

A bitflag combining the VISIBILITY_* constants.

Returns the bit flag representing which visibilities are allowed.

publicgetVisibility() : int

Returns

int —
see
self::isVisibilityAllowed()

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

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

publicisModified() : bool

Returns

bool —

Resets the flag indicating whether the settings have changed.

publicclearModifiedFlag() : void

publicincludeSource() : void

publicexcludeSource() : void

publicshouldIncludeSource() : bool

Returns

bool — 

publicsetMarkers(string[] $markers) : void

Parameters

$markers : string[] 

publicgetMarkers() : string[]

Returns

string[] —

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)[] — 

publicsetCustom(array $settings) : void

Parameters

$settings : array

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

Parameters

$propertyName : string
$value : int|bool|array