Documentation

SettingsIni extends BaseModifier
in package

Table of Contents

$in  : InputInterface
$out  : OutputInterface
$stepName  : string
$upgrade  : Upgrade
$version  : BaseVersion
$abortedRequiringUserAction  : bool
$fileLocation  : string
$isFirstAddition  : bool
$settings  : array<string|int, mixed>
$shouldAssertEmptyLastRow  : bool
$shouldCollapseConsecutiveEmptyRows  : bool
__construct()  : mixed
abortRequiringUserAction()  : mixed
addProperty()  : void
assertEmptyLastRow()  : void
collapseConsecutiveEmptyRows()  : void
configure()  : void
confirmAutomatedChange()  : bool
modifyProperty()  : void
removeProperty()  : void
save()  : void
shouldSkipStep()  : mixed
formatPropertyAsLine()  : string
propertyExistsAt()  : int|null

Properties

$abortedRequiringUserAction

private bool $abortedRequiringUserAction = false

$fileLocation

private string $fileLocation = 'z_config/z_settings.ini'

$isFirstAddition

private bool $isFirstAddition = true

$shouldAssertEmptyLastRow

private bool $shouldAssertEmptyLastRow = false

$shouldCollapseConsecutiveEmptyRows

private bool $shouldCollapseConsecutiveEmptyRows = false

Methods

abortRequiringUserAction()

public abortRequiringUserAction() : mixed
Return values
mixed —

addProperty()

public addProperty(string $name, string $value[, string|null $afterProperty = null ]) : void
Parameters
$name : string
$value : string
$afterProperty : string|null = null
Return values
void —

assertEmptyLastRow()

public assertEmptyLastRow() : void
Return values
void —

collapseConsecutiveEmptyRows()

public collapseConsecutiveEmptyRows() : void
Return values
void —

configure()

public configure() : void
Return values
void —

confirmAutomatedChange()

public confirmAutomatedChange() : bool
Return values
bool —

modifyProperty()

public modifyProperty(string $name, string $value) : void
Parameters
$name : string
$value : string
Return values
void —

removeProperty()

public removeProperty(string $name[, null|string|array<string|int, mixed> $warning = null ][, null|string|array<string|int, mixed> $warnIf = ["1", "true", "on", "yes"] ]) : void
Parameters
$name : string
$warning : null|string|array<string|int, mixed> = null
$warnIf : null|string|array<string|int, mixed> = ["1", "true", "on", "yes"]
Return values
void —

shouldSkipStep()

public shouldSkipStep() : mixed
Return values
mixed —

formatPropertyAsLine()

private formatPropertyAsLine(string $name, string $value) : string
Parameters
$name : string
$value : string
Return values
string —

propertyExistsAt()

private propertyExistsAt(string $name) : int|null
Parameters
$name : string
Return values
int|null —

Search results