CODEWITHSUNDEEP
phpoopreadabilitypublic-method
dirtside
dirtside

Reputation: 8290

"public static" or "static public"?

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.)

Upvotes: 49

Views: 28126

Answers (7)

PressingOnAlways
PressingOnAlways

Reputation: 12386

From PSR-2:

Visibility MUST be declared on all properties and methods; abstract and final MUST be declared before the visibility; static MUST be declared after the visibility. [reference]

...if you are one to care about the PHP Framework Interop Group standard and conventions.

So public static not static public according to them.

Upvotes: 61

JW.
JW.

Reputation: 4951

Further to Alexei Tenitski's answer. 

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

All methods ought to have their visibility specified. So, we know that every method is going to have that mentioned somehere in the definition, the only question is "Which setting is it?".

Only some are static - so, for each one we have to ask "Is there a mention of the static keyword somewhere in the definition?". So, put static first to make the answer to that question more obvious.

Or, as a wider rule , ......... I tend to put 'the most extraordinary aspect first' so that I don't don't subsconsciously skip over things when reading them. ;o)

Try this test.

Very quickly...How many static methods are there in Class A?

class A {
 public static methodA() {
  }
 protected static methodB() {
  }
 private staticlymethodC() {
  } 
}

and how many static methods are there in Class B?

class B {
 public methodA() {
  }
 static protected methodB() {
  }
 static private methodC() {
  } 
}

I think class B is much easier to understand quickly.

Upvotes: 15

Alexei Tenitski
Alexei Tenitski

Reputation: 9370

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

Upvotes: 6

thomasrutter
thomasrutter

Reputation: 117411

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.

Upvotes: 2

Andrew Hare
Andrew Hare

Reputation: 351758

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.

Upvotes: 47

chaos
chaos

Reputation: 124365

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

Upvotes: 5

Greg D
Greg D

Reputation: 44096

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.

Upvotes: 9

Related Questions