https://github.com/codebyzach/sublime_php_constructors
Sublime plugin to auto generate PHP constructors based on the class attributes.
https://github.com/codebyzach/sublime_php_constructors
Last synced: 11 months ago
JSON representation
Sublime plugin to auto generate PHP constructors based on the class attributes.
- Host: GitHub
- URL: https://github.com/codebyzach/sublime_php_constructors
- Owner: CodeByZach
- License: other
- Created: 2018-12-31T20:27:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-09T17:54:27.000Z (almost 3 years ago)
- Last Synced: 2025-02-18T01:40:12.542Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 24.4 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP Constructors
[](https://github.com/CodeByZach/sublime_php_constructors/releases)
PHP Constructors is a Sublime Text plug-in that generates PHP class constructors, automagically.
## Features:
* Generate class constructor.
* Description, type and var name automatically discovered from the variable docblock.
## Usage Instruction:
1. Write your class properties inside your PHP class:
```
class test
{
/**
* @var my\long\namespace Var that holds foo
*/
private $foo;
}
```
2. Go to _Tools > Packages > PHP Constructors_
3. Select _Generate PHP Constructor for Class_
```
class test
{
/**
* @var my\long\namespace Var that holds foo
*/
private $foo;
/**
* Class Constructor
* @param my\long\namespace $foo Var that holds foo
*/
public function __construct($foo)
{
$this->foo = $foo;
}
}
```
Take some time to document your class properties with in following format:
```
class test
{
/**
* @var varType Description of the var
*/
private $foo;
}
```
## Commands
Commands available are:
* Generate PHP Constructor for Class
This command can be accessed via the _Tools > Packages > PHP Constructors_ or via the Command Palette.
## Available Settings
#### optional_constructor_params
_type_ : **boolean**
_default_: **false**
_description_: If set to true, constructors will be generated with optional parameters.
#### ignore_visibility_notation
_type_ : **boolean**
_default_: **false**
_description_: If set to true, will omit underscore prefix common on private variables for constructor parameters.
#### parameter_as_array
_type_ : **boolean**
_default_: **false**
_description_: If set to true, will pass all parameters to the constructor in a single array.