How can I get intellisense in PHP/Eclipse on custom objects pulled out of array in foreach loop?

Question

I have a collection of custom objects (Podcast) in an array.

When I use a foreach loop to iterate through this collection, I don't have code completion on the variable that contains the object pulled out of the collection (as I would in C#/VisualStudio for instance).

Is there a way to give PHP a type hint so that Eclipse knows the type of the object being pulled out of the collection so it can show me the methods on that object in intellisense?

alt text

<?php

$podcasts = new Podcasts();
echo $podcasts->getListHtml();

class Podcasts {
    private $collection = array();

    function __construct() {
        $this->collection[] = new Podcast('This is the first one');
        $this->collection[] = new Podcast('This is the second one');
        $this->collection[] = new Podcast('This is the third one');
    }

    public function getListHtml() {
        $r = '';
        if(count($this->collection) > 0) {
            $r .= '<ul>';
            foreach($this->collection as $podcast) {
                $r .= '<li>' . $podcast->getTitle() . '</li>';
            }
            $r .= '</ul>';
        }       
        return $r;
    }
}

class Podcast {

    private $title;

    public function getTitle() { return $this->title; }
    public function setTitle($value) {  $this->title = $value;}

    function __construct($title) {
        $this->title = $title;
    }

}

?>

Addendum

Thanks, Fanis, I updated my FOREACH template to include that line automatically:

if(count(${lines}) > 0) {
    foreach(${lines} as ${line}) {
        /* @var $$${var} ${Type} */

    }
}

alt text

Good stuff :) Good usage of templates too.

Fanis Hatzidakis
– Fanis Hatzidakis

2010-11-06 08:01:07 +00:00
Commented Nov 6, 2010 at 8:01 — Fanis Hatzidakis
– Fanis Hatzidakis, Commented Nov 6, 2010 at 8:01

Fanis Hatzidakis · Accepted Answer · 2010-09-18 15:49:12Z

19

Yes, try:

foreach($this->collection as $podcast) {
    /* @var $podcast Podcast */
    $r .= '<li>' . $podcast->getTitle() . '</
}

It's been a while since I used Eclipse but I recall it used to work there too.

answered Sep 18, 2010 at 15:49

Fanis Hatzidakis

5,3401 gold badge35 silver badges36 bronze badges

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

1 Comment

Fanis Hatzidakis Over a year ago

You're welcome! Just fyi, some IDEs may require a proper docblock, ie double asterisks: /** @var ... */

santiago arizti · Accepted Answer · 2018-08-07 22:16:24Z

This might help some other people from the internet looking for a more succint solution to this problem.

My solution requieres PHP7 or higher. The idea is to map the array with an anonymous function and take advantage of type-hinting.

  $podcasts = getPodcasts();
  $listItems = array_map(function (Podcast $podcast) {
      return "<li>" . $podcast->getTitle() . "</li>";
  }, $podcasts);
  $podcastsHtml = "<ul>\n" . implode("\n", $listItems) . "\n</ul>";

In most cases a foreach can be converted into an array_map, it simply takes a little bit of paradigm shift towards functional programming.

If you use Laravel (I am sure other frameworks have Collections too) you could even chain these array maps with array filters and other functional stuff like this:

$html = "<ul>" . collect($podcasts)
  ->filter(function (Podcast $p) { return $p !== null; }) // filtering example
  ->map(function (Podcast $p) { return "<li>".$p->getTitle()."</li>"; }) // mapping
  ->implode("\n") . "</ul>";

In plain php chaining those array functions looks pretty uggly...

But there you go! a native way of type hinting your array iterations.

Collectives™ on Stack Overflow

How can I get intellisense in PHP/Eclipse on custom objects pulled out of array in foreach loop?

Addendum

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

Addendum

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related