Php object property types

Typed properties in PHP 7.4

Typed class properties have been added in PHP 7.4 and provide a major improvement to PHP ‘s type system. These changes are fully opt-in and non breaking to previous versions.

In this post we’ll look at the feature in-depth, but first let’s start by summarising the most important points:

• They are available as of PHP 7.4 , which is scheduled to be released in November of 2019
• They are only available in classes and require an access modifier: public , protected or private ; or var
• All types are allowed, except void and callable

This is what they look like in action:

class Foo < public int $a; public ?string $b = 'foo'; private Foo $prop; protected static string $static = 'default'; >

If you’re unsure about the added benefit of types, I’d recommend you reading this post first.

# Uninitialized

Before looking at the fun stuff, there’s an important aspect about typed properties that’s essential to talk about first.

Despite what you might think on first sight, the following code is valid:

class Foo < public int $bar; > $foo = new Foo;

Even though the value of $bar isn’t an integer after making an object of Foo , PHP will only throw an error when $bar is accessed:

var_dump($foo->bar); Fatal error: Uncaught Error: Typed property Foo::$bar must not be accessed before initialization

As you can read from the error message, there’s a new kind of «variable state»: uninitialized.

If $bar didn’t have a type, its value would simply be null . Types can be nullable though, so it’s not possible to determine whether a typed nullable property was set, or simply forgotten. That’s why «uninitialized» was added.

There are four important things to remember about uninitialized:

• You cannot read from uninitialized properties, doing so will result in a fatal error.
• Because uninitialized state is checked when accessing a property, you’re able to create an object with an uninitialized property, even though its type is non-nullable.
• You can write to an uninitialized property before reading from it.
• Using unset on a typed property will make it uninitialized, while unsetting an untyped property will make it null .

Especially note that the following code, where an uninitialised, non-nullable property is set after constructing the object, is valid

class Foo < public int $a; > $foo = new Foo; $foo->a = 1;

While uninitialized state is only checked when reading the value of a property, type validation is done when writing to it. This means that you can be sure that no invalid type will ever end up as a property’s value.

Interface Default Methods

# Defaults and constructors

Let’s take a closer look at how typed values can be initialized. In case of scalar types, it’s possible to provide a default value:

class Foo < public int $bar = 4; public ?string $baz = null; public array $list = [1, 2, 3]; >

Note that you can only use null as a default if the type is actually nullable. This might seem obvious, but there’s some legacy behaviour with parameter defaults where the following is allowed:

function passNull(int $i = null) < /* … */ > passNull(null);

Luckily this confusing behaviour is not allowed with typed properties.

Also note that it’s impossible to have default values with object or class types. You should use the constructor to set their defaults.

The obvious place to initialize typed values would of course be the constructor:

class Foo < private int $a; public function __construct(int $a) < $this->a = $a; > >

But also remember what I mentioned before: it’s valid to write to an uninitialized property, outside of the constructor. As long as there are nothing is reading from a property, the uninitialized check is not performed.

# Types of types

So what exactly can be typed and how? I already mentioned that typed properties will only work in classes (for now), and that they need an access modifier or the var key word in front of them.

As of available types, almost all types can be used, except void and callable .

Because void means the absence of a value, it makes sense that it cannot be used to type a value. callable however is a little more nuanced.

See, a «callable» in PHP can be written like so:

Say you’d have the following (broken) code:

class Foo < public callable $callable; public function __construct(callable $callable) < /* … */ > > class Bar < public Foo $foo; public function __construct() < $this->foo = new Foo([$this, 'method']) > private function method() < /* … */ > > $bar = new Bar; ($bar->foo->callable)();

In this example, $callable refers to the private Bar::method , but is called within the context of Foo . Because of this problem, it was decided not to add callable support.

It’s no big deal though, because Closure is a valid type, which will remember the $this context where it was constructed.

With that out of the way, here’s a list of all available types:

• bool
• int
• float
• string
• array
• iterable
• object
• ? (nullable)
• self & parent
• Classes & interfaces

# Coercion and strict types

PHP , being the dynamic language we love and hate, will try to coerce or convert types whenever possible. Say you pass a string where you expect an integer, PHP will try and convert that string automatically:

function coerce(int $i) < /* … */ > coerce('1'); // 1

The same principles apply to typed properties. The following code is valid and will convert ‘1’ to 1 .

class Bar < public int $i; > $bar = new Bar; $bar->i = '1'; // 1

If you don’t like this behaviour you can disabled it by declaring strict types:

declare(strict_types=1); $bar = new Bar; $bar->i = '1'; // 1 Fatal error: Uncaught TypeError: Typed property Bar::$i must be int, string used

# Type variance and inheritance

Even though PHP 7.4 introduced improved type variance, typed properties are still invariant. This means that the following is not valid:

class A <> class B extends A <> class Foo < public A $prop; > class Bar extends Foo < public B $prop; > Fatal error: Type of Bar::$prop must be A (as in class Foo)

If the above example doesn’t seem significant, you should take a look at the following:

class Foo < public self $prop; > class Bar extends Foo < public self $prop; >

PHP will replace self behind the scenes with the concrete class it refers to, before running the code. This means that the same error will be thrown in this example. The only way to handle it, is by doing the following:

class Foo < public Foo $prop; > class Bar extends Foo < public Foo $prop; >

Speaking of inheritance, you might find it hard to come up with any good use cases to overwrite the types of inherited properties.

While I agree with that sentiment, it’s worth noting that it is possible to change the type of an inherited property, but only if the access modifier also changes from private to protected or public .

The following code is valid:

class Foo < private int $prop; > class Bar extends Foo < public string $prop; >

However, changing a type from nullable to non-nullable or reverse, is not allowed.

class Foo < public int $a; public ?int $b; > class Bar extends Foo < public ?int $a; public int $b; > Fatal error: Type of Bar::$a must be int (as in class Foo)

Noticed a tpyo? You can submit a PR to fix it. If you want to stay up to date about what’s happening on this blog, you can follow me on Twitter or subscribe to my newsletter:

# There’s more!

Like I said at the start of this post, typed properties are a major addition to PHP . There’s lots more to say about them. I’d suggest you reading through the RFC to know all the neat little details.

If you’re new to PHP 7.4 , you probably want to read the full list of changes made and features added. To be honest, it’s one of the best releases in a long time, and worth your time!

Finally, if you have any thoughts you want to share on the topic, I’d love to hear from you! You can reach me via Twitter or e-mail.

Источник

PHP Typed Properties

Summary: in this tutorial, you wil learn how to define typed properties by adding type hints to class properties.

Introduction to the PHP typed properties

The following example defines the BankAccount class with a property called $balance :

class BankAccount < public $balance; >Code language: PHP (php)

The default value of the $balance property is null .

$account = new BankAccount(); var_dump($account->balance); // nullCode language: PHP (php)

PHP 7.4 allows you to type hints the class properties with any types except void and callable . For example:

class BankAccount < public float $balance; >Code language: PHP (php)

In this example, the $balance property has the type float . When you add the float type to $balance property, the following code causes an error:

$account = new BankAccount(); var_dump($account->balance); // nullCode language: PHP (php)

Fatal error: Uncaught Error: Typed property BankAccount::$balance must not be accessed before initializationCode language: plaintext (plaintext)

It doesn’t work because the $balance property now becomes uninitialized. The default value of the $balance property is not null like before. Notice that you can still create a new object with typed properties uninitialized.

To read from a typed property, you need to initialize it first. For example:

 class BankAccount < public float $balance; > $account = new BankAccount(); $account->balance = 0; var_dump($account->balance); // 0Code language: PHP (php)

For properties with scalar types, you can initialize them in the declaration. For example:

 class BankAccount < public float $balance = 0; > $account = new BankAccount(); var_dump($account->balance); // 0Code language: PHP (php)

Alternatively, you can initialize the typed properties in the constructor of the class:

 class BankAccount < public float $balance = 0; public function __construct(float $balance) < $this->balance = $balance; > > $account = new BankAccount(100); var_dump($account->balance); // 100Code language: PHP (php)

If you unset a typed property, its status will change back to uninitialized. Note that for an untyped property, its value will become null after unset. For example:

 class BankAccount < public float $balance = 0; public function __construct(float $balance) < $this->balance = $balance; > > $account = new BankAccount(0); var_dump($account->balance); // 0 unset($account->balance); var_dump($account->balance); // errorCode language: PHP (php)

Typed properties and strict types

In the following example, the constructor of the BankAccount expects a float . However, you can pass a string. In this case, PHP coerces the string to a float:

 class BankAccount < public float $balance = 0; public function __construct(float $balance) < $this->balance = $balance; > > $account = new BankAccount("100.5"); var_dump($account->balance); // 100.5Code language: PHP (php)

If you don’t want this behavior, you can disable it by declaring strict_types at the beginning of the file as follows:

 declare(strict_types=1); class BankAccount < public float $balance = 0; public function __construct(float $balance) < $this->balance = $balance; > > $account = new BankAccount("100.25"); // error var_dump($account->balance);Code language: PHP (php)

Fatal error: Uncaught TypeError: Argument 1 passed to BankAccount::__construct() must be of the type float, string given.Code language: plaintext (plaintext)

Summary

• Typed properties include modifiers ( private , protected , and public ) and types (except void and callable ).
• Typed properties have uninitialized states, not null like untyped properties.

Источник