Using DocBlocks - how to indicate that a function returns a value only in some conditions?

Question

I have this function:

public function createController()
{
    $valid_controller = class_exists($this->controllerClass)
                    &&  in_array("BaseController", class_parents($this->controllerClass));

    if($valid_controller)
    {
        return new $this->controllerClass($this->urlData["action"]);
    }
    else
    {
        $error = new ErrorController("badurl");
    }
}

and I want to create a DocBlock that describe it. This function returns a controller object only if the required controller is valid, and if not, it creates an instace of the ErrorController class, but does not return a value. How can I right a proper @return tag for this function?

`@return null|ControllerClass text description or explanation here` — Mark Baker, Nov 02 '15 at 09:39
Why not `null|object`? And please put your answer in... well, an answer, so I can accept it. :) — Michael Haddad, Nov 02 '15 at 11:49
Because `object` doesn't have any specific meaning.... you should use an actual interface or object name, that can then be picked up by an IDE — Mark Baker, Nov 02 '15 at 11:54

score 1 · Accepted Answer · answered Nov 02 '15 at 11:55

1

PHPDocumentor Docs say to use

@return  null|ControllerClass    text description or explanation here

answered Nov 02 '15 at 11:55

Mark Baker

209,507
32
346
385

But the `ControllerClass` is a property, and is not constant. So how can i refer to it specifically, since it changes every time? – Michael Haddad Nov 02 '15 at 14:54
What object type is returned? There must be some commonality of inheritance or interface between all your controllers. `BaseController` perhaps? – Mark Baker Nov 02 '15 at 14:56
1

In that case `null|BaseController` – Mark Baker Nov 02 '15 at 14:58
Ok. Thank you very much! – Michael Haddad Nov 02 '15 at 14:58

Using DocBlocks - how to indicate that a function returns a value only in some conditions?

1 Answers1