PHP Class Convention / Style

Hello everyone! After spending some time working through some of the plugins I'm toying around with, I've found myself wondering about code syntax associated with classes. Most of my programming experience is with C++ and while most of the PHP stuff looks very similar, it can be fairly difficult to follow some of the plugin code that I'm looking at.

So to my question. Is there any typical or expected convention or style for classes. In C++ it would look something like this:

Code:

class goofyGoober {
    public:
        int anIntegerVariable;         // This Variable requires public access.
        char aCharacterVariable;     // This Variable requires public access.
    private:
        float aFloatVariable;        // This Variable requires private access.
        bool aTrueFlaseVariable;    // This Variable requires private access.
    protected;
        string aStringVariable;        // This Variable requires protected access.
       
   
    void function someFunction {
        if(called) {
            // Do some stuff
        }
        return;
    }
   
    bool function getSomeThings {
        while (aTrueFlaseVariable) {
            // Do some stuff
        }
        return true;
    }
   
}

What I'm specifically calling out in my example is the declaration of class level variables prior to functions. In C++ it would be possible to declare these anywhere I wanted outside of a function but the convention is as demonstrated. This helps to organize any following functions by giving a reference point ahead. I'm seeing a lot of code in the plugins that don't seem to do this and just declare variables as needed. Am I missing something or is this just the fact that most of this code is written by people who are self taught.

 

Please give an example of the plugins you talk about. Maybe you should read this : http://php.net/manual/en/language.oop5.properties.php

 

Thanks for the link @Eduardo. I've had a chance to read over that and a few of the other documents that the PHP site offers. I think I've found what I was looking for.

One of the plugins I'm currently working on is SimpleHG from Kaleb418. In the Main class there are 7 variables that I would have expected to be declared as class properties:

Code:

cfg                     // Array that holds contents of configuration file
gameRunning             // bool
playersInGame            // Array of players in the match
filledSpawns            // Array of spawn locations in use
gameTask                // gameTimer class object
data                    // Array that holds JSON encoding of signs.json
signs                    // Array that holds signs information from signs.json

Source can be seen here
https://github.com/kaleb418/SimpleHG/blob/master/src/SimpleHG/Main.php

I've modified the beginning source to look like this:

PHP:

class Main extends PluginBase implements Listener{

    public $cfg;
    private $gameRunning;
    public $playersInGame = [Player::class];
    private $filledSpawns = [];
    private $gameTask = GameTimer::class;
    private $recurringMatch;
    private $data;
    private $signs;

    public function __construct() {
        $this->cfg = $this->getConfig();
        $this->gameRunning = false;
        $this->playersInGame = [];
        $this->filledSpawns = [];
        $this->gameTask = null;
        $this->recurringMatch = null;
        $this->data = null;
        $this->signs = null;
    }

I'm still working through the code to determine the access level for each variable.

 

They should be public by default if the property visibility is not set before changing it's value, however that is bad practice, quote:

"If you try to access a class property which hasn't been declared, PHP will issue a notice:

PHP:

class Foo { }

var $fu = new Foo();
echo $fu->baz;

Code:

Notice: Undefined property: Foo::$baz in blah.php on line 4

If you set a value first ($fu->baz = 'blah') then it won't complain, but that's not a great situation.

You should definitely declare all your class variables (unless of course you want to have some fun with the magic methods)..." (nickf, https://stackoverflow.com/questions/1433506/is-it-important-to-explicitly-declare-properties-in-php).

 

Also, just in case someone mentions this; it is okay to SET PROPERTY VALUES in the `__construct` function, just make sure the parameters are empty or PHP will throw an error because PocketMine doesn't pass any parameters when constructing a new plugin base class, event better use the `onLoad` or `onEnable` functions.

 

Excellent information! What you've provided falls in line with my initial expectations. Thank you!