class Result (View source)

Properties

protected int[] $addedValues

List of added values (array keys are strings representing a value, array values are the number of times the value has been added).

protected int[] $updatedValues

List of updated values (array keys are strings representing a value, array values are the number of times the value has been updated).

protected int[] $removedInvalidValues

List of invalid values (array keys are strings describing the warning, array values are the number of times the warning occurred).

protected int[] $removedDuplicatedValues

List of values removed because duplicated (array keys are strings representing a value, array values are the number of times the value has been removed).

protected int[] $removedUnusedValues

List of values removed because unused (array keys are strings representing a value, array values are the number of times the value has been removed).

protected string[] $warnings

List of generic warnings.

protected Style[] $variablesWithoutValueInPresets

List of variables defined in the theme XML files that don't have a value in any theme preset.

Methods

string
__toString()

Get a plain text-string representation of this instance.

$this
addAddedValue(Value $value)

Add a value that has been added to an existing style list.

int[]
getAddedValues()

Get the list of the added values.

$this
addUpdatedValue(Value $value)

Add a value that has been udated in an existing style list.

int[]
getUpdatedValues()

Get the list of updated values.

$this
addRemovedInvalidValue(string $reason)

Add a value that has been removed from an existing style list because not valid.

int[]
getRemovedInvalidValues()

Get the list of invalid values.

$this
addRemovedDuplicatedValue(Value $value)

Add a value that has been removed from an existing style list because duplicated.

int[]
getRemovedDuplicatedValues()

Get the list of values removed because duplicated.

$this
addRemovedUnusedValue(Value $value)

Add a value that has been removed from an existing style list because unused.

int[]
getRemovedUnusedValues()

Get the list of values removed because unused.

$this
addWarning(mixed $value)

Add a generic warning.

string[]
getWarnings()

Get the list of generic warnings.

$this
addVariableWithoutValueInPresets(Style $variable, bool $addToWarnings = true)

Add a variable defined in the theme XML file that doesn't have a value in any theme preset.

Style[]
getVariablesWithoutValueInPresets()

Get the list of variables defined in the theme XML files that don't have a value in any theme preset.

string
getValueKey(Value $value)

Build a string that can be used to identify the type and name of a style value.

string[]
describeValueList(string $name, array $valueList)

No description

string[]
describeCountedStringList(string $name, array $strings)

No description

string[]
describeStringList(string $name, array $strings)

No description

string
describeValueKey(string $key)

No description

Details

string __toString()

Get a plain text-string representation of this instance.

Return Value

string

$this addAddedValue(Value $value)

Add a value that has been added to an existing style list.

Parameters

Value $value

Return Value

$this

int[] getAddedValues()

Get the list of the added values.

Return Value

int[]

array keys are strings representing a value, array values are the number of times the value has been added

$this addUpdatedValue(Value $value)

Add a value that has been udated in an existing style list.

Parameters

Value $value

Return Value

$this

int[] getUpdatedValues()

Get the list of updated values.

Return Value

int[]

array keys are strings representing a value, array values are the number of times the value has been updated

$this addRemovedInvalidValue(string $reason)

Add a value that has been removed from an existing style list because not valid.

Parameters

string $reason

The reason why a value is invalid

Return Value

$this

int[] getRemovedInvalidValues()

Get the list of invalid values.

Return Value

int[]

array keys are strings describing the warning, array values are the number of times the warning occurred

$this addRemovedDuplicatedValue(Value $value)

Add a value that has been removed from an existing style list because duplicated.

Parameters

Value $value

Return Value

$this

int[] getRemovedDuplicatedValues()

Get the list of values removed because duplicated.

Return Value

int[]

array keys are strings representing a value, array values are the number of times the value has been removed

$this addRemovedUnusedValue(Value $value)

Add a value that has been removed from an existing style list because unused.

Parameters

Value $value

Return Value

$this

int[] getRemovedUnusedValues()

Get the list of values removed because unused.

Return Value

int[]

array keys are strings representing a value, array values are the number of times the value has been removed

$this addWarning(mixed $value)

Add a generic warning.

Parameters

mixed $value

Return Value

$this

string[] getWarnings()

Get the list of generic warnings.

Return Value

string[]

$this addVariableWithoutValueInPresets(Style $variable, bool $addToWarnings = true)

Add a variable defined in the theme XML file that doesn't have a value in any theme preset.

Parameters

Style $variable
bool $addToWarnings

add an entry to the warnings too?

Return Value

$this

Style[] getVariablesWithoutValueInPresets()

Get the list of variables defined in the theme XML files that don't have a value in any theme preset.

Return Value

Style[]

protected string getValueKey(Value $value)

Build a string that can be used to identify the type and name of a style value.

Parameters

Value $value

Return Value

string

protected string[] describeValueList(string $name, array $valueList)

No description

Parameters

string $name
array $valueList

Return Value

string[]

protected string[] describeCountedStringList(string $name, array $strings)

No description

Parameters

string $name
array $strings

Return Value

string[]

protected string[] describeStringList(string $name, array $strings)

No description

Parameters

string $name
array $strings

Return Value

string[]

protected string describeValueKey(string $key)

No description

Parameters

string $key

Return Value

string