codebyzach / sublime_php_constructors

Sublime plugin to auto generate PHP constructors based on the class attributes.

PHP Constructors

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.