PHP 8.4.2 Released!

Kovarianz und Kontravarianz

Mit PHP 7.2.0 wurde teilweise Kontravarianz eingeführt, indem Typeneinschränkungen bei Parametern von Kindmethoden entfernt wurden. Mit PHP 7.4.0 wurde dann vollständige Unterstützung für Kovarianz und Kontravarianz eingeführt.

Kovarianz erlaubt es den Methoden eines Kindes, einen spezifischeren Typen als die Elternmethode für den Rückgabewert zurückzugeben. Die Kontravarianz erlaubt einen weniger spezifischen Parametertyp in einer Kindmethode als in der Elternmethode.

Eine Typdeklaration wird in den folgenden Fällen als spezifischer angesehen:

Falls das Gegenteil zutrifft, wird ein Klassentyp als weniger spezifisch angesehen.

Kovarianz

Um Kovarianz zu illustrieren, wird eine einfache abstrakte Elternklasse Tier erzeugt. Tier wird von seinen Kindern Katze und Hund beerbt.

<?php

abstract class Tier
{
protected
string $name;

public function
__construct(string $name)
{
$this->name = $name;
}

abstract public function
gibLaut();
}

class
Hund extends Tier
{
public function
gibLaut()
{
echo
$this->name . " bellt";
}
}

class
Katze extends Tier
{
public function
gibLaut()
{
echo
$this->name . " miaut";
}
}

Beachtenswert ist, dass keine der Methoden hier einen Wert zurückgibt. Es werden nun ein paar Factories hinzugefügt, die ein neues Objekt der Klassen Tier, Katze oder Hund erzeugen.

<?php

interface TierHeim
{
public function
adoptiere(string $name): Tier;
}

class
KatzenHeim implements TierHeim
{
public function
adoptiere(string $name): Katze // statt den Klassentyp Tier zurückzugeben, kann hier Typ Katze verwendet werden
{
return new
Katze($name);
}
}

class
HundeHeim implements TierHeim
{
public function
adoptiere(string $name): Hund // statt den Klassentyp Tier zurückzugeben, kann hier Typ Hund verwendet werden
{
return new
Hund($name);
}
}

$kaetzchen = (new KatzenHeim)->adoptiere("Ricky");
$kaetzchen->gibLaut();
echo
"\n";

$huendchen = (new HundeHeim)->adoptiere("Mavrick");
$huendchen->gibLaut();

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

Ricky miaut
Mavrick bellt

Kontravarianz

Um das vorherige Beispiel mit den Klassen Tier, Katze und Hund fortzusetzen, werden nun die Klassen Nahrung sowie Tierfutter definiert, sowie auch eine Methode iss(Tierfutter $futter) zur abstrakten Klasse Tier hinzugefügt.

<?php

class Nahrung {}

class
Tierfutter extends Nahrung {}

abstract class
Tier
{
protected
string $name;

public function
__construct(string $name)
{
$this->name = $name;
}

public function
iss(Tierfutter $futter)
{
echo
$this->name . " isst " . get_class($futter);
}
}

Um das Verhalten der Kontravarianz zu sehen, wird nun die Methode iss in der Klasse Hund überschrieben, um jedes Objekt der Klasse Nahrung zuzulassen. Die Klasse Katze bleibt unverändert.

<?php

class Hund extends Tier
{
public function
iss(Nahrung $futter) {
echo
$this->name . " isst " . get_class($futter);
}
}

Das folgende Beispiel zeigt das Verhalten der Kontravarianz.

<?php

$kaetzchen
= (new KatzenHeim)->adoptiere("Ricky");
$katzenFutter = new Tierfutter();
$kaetzchen->iss($katzenFutter);
echo
"\n";

$huendchen = (new HundeHeim)->adoptiere("Mavrick");
$banane = new Nahrung();
$huendchen->iss($banane);

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

Ricky isst Tierfutter
Mavrick isst Nahrung

Was geschieht nun aber, wenn man der iss()-Methode von $kaetzchen versucht die $banane zu übergeben?

$kitty->iss($banane);

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

Fatal error: Uncaught TypeError: Argument 1 passed to Tier::iss() must be an instance of Tierfutter, instance of Nahrung given

Varianz der Eigenschaften

Standardmäßig sind Eigenschaften weder kovariant noch kontravariant, d. h. sie sind invariant. Das bedeutet, dass sich ihr Typ in einer Kindklasse überhaupt nicht ändern darf. Der Grund dafür ist, dass "get"-Operationen kovariant und "set"-Operationen kontravariant sein müssen. Die einzige Möglichkeit für eine Eigenschaft, beide Anforderungen zu erfüllen, besteht darin, invariant zu sein.

Seit PHP 8.4.0 ist es mit der Einführung von abstrakten Eigenschaften (auf einer Schnittstelle oder einer abstrakten Klasse) und virtuellen Eigenschaften möglich, eine Eigenschaft zu deklarieren, die nur eine get- oder set-Operation hat. Folglich können abstrakte Eigenschaften oder virtuelle Eigenschaften, die nur eine "get"-Operation benötigen, kovariant sein. Ebenso kann eine abstrakte Eigenschaft oder eine virtuelle Eigenschaft, die nur eine "set"-Operation benötigt, kontravariant sein.

Sobald eine Eigenschaft jedoch sowohl eine get- als auch eine set-Operation hat, ist sie für weitere Erweiterungen nicht mehr kovariant oder kontravariant. Mit anderen Worten: Sie ist nun invariant.

Beispiel #1 Varianz des Eigenschaftstyps

<?php
class Animal {}
class
Dog extends Animal {}
class
Poodle extends Dog {}

interface
PetOwner
{
// Es wird nur eine get-Operation benötigt, so dass diese kovariant
// sein kann.
public Animal $pet { get; }
}

class
DogOwner implements PetOwner
{
// Dies kann ein restriktiverer Typ sein, da die "get"-Seite immer ein
// Animal zurückgibt. Da es sich jedoch um eine native Eigenschaft handelt,
// können Kinder dieser Klasse den Typ nicht mehr ändern.
public Dog $pet;
}

class
PoodleOwner extends DogOwner
{
// Dies ist NICHT ZULÄSSIG, da für DogOwner::$pet sowohl get- als auch
// set-Operationen definiert sind und benötigt werden.
public Poodle $pet;
}
?>
add a note

User Contributed Notes 3 notes

up
96
xedin dot unknown at gmail dot com
4 years ago
I would like to explain why covariance and contravariance are important, and why they apply to return types and parameter types respectively, and not the other way around.

Covariance is probably easiest to understand, and is directly related to the Liskov Substitution Principle. Using the above example, let's say that we receive an `AnimalShelter` object, and then we want to use it by invoking its `adopt()` method. We know that it returns an `Animal` object, and no matter what exactly that object is, i.e. whether it is a `Cat` or a `Dog`, we can treat them the same. Therefore, it is OK to specialize the return type: we know at least the common interface of any thing that can be returned, and we can treat all of those values in the same way.

Contravariance is slightly more complicated. It is related very much to the practicality of increasing the flexibility of a method. Using the above example again, perhaps the "base" method `eat()` accepts a specific type of food; however, a _particular_ animal may want to support a _wider range_ of food types. Maybe it, like in the above example, adds functionality to the original method that allows it to consume _any_ kind of food, not just that meant for animals. The "base" method in `Animal` already implements the functionality allowing it to consume food specialized for animals. The overriding method in the `Dog` class can check if the parameter is of type `AnimalFood`, and simply invoke `parent::eat($food)`. If the parameter is _not_ of the specialized type, it can perform additional or even completely different processing of that parameter - without breaking the original signature, because it _still_ handles the specialized type, but also more. That's why it is also related closely to the Liskov Substitution: consumers may still pass a specialized food type to the `Animal` without knowing exactly whether it is a `Cat` or `Dog`.
up
8
Hayley Watson
2 years ago
The gist of how the Liskov Substition Princple applies to class types is, basically: "If an object is an instance of something, it should be possible to use it wherever an instance of something is allowed". The Co- and Contravariance rules come from this expectation when you remember that "something" could be a parent class of the object.

For the Cat/Animal example of the text, Cats are Animals, so it should be possible for Cats to go anywhere Animals can go. The variance rules formalise this.

Covariance: A subclass can override a method in the parent class with one that has a narrower return type. (Return values can be more specific in more specific subclasses; they "vary in the same direction", hence "covariant").
If an object has a method you expect to produce Animals, you should be able to replace it with an object where that method produces only Cats. You'll only get Cats from it but Cats are Animals, which are what you expected from the object.

Contravariance: A subclass can override a method in the parent class with one that has a parameter with a wider type. (Parameters can be less specific in more specific subclasses; they "vary in the opposite direction", hence "contravariant").
If an object has a method you expect to take Cats, you should be able to replace it with an object where that method takes any sort of Animal. You'll only be giving it Cats but Cats are Animals, which are what the object expected from you.

So, if your code is working with an object of a certain class, and it's given an instance of a subclass to work with, it shouldn't cause any trouble:
It might accept any sort of Animal where you're only giving it Cats, or it might only return Cats when you're happy to receive any sort of Animal, but LSP says "so what? Cats are Animals so you should both be satisfied."
up
11
Anonymous
4 years ago
Covariance also works with general type-hinting, note also the interface:

interface xInterface
{
public function y() : object;
}

abstract class x implements xInterface
{
abstract public function y() : object;
}

class a extends x
{
public function y() : \DateTime
{
return new \DateTime("now");
}
}

$a = new a;
echo '<pre>';
var_dump($a->y());
echo '</pre>';
To Top