Description Oliver Grätz 2013-03-21 10:27:13 EDT

My uses build to verify this problem is the current nightly:

  PHP Development Tools (PDT) 3.2.0.201303201012

and this bug is related to

  https://bugs.eclipse.org/bugs/show_bug.cgi?id=375821

which is CLOSED but not completely fixed. The syntax of return "className[]" proposed there is only working in some cases and I think the reason might be that overriding the internal assumptions of the Code Assist with explicit "@return" definitions isn't working with arrays. This leads to completion for
the wrong class in some cases and missing completion in other situations.


Example:

/**
 * Test.
 * 
 * Without the @return this would produce completion for DateTime, because
 * the code analysis does not evaluate the "if". The automatic assist is
 * currently not fixable because the intelligence of Code Assist is limited.
 * Therefore, the @return provides a manual override for this and in this
 * case it is working as expected.
 * 
 * @return DateInterval
 */
function my_single_function()
{
    if (false)
    {
        return new DateTime;
    }
    else
    {
        return new DateInterval('P2Y4DT6H8M');
    }
}

/**
 * Test.
 * 
 * Same as above, the override should work.
 * Naming the return value as "DateInterval[]" should also work
 * because that is the format agreed upon in the PHPDoc community.
 * 
 * @return multitype:DateInterval
 */
function my_array_function()
{
    if (false)
    {
        return array(new DateTime);
    }
    else
    {
        return array(new DateInterval('P2Y4DT6H8M'));
    }
}

my_single_function()-> /* completion for DateInterval as expected */

foreach(my_array_function() as $item)
{
    $item-> /* completion for DateTime, override is broken */
}