PhpStorm 2025.2 Help

生成代码

PhpStorm 提供多种生成常用代码构造和重复元素的方法,帮助您提高生产力。 这些可以是创建新文件时使用的 文件模板 、根据上下文不同应用的自定义或预定义 实时模板 、各种包装器或字符的自动配对。

此外,PhpStorm 提供 代码补全Emmet支持。

前往 代码 | 生成 Alt+Insert 以打开可生成构造的弹出菜单。

生成构造函数

PhpStorm 可以生成一个构造函数,该构造函数使用对应参数的值来初始化特定的类属性。

为类生成构造函数

  1. 在主菜单中,前往 代码 并选择 生成Alt+Insert)。

  2. 生成 弹出窗口中,单击 构造函数

  3. 如果类包含字段,请选择要由构造函数初始化的字段,然后点击 确定

以下代码片段显示了为类生成构造函数的结果:

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

生成 getter 和 setter

PhpStorm 能为您类中的字段生成存取器和变异器方法(getterssetters)。 生成的方法只有一个参数。

PHP上下文中,getter 和 setter 是使用 PHP Getter/Setter/Fluent setter文件模板生成的。 默认情况下,根据这些模板的指定,setter 使用 set 前缀生成,getter 使用 isget 前缀生成,具体取决于推断的属性类型——booleannon-boolean。 前缀是默认 getter 模板中 ${GET_OR_IS} 变量的值。 这些模板在 代码 选项卡中的 文件和代码模板 中配置。

  1. 在主菜单中,前往 代码 并选择 生成Alt+Insert)。

  2. 生成 弹出窗口中,点击以下其中一项:

    • 获取器 以生成用于获取类属性当前值的访问器方法。

    • 设置器 以生成用于设置类属性值的修改器方法。

    • Getter 和 Setter 以生成访问器和修改器方法。

  3. 选择属性 对话框中,选择要为其生成 getter 和 setter 的字段,并指定代码生成配置。

    选择属性
    • Fluent setter :取消选中复选框以跳过创建 流式 setter,该 setter 还会返回对当前类的 $this 引用。 请参考以下示例:

      class Example { public $foo; public function set_foo($foo): void { $this->foo = $foo; } }
      class Example { public $foo; public function set_foo($foo) { $this->foo = $foo; return $this; } }
    • 添加 PHPDoc :取消选中复选框以跳过向代码片段添加自动生成的 PHPDoc 块。 要更改生成的 PHPDoc 标签的范围,请使用单选按钮。

    • 配置 :单击以配置生成的 getter 和 setter 的顺序和命名方案。

以下代码片段展示了为一个包含一个字段的类生成 getter 与 setter 方法的结果 var

class MyClass { /** * @return mixed */ public function getVar() { return $this->var; } /** * @param mixed $var */ public function setVar($var): void { $this->var = $var; } public $var; }
最后修改日期: 2025年 9月 26日