php class identification for IDEs

Question

Hello,

Let's say i have a function that returns an object of type SomeClass. And i have code like this:

$test = function_to_return_someclass();

Now i want to use the $test variable in an IDE, but i want it to understand that $test is of type SomeClass. I can do it easily with class variables by using the /** @var */ comment, but this is where i get stuck. And since trying something like:

$test = (SomeClass)function_to_return_someclass();

doesn't work, how can i instruct the IDE that $test is a SomeClass' object?

Answer 1

You could try using @return in the function definition:

/** 
  * Generates an object of the class SomeClass
  * @return SomeClass the class 
  */
function_to_return_someclass()
 {
   ....
 }

it's up to your IDE whether it's smart enough to understand it. It should, though.

2nd approach: Try

 /** 
  * My object. Recognize it already, damn IDE!
  * @var SomeClass 
  */
 $test = function_to_return_someclass();

Answer 2

Some IDEs may be able to infer $test's type from the function called to retrieve it. From personal experience, Aptana Studio's old PHP plugin (by old, I mean 'Aptana 1.5' old) does that.

If you document the function itself:

/**
 * @return SomeClass
 */
function function_to_return_someclass()
{
    return new SomeClass();
}

And then call it, the IDE's autocomplete/IntelliSense should be able to list SomeClass's members.

Answer 3

You could try:

/**
* @return ClassToBeReturned
*/
function_to_return_someclass() {}