contao-community-alliance/dc-general
Back to top  

Interface ModelIdInterface.

This interface the model id which identifies an model.

 Methods

Determine if this id, is equals to the other id.

equals(\ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface $modelId) : bool

Parameters

$modelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface

The other model id.

Returns

bool

Create an instance from a model.

fromModel(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $model) : \ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface
Static

Parameters

$model

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

The model.

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface

Create an instance from an serialized id.

fromSerialized(string $serialized) : \ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface
Static

Parameters

$serialized

string

The id.

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralRuntimeException When invalid data is encountered.

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface

Create an instance from the passed values.

fromValues(string $dataProviderName, mixed $modelId) : \ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface
Static

Parameters

$dataProviderName

string

The data provider name.

$modelId

mixed

The id.

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface

Retrieve the data provider name.

getDataProviderName() : string

Returns

string

Retrieve the id.

getId() : mixed

Returns

mixed

Serialize the id.

getSerialized() : string

Returns

string