Gitee
\
Cilex
Provider
phpDocumentor
Command
Helper
Phar
Project
Compiler
Linker
Pass
Configuration
Merger
Annotation
Console
Input
Output
Descriptor
Builder
Reflector
Tags
Cache
Example
Exception
Filter
Interfaces
ProjectDescriptor
Tag
BaseTypes
Type
Validator
Event
Parser
Command
Project
Configuration
Event
Exception
Util
Partials
Exception
Plugin
Core
Descriptor
Validator
Constraints
Classes
Functions
Property
Functions
Transformer
Behaviour
Tag
Writer
Xml
Xslt
Graphs
Writer
LegacyNamespaceConverter
Tests
Scrybe
Command
Manual
Converter
Definition
Exception
Format
Exception
Metadata
TableOfContents
RestructuredText
Directives
Roles
Visitors
Template
Twig
Writer
Transformer
Behaviour
Command
Project
Template
Configuration
Transformations
Event
Exception
Router
Matcher
UrlGenerator
Standard
Template
Writer
Exception
Translator

\phpDocumentor\Descriptor\ProjectDescriptorSettings

Contains the Settings for the current Project.

Summary

Methods
Properties
Constants
setVisibility()
getVisibility()
isModified()
clearModifiedFlag()
includeSource()
excludeSource()
shouldIncludeSource()
No public properties found
VISIBILITY_PUBLIC
VISIBILITY_PROTECTED
VISIBILITY_PRIVATE
VISIBILITY_INTERNAL
VISIBILITY_DEFAULT
setValueAndCheckIfModified()
$isModified
$visibility
$includeSource
N/A
No private methods found
No private properties found
N/A

Constants

VISIBILITY_PUBLIC

VISIBILITY_PUBLIC = 1

VISIBILITY_PROTECTED

VISIBILITY_PROTECTED = 2

VISIBILITY_PRIVATE

VISIBILITY_PRIVATE = 4

VISIBILITY_INTERNAL

VISIBILITY_INTERNAL = 8

VISIBILITY_DEFAULT

VISIBILITY_DEFAULT = 7 : integer

Properties

$isModified

$isModified : boolean

Type

boolean — Represents whether this settings object has been modified

$visibility

$visibility : integer

Type

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

$includeSource

$includeSource : boolean

Type

boolean

Methods

setVisibility()

setVisibility(integer  $visibilityFlag) : void

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

Parameters

integer $visibilityFlag

A bitflag combining the VISIBILITY_* constants.

getVisibility()

getVisibility() : integer

Returns the bit flag representing which visibilities are allowed.

Returns

integer

isModified()

isModified() : boolean

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

Returns

boolean

clearModifiedFlag()

clearModifiedFlag() : void

Resets the flag indicating whether the settings have changed.

includeSource()

includeSource()

excludeSource()

excludeSource()

shouldIncludeSource()

shouldIncludeSource()

setValueAndCheckIfModified()

setValueAndCheckIfModified(  $propertyName,   $value)

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

Parameters

$propertyName
$value