PHP 获取器和设置器

使用 PHP 获取器和设置器，您可以自动为您的 PHP 类生成 获取器 和 设置器。

功能

• 生成获取器、设置器或两者均生成
• 可以应用于所有类属性或仅应用于单个属性
• 描述、类型和类型提示将自动从变量 docblock 中发现
• 完全可定制的模板

使用说明

1. 生成 PHP 代码

   class test
   {
       /**
        * foo container
        *
        * @var AbcClass
        */
       private $foo;
   }
   

2. 转到 工具 -> PHP 获取器和设置器

3. 将生成获取器和设置器

   class test
   {
       /**
        * foo container
        *
        * @var AbcClass
        */
       private $foo;
   
       /**
        * Gets the foo container.
        *
        * @return AbcClass
        */
       public function getFoo()
       {
           return $this->foo;
       }
   
       /**
        * Sets the foo container.
        *
        * @param AbcClass $foo the foo
        */
       private function _setFoo(AbcClass $foo)
       {
           $this->foo = $foo;
   
           return $this;
       }
   }
   

正如您所看到的，如果变量注释让您感到麻烦，生成的函数可以不进行修改即可使用。

这是一个节省大量时间的方法！

用法

可用的命令有

• 生成获取器和设置器
• 生成获取器
• 生成设置器
• 为...生成获取器
• 为...生成设置器

这些可以通过上下文菜单（在任何打开的 PHP 文件源上右键单击）或命令板访问。当前打开的文件 必须 是一个 PHP 文件。

设置参考

ignore_visibility

类型 : 布尔型

默认值 : False

说明：生成设置器时忽略可见性

registerTemplates

类型 : 数组

默认值: []

说明：要加载的用户模板

template

类型 : 字符串

默认值: camelCaseFluent

说明：要使用的模板

type_hint_ignore

类型: 字符串列表

默认值: ["mixed", "int",“integer", "double", "float", "number", "string", "boolean", "bool", "numeric", "unknown"]

说明：如果属性具有列出的类型之一，则不使用类型提示

setter_before_getter

类型: 布尔型

默认: false

描述: 将其设置为true以在获取器之前生成设置器代码。

创建您自己的模板

[[包目录]] 是您的 包目录。

• 在 [包目录]/PHP Getters and Setters 下创建一个名为 [包目录]/PHP Getters and Setters/user_templates.py 的目录。

• 将以下内容放入 [包目录]/PHP Getters and Setters/user_templates.py 文件中。“class myTemplate(object): name = "myTemplate” style = 'camelCase' # 也可以是 snakeCase getter = “”“ /**

  • 获取%(描述)s。
  • @返回 %(类型)s */ public function get%(正常名称)s() { return $this->%(名称)s; } ”“”

  setter = “”“ /** * 设置%(描述)s。 * * @参数 %(类型)s $%(名称)s %(人类名称)s * * @返回 self */ public function set%(正常名称)s(%(类型提示)s $%(名称)s) { $this->%(名称)s = $%(名称)s; } ”“”

* Edit the parts between setter and getter how you want.
* Edit your user settings for this package. On OSX that's ```Preferences | Package Settings | PHP Getters and Setters | Settings - User```.
* Add the following settings

// user defined templates to load
"registerTemplates" : [ "myTemplate" ],

// the template used to generate code
"template" : "myTemplate",

* restart sublime to use the new template