getStatus() should be returning a string

[MegaphoneJon]

Overview

CRM_Core_Session::getStatus() has a docblock that says it returns an array. However, it can also return NULL. This fixes that.

Before

$status initialized to NULL.

After

$status initialized to a blank string. Return type specified.

Comments

When a return type is specified, should we remove the @return from the docblock?

[civibot]

(Standard links)

• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[demeritcowboy]

When a return type is specified, should we remove the @return from the docblock?

No leave it in there, except in this case the docblock is wrong. It's an array (see setStatus, which behaves more like an "addStatus")

[eileenmcnaughton]

@demeritcowboy @MegaphoneJon so this is mergable if the docblock is fixed?

[demeritcowboy]

Yes. I may have caused some confusion by saying "leave it in there" - I meant both docblocks and typehints are useful to have, but should be in alignment.

[eileenmcnaughton]

Thanks @demeritcowboy & yep agree

[demeritcowboy]

@MegaphoneJon This just needs a tiny docblock update.