views:

829

answers:

6

A minor point about function declaration keywords in PHP: If you've got a class method that's static, should the static keyword come before or after the visibility keyword (public, protected, private)? Assuming all your methods, static or otherwise, have a visibility keyword, then you'd want the visibility keyword to remain in the same place relative to the function keyword:

public function foo() {}

public function bar() {}

protected function baz() {}

private function quux() {}

Now pretend a couple are static:

public function foo() {}

static public function bar() {}

protected function baz() {}

static private function quux() {}

Also, if a method is static, you want that to be the first thing seen, because that has more of an impact on what kind of method it is than even the visibility keyword does.

This is strictly a readability issue, as it obviously has no functional or design consequences. (That I can think of.)

+14  A: 

Languages like Java and C# require that the access modifier come first so Edit: The previous struck line is completely false. Neither language has this requirement.


public static

looks correct to me. Arguments can be made for both approaches and mine is this: Since "static" qualifies the function rather than the access modifier it makes more sense to say

<access_modifier> static

If you use it the other way around the meaning of "static" is less clear.

Andrew Hare
*Neither* Java *nor* C# require this. I believe they *recommend* it, but "static public" is valid in both languages. (I've just compiled a test program to check.)
Jon Skeet
(Undone my downvote though, as the rest is fair enough - and I certainly agree that "public static" looks more reasonable.)
Jon Skeet
Yikes! My mistake - you are correct!
Andrew Hare
+4  A: 

I don't think that this is a strictly PHP question, and for what little it's worth, I've always preferred the consistency of placing the visibility modifier first. I find it easier to scan.

Greg D
+3  A: 

I put visibility first in every language I use that has type modifiers.

chaos
A: 

You are correct in that it has no effect on the code. Therefore it is up to your own style requirements, or those of your team, as to what you do. Consult with them and agree on a style.

If you are coding for yourself only, then you should choose for yourself. The choice is not important, but consistency is.

Another question you may ask is: should you use 'public' or not? For backwards compatibility (PHP4 had no information hiding) anything without a visibility modifier is public by default. Should you bother writing public if it's public? Again personal choice: make a strong argument either way and you'll convince me your choice is best.

Personally, when I go through and clean up my own code, I like to put the visibility modifier first, and specify it even if it's public.

thomasrutter
I've considered omitting 'public' since it's technically redundant, but I find it's better to be explicit. That way when I come back to my code six months later, I don't have to wonder why there's no access keyword on method foo(); did I just forget to put one there, or did I mean for it to be public?
dirtside
good point ☻
thomasrutter
A: 

Thanks for the input, guys. I guess 'public static' is really the most common format, so I may as well go with that. I asked the other devs in my office, too, and they were unanimously in favor of 'public static'. So much for my idea :)

dirtside
A: 

I prefer static public since this way it is easier to spot [usually rare] static methods in classes.

alexeit