Created
March 6, 2015 14:08
-
-
Save Addvilz/5f7604224ce0238af7fd to your computer and use it in GitHub Desktop.
phpstorm setter with self reference and correct type hints
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## Editor>File and Code Templates>Code>PHP Setter Method | |
#set($typeHintText = "$TYPE_HINT ") | |
## First we check against a blacklist of primitive and other common types used in documentation. | |
#set($nonTypeHintableTypes = ["", "string", "int", "mixed", "number", "void", "object", "real", "double", "float", "resource", "null", "bool", "boolean"]) | |
#foreach($nonTypeHintableType in $nonTypeHintableTypes) | |
#if ($nonTypeHintableType == $TYPE_HINT) | |
#set($typeHintText = "") | |
#end | |
#end | |
## Make sure the type hint actually looks like a legal php class name(permitting namespaces too) for future proofing reasons. | |
## This is important because PSR-5 is coming soon, and will allow documentation of types with syntax like SplStack<int> | |
#if (!$TYPE_HINT.matches('^((\\)?[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]+)+$')) | |
#set($typeHintText = "") | |
#end | |
## Next, we check if this is using the array syntax like "MyClass[]", and type hint it as a plain array | |
#if ($TYPE_HINT.endsWith("[]")) | |
#set($typeHintText = "array ") | |
#end | |
/** | |
* @param ${TYPE_HINT} $${PARAM_NAME} | |
* @return ${CLASS_NAME} | |
*/ | |
public ${STATIC} function set${NAME}($typeHintText$${PARAM_NAME}) | |
{ | |
#if (${STATIC} == "static") | |
self::$${FIELD_NAME} = $${PARAM_NAME}; | |
#else | |
$this->${FIELD_NAME} = $${PARAM_NAME}; | |
#end | |
return $this; | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment