final class DimensionSpacePoint extends AbstractDimensionSpacePoint (View source)

A point in the dimension space with coordinates DimensionName => DimensionValue.

E.g.: ["language" => "es", "country" => "ar"]

Methods

__construct(array $coordinates, string $hash)

No description

static string
hashCoordinates(array $coordinates)

No description

static void
validateCoordinates(array $coordinates)

No description

bool
isDirectVariantInDimension(AbstractDimensionSpacePoint $other, ContentDimensionId $contentDimensionId)

A variant VarA is a "Direct Variant in Dimension Dim" of another variant VarB, if VarA and VarB are sharing all dimension values except in "Dim", AND they have differing dimension values in "Dim". Thus, VarA and VarB only vary in the given "Dim".

bool
hasCoordinate(ContentDimensionId $dimensionId)

No description

string|null
getCoordinate(ContentDimensionId $dimensionId)

No description

bool
equals(AbstractDimensionSpacePoint $other)

Equals check (as opposed to === same check, which is usually the preferred variant) Compares two hashes, since the DSPs themselves might be of different classes

array
toLegacyDimensionArray() deprecated

No description

array
jsonSerialize()

No description

string
toJson()

No description

fromArray(array $data)

No description

fromJsonString(string $jsonString)

Creates a dimension space point from a JSON string representation See jsonSerialize

createWithoutDimensions()

Creates a dimension space point for a zero-dimensional content repository.

fromLegacyDimensionArray(array $legacyDimensionValues) deprecated

Creates a dimension space point from a legacy dimension array in format ['language' => ['es'], 'country' => ['ar']]

vary(ContentDimensionId $dimensionId, string $value)

Varies a dimension space point in a single coordinate

Details

protected __construct(array $coordinates, string $hash)

No description

Parameters

array $coordinates
string $hash

final static protected string hashCoordinates(array $coordinates)

No description

Parameters

array $coordinates

Return Value

string

final static protected void validateCoordinates(array $coordinates)

No description

Parameters

array $coordinates

Return Value

void

final bool isDirectVariantInDimension(AbstractDimensionSpacePoint $other, ContentDimensionId $contentDimensionId)

A variant VarA is a "Direct Variant in Dimension Dim" of another variant VarB, if VarA and VarB are sharing all dimension values except in "Dim", AND they have differing dimension values in "Dim". Thus, VarA and VarB only vary in the given "Dim".

It does not say anything about how VarA and VarB relate (if it is specialization, peer or generalization).

Parameters

AbstractDimensionSpacePoint $other
ContentDimensionId $contentDimensionId

Return Value

bool

final bool hasCoordinate(ContentDimensionId $dimensionId)

No description

Parameters

ContentDimensionId $dimensionId

Return Value

bool

final string|null getCoordinate(ContentDimensionId $dimensionId)

No description

Parameters

ContentDimensionId $dimensionId

Return Value

string|null

final bool equals(AbstractDimensionSpacePoint $other)

Equals check (as opposed to === same check, which is usually the preferred variant) Compares two hashes, since the DSPs themselves might be of different classes

Parameters

AbstractDimensionSpacePoint $other

Return Value

bool

final array toLegacyDimensionArray() deprecated

deprecated should be only used for conversion from Neos <= 8.x to 9.x upwards. never use this in "modern" code.

No description

Return Value

array

final array jsonSerialize()

No description

Return Value

array

final string toJson()

No description

Return Value

string

static DimensionSpacePoint fromArray(array $data)

No description

Parameters

array $data

Return Value

DimensionSpacePoint

static DimensionSpacePoint fromJsonString(string $jsonString)

Creates a dimension space point from a JSON string representation See jsonSerialize

Parameters

string $jsonString

Return Value

DimensionSpacePoint

static DimensionSpacePoint createWithoutDimensions()

Creates a dimension space point for a zero-dimensional content repository.

This applies to content repositories without any dimensions configured.

Return Value

DimensionSpacePoint

final static DimensionSpacePoint fromLegacyDimensionArray(array $legacyDimensionValues) deprecated

deprecated should be only used for conversion from Neos <= 8.x to 9.x upwards. never use this in "modern" code.

Creates a dimension space point from a legacy dimension array in format ['language' => ['es'], 'country' => ['ar']]

Parameters

array $legacyDimensionValues

Return Value

DimensionSpacePoint

final DimensionSpacePoint vary(ContentDimensionId $dimensionId, string $value)

Varies a dimension space point in a single coordinate

Parameters

ContentDimensionId $dimensionId
string $value

Return Value

DimensionSpacePoint