Generate code

Generate constructors

class MyClass {
    public $field;

    /**
    * MyClass constructor.
    * @param $field
    */
    public function __construct($field) {
        $this->field = $field;
    }
}

Generate getters and setters

In the PHP context, getters and setters are generated using the PHP Getter/Setter/Fluent setter file templates. By default, as specified in these templates, setters are generated with the set prefix, and getters with the is or get prefix according to the inferred property type – boolean or non-boolean. The prefix is the value of the ${GET_OR_IS} variable in the default getter template. The templates are configured in the Code tab on the File and Code Templates.

In the main menu, go to Code and select Generate (AltInsert).
In the Generate popup, click one of the following:
- Getter to generate accessor methods for getting the current values of class properties.
- Setter to generate mutator methods for setting the values of class properties.
- Getter and Setter to generate both accessor and mutator methods.
In the Choose Properties dialog, select the fields for which you want to generate getters and setters, and specify the code generation configuration.
- Fluent setters: unselect the checkbox to skip creating a fluent setter, which additionally returns a $this reference to the current class. Consider the following example:
  Regular setter
  class Example { public $foo; public function set_foo($foo): void { $this->foo = $foo; } }
  Fluent setter
  class Example { public $foo; public function set_foo($foo) { $this->foo = $foo; return $this; } }
- Add PHPDoc: unselect the checkbox to skip adding an auto-generated PHPDoc block to the code snippet. To change the scope of generated PHPDoc tags, use the radio buttons.
- Configure: click to configure the order and naming scheme of the generated getters and setters.
  tip
  The same dialog is accessible in the Settings dialog (CtrlAlt0S) . To open it, go to Editor | Code Style | PHP and select the Code Generation tab.

The following code fragment shows the result of generating the getter and setter methods for a class with one field var:

class MyClass
{
    /**
    * @return mixed
    */
    public function getVar() {
        return $this->var;
    }

    /**
    * @param mixed $var
    */
    public function setVar($var): void {
        $this->var = $var;
    }

    public $var;
}

Thanks for your feedback!

Was this page helpful?

Generate code﻿

Generate constructors﻿

Generate a constructor for a class﻿

Generate getters and setters﻿

Regular setter

Fluent setter

tip

Generate code

Generate constructors

Generate a constructor for a class

Generate getters and setters