PHP Getters and Setters
generare getters and setters for php classes
Details
Installs
- Total 56K
- Win 30K
- Mac 12K
- Linux 14K
Oct 12 | Oct 11 | Oct 10 | Oct 9 | Oct 8 | Oct 7 | Oct 6 | Oct 5 | Oct 4 | Oct 3 | Oct 2 | Oct 1 | Sep 30 | Sep 29 | Sep 28 | Sep 27 | Sep 26 | Sep 25 | Sep 24 | Sep 23 | Sep 22 | Sep 21 | Sep 20 | Sep 19 | Sep 18 | Sep 17 | Sep 16 | Sep 15 | Sep 14 | Sep 13 | Sep 12 | Sep 11 | Sep 10 | Sep 9 | Sep 8 | Sep 7 | Sep 6 | Sep 5 | Sep 4 | Sep 3 | Sep 2 | Sep 1 | Aug 31 | Aug 30 | Aug 29 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 0 | 1 | 2 | 0 | 0 | 2 | 1 | 2 | 0 | 0 | 2 | 1 | 0 | 1 | 3 | 0 | 1 | 0 | 1 | 0 | 0 | 1 | 0 | 1 | 4 | 0 | 1 | 1 | 1 | 0 | 1 | 0 | 1 | 1 | 0 | 2 | 1 | 0 | 1 | 2 | 0 | 0 | 0 | 1 |
Mac | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 2 | 2 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 |
Linux | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 1 | 0 | 0 | 2 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 1 | 1 | 0 | 0 | 1 | 0 | 0 | 1 | 1 | 1 | 0 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 1 | 0 | 0 | 1 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
PHP Getters and Setters
With PHP Getters and Setters you can automatically generate Getters and Setters for your php classes.
Features:
- Generate Getters, Setters or Both
- Can be applied to all class properties or just to a single one
- Description, Type and Type Hinting automatically discovered from the variable docblock
- fully customizable templates
Usage Instruction:
Generate PHP code
class test { /** * foo container * * @var AbcClass */ private $foo; }
Go to Tools -> PHP Getters and Setter
Getter and Setter will be generated:
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; } }
As you can see if get to trouble of commenting your variables, the generated functions can be used without modification.
This is an huge time saver!
Usage
Commands available are:
- Generate Getters and Setters
- Generate Getter
- Generate Setter
- Generate Getter for…
- Generate Setter for…
These can be accesed via the context menu (right click on the source of any open PHP file) or the command pallette. The currently open file must be a PHP file.
Settings Reference
ignore_visibility
type : boolean
default : false
description: ignore visibilty for setters generation
registerTemplates
type : array
default: []
description: the user templates to load
template
type : string
default: camelCaseFluent
description: the template to use
type_hint_ignore
type: list of strings
default: [“mixed”, “int”,“integer”, “double”, “float”, “number”, “string”, “boolean”, “bool”, “numeric”, “unknown”]
description: if the property has one of the types listed type hinting will not be used
setter_before_getter
type: boolean
default: false
description: Set to true to generate setter code before getters
Creating your own template
[package-dir] is your package directory.
- Make a directory called
[package-dir]/PHP Getters and Setters
. Put the following in a file at
[package-dir]/PHP Getters and Setters/user_templates.py
. “ class myTemplate(object): name = "myTemplate” style = 'camelCase' # can also be snakeCase getter = “”“ /**- Gets the %(description)s. *
- @return %(type)s */ public function get%(normalizedName)s() { return $this->%(name)s; } ”“”
setter = “”“ /** * Sets the %(description)s. * * @param %(type)s $%(name)s the %(humanName)s * * @return self */ public function set%(normalizedName)s(%(typeHint)s $%(name)s) { $this->%(name)s = $%(name)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