phpdoc variable of class ArrayObject

Question

I have a class that extends ArrayObject

class Collection extends ArrayObject

I know i can define array of objects using this code:

/* @var $userArray Model_User[] */

But how can i define variable $userArray as an custom array of class Collection that contains objects of class Model_User?

Without changing class Collection or its phpdoc. I want to use the same class Collection for different arrays of objects.

This is not the same as PHPDoc type hinting for array of objects?, because in that subject discussion is related to common arrays in php, which are phpdoced as /* @var $userArray Model_User[] */ in the mean time my question relates to custom build array which if phpdoced my method above will not type hint methods of custom build array class, like so $userArray->echoChanges() because it will think its a common array, not an array of class Collection. And yes $userArray also acts as an array, so it should type hint array contents $userArray[3]->name.

Possible duplicate of PHPDoc type hinting for array of objects? — Gerard Roche
– Gerard Roche, Commented Sep 7, 2016 at 17:36
not even close, my array can have its own functions, like $userArray->resetChanges() so it should type hint + its also acts as an array $userArray[4] ->name and it should type hint as well. — YuraV
– YuraV, Commented Sep 8, 2016 at 5:31
In other words what your asking is: where $x = [new Name()]; then /* @var $x Name[] */ so $y = new Collection([new Name()]); then /* @var $y ? */ — Gerard Roche
– Gerard Roche, Commented Sep 8, 2016 at 6:27
code will work like this: $a = new Collection(); $a[] = new Model_User(); $a->resetChanges(); $a[0]->name = "George"; $a->echoChanges(); and i dont know how to phpdoc $a, so its knew it has methods of class Collection and contains objects of class Model_User. just in case php.net/manual/ru/class.arrayobject.php — YuraV
– YuraV, Commented Sep 8, 2016 at 6:41

Gerard Roche · Accepted Answer · 2016-09-08 06:51:44Z

1

PSR-5: PHPDoc proposes a form of Generics-style notation.

Syntax

Type[]
Type<Type>
Type<Type[, Type]...>
Type<Type[|Type]...>

Values in a Collection MAY even be another array and even another Collection.

Type<Type<Type>>
Type<Type<Type[, Type]...>>
Type<Type<Type[|Type]...>>

Examples

<?php

$x = [new Name()];
/* @var $x Name[] */

$y = new Collection([new Name()]);
/* @var $y Collection<Name> */

$a = new Collection(); 
$a[] = new Model_User(); 
$a->resetChanges(); 
$a[0]->name = "George"; 
$a->echoChanges();
/* @var $a Collection<Model_User> */

Note: If you are expecting an IDE to do code assist then it's another question about if the IDE supports PHPDoc Generic-style collections notation.

answered Sep 8, 2016 at 6:51

Gerard Roche

6,4815 gold badges45 silver badges71 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

YuraV Over a year ago

thx, thats what i was looking for, as for type hinting if anyone needs stackoverflow.com/questions/10706835/…. And also PSR-5 is in a draft status, so it may change.

Pierre-Antoine Guillaume Over a year ago

In this exemple, what PHPDoc do you apply to Collection and on the ArrayAccess' methods ?

Collectives™ on Stack Overflow

phpdoc variable of class ArrayObject

1 Answer 1

Syntax

Examples

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Syntax

Examples

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related