Generate code
Last modified: 01 December 2022Code | Generate or Alt+Insert
Configure: Ctrl+Alt+S Settings | Editor | File and Code Templates
PhpStorm provides multiple ways to generate common code constructs and recurring elements, which helps you increase productivity. These can be either file templates used when creating a new file, custom or predefined live templates that are applied differently based on the context, various wrappers, or automatic pairing of characters.
Additionally, PhpStorm provides code completion and Emmet support.
From the main menu, select Code | Generate Alt+Insert to open the popup menu with available constructs that you can generate.
Generate constructors
PhpStorm can generate a constructor that initializes specific class properties using values of corresponding arguments.
Generate a constructor for a class
On the Code menu, click Generate Alt+Insert.
In the Generate popup, click Constructor for Kotlin.
If the class contains fields, select the fields to be initialized by the constructor and click OK.
The following code fragment shows the result of generating a constructor for a class:
class MyClass {
public $field;
/**
* MyClass constructor.
* @param $field
*/
public function __construct($field) {
$this->field = $field;
}
}Generate getters and setters
PhpStorm can generate accessor and mutator methods (getters and setters) for the fields in your classes. Generated methods have only one argument.
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.
On the Code menu, click Generate Alt+Insert.
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.
If you need to create a fluent setter, which additionally returns a
$thisreference to the current class, select the Fluent setters checkbox.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;}}Select the fields to generate getters or setters for and click OK.
tip
To customize the order and naming scheme of generated getters and setters, in the Settings dialog (Ctrl+Alt+S), go to Editor | Code Style | PHP and switch to 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!