自定義代碼片段 · php常用實例

# 創建和編輯動態模板在這個頁面中： * [介紹](http://www.hmoore.net/ervinhua/phpstorm/441772#%E4%BB%8B%E7%BB%8D) * [修改現有模板](http://www.hmoore.net/ervinhua/phpstorm/441772#%E4%BF%AE%E6%94%B9%E7%8E%B0%E6%9C%89%E6%A8%A1%E6%9D%BF) * [從頭創建新的動態模板](http://www.hmoore.net/ervinhua/phpstorm/441772#%E4%BB%8E%E5%A4%B4%E5%88%9B%E5%BB%BA%E6%96%B0%E7%9A%84%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF) * [從文本片段創建新的動態模板](http://www.hmoore.net/ervinhua/phpstorm/441772#%E4%BB%8E%E6%96%87%E6%9C%AC%E7%89%87%E6%AE%B5%E5%88%9B%E5%BB%BA%E6%96%B0%E7%9A%84%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF) * [搜索動態模板列表](http://www.hmoore.net/ervinhua/phpstorm/441772#%E6%90%9C%E7%B4%A2%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF%E5%88%97%E8%A1%A8) * [重置為默認](http://www.hmoore.net/ervinhua/phpstorm/441772#%E9%87%8D%E7%BD%AE%E4%B8%BA%E9%BB%98%E8%AE%A4) ## 介紹 PhpStorm自帶一套預定義[動態模板](http://www.hmoore.net/%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8/%E5%B8%B8%E8%A7%84%E6%8C%87%E5%8D%97/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/README.md)。你可以按原樣使用它們，或者根據需要修改它們。如果你想創建一個新的動態模板，在拷貝現有模板的基礎上，或者從代碼中的片段。如果一個模板已經被修改，它總是可以被重置為默認設置。 ## 修改現有模板 **要修改現有模板** 1. 在設置參數對話框，打開[動態模板](http://www.hmoore.net/%E5%8F%82%E8%80%83/%E8%AE%BE%E7%BD%AE%E5%8F%82%E6%95%B0%E5%AF%B9%E8%AF%9D%E6%A1%86/%E7%BC%96%E8%BE%91%E5%99%A8/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/README.md)頁面。 2. 展開目標模板組，并選擇要修改的模板。 3. 在[模板文本](http://www.hmoore.net/%E5%8F%82%E8%80%83/%E8%AE%BE%E7%BD%AE%E5%8F%82%E6%95%B0%E5%AF%B9%E8%AF%9D%E6%A1%86/%E7%BC%96%E8%BE%91%E5%99%A8/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/README.md#%E6%A8%A1%E6%9D%BF%E7%BC%96%E8%BE%91%E5%8C%BA%E5%9F%9F)區域，根據需要修改[模板縮寫](http://www.hmoore.net/%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8/%E5%B8%B8%E8%A7%84%E6%8C%87%E5%8D%97/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF%E7%BC%A9%E5%86%99.md) 4. 在**Template Text**字段，編輯模板主體，可能包含純文本或這種格式`$<variable name>$`的變量. 當編輯動態模板變量時，注意以下有用的提示： * 如果你在模板文本需要(`$`)符號，可以通過重復這個字符(`$$`)來顯示。 * 要改變模板中的變量，點擊**Edit Variables**并按照[創建和編輯模板變量](http://www.hmoore.net/%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8/%E5%B8%B8%E8%A7%84%E6%8C%87%E5%8D%97/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/%E5%88%9B%E5%BB%BA%E5%92%8C%E7%BC%96%E8%BE%91%E6%A8%A1%E6%9D%BF%E5%8F%98%E9%87%8F.md)章節的描述配置變量。 **Edit Variables**按鈕僅在模板主體中包含至少一個用戶定義變量時可用，也就是說，和`$END$`或`$SELECTION$`不同的變量。 ### 關于預定義模板變量的邊注 PhpStorm支持兩種預定義動態模板變量：`$END$`和`$SELECTION$`。你不能編輯預定義動態模板變量`$END$`和`$SELECTION$`。 * `$END`表明光標的位置在展開的模板之后。例如，模板`return $END$;`將展開到： ~~~ return ; ~~~ 光標位置在分號之前。 * `$SELECTION$`用在**環繞模板**中并且用來代表要被包圍的代碼片段。在模板展開之后，被選中的文本將在模板中被圍繞。例如，如果你在代碼中選擇`EXAMPLE`并調用`"$SELECTION$"`模板(通過分配的縮寫或按下`Ctrl+Alt+T`并從列表中選擇目標的模板)，PhpStorm將用兩個引號包圍選中的部分，就像下面： ~~~ "EXAMPLE" ~~~ 5. 在**Option**部分，指定模板將如何展開并被重新格式化。 6. 在**Available in**部分，指定在編輯器中可以感知模板縮寫的語言和代碼位置。 7. 準備好后點擊**OK** ## 從頭創建新的動態模板 **從頭創建新的動態模板** 1. 在設置參數對話框，打開[動態模板](http://www.hmoore.net/%E5%8F%82%E8%80%83/%E8%AE%BE%E7%BD%AE%E5%8F%82%E6%95%B0%E5%AF%B9%E8%AF%9D%E6%A1%86/%E7%BC%96%E8%BE%91%E5%99%A8/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/README.md)頁面，并展開要創建的新模板所處的模板組。 2. 點擊![新增](http://image.jellychen.cn/uploads/2016/11/new.png)。一個新的模板項目被添加到組中并將焦點移動到[模板文本](http://www.hmoore.net/%E5%8F%82%E8%80%83/%E8%AE%BE%E7%BD%AE%E5%8F%82%E6%95%B0%E5%AF%B9%E8%AF%9D%E6%A1%86/%E7%BC%96%E8%BE%91%E5%99%A8/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/README.md#%E6%A8%A1%E6%9D%BF%E7%BC%96%E8%BE%91%E5%8C%BA%E5%9F%9F)區域. 3. 指定新模板的縮寫，輸入模板主體，定義變量和模板組，配置選項，按照[模板修改](http://www.hmoore.net/ervinhua/phpstorm/441772#%E4%BF%AE%E6%94%B9%E7%8E%B0%E6%9C%89%E6%A8%A1%E6%9D%BF)規程的描述。 4. 準備好后點擊**OK** ## 從文本片段創建新的動態模板 **要從文本片段創建新的動態模板** 1. 在編輯器中，選擇要創建為動態模板的代碼段。 2. 在主菜單，選擇**Tools | Save as Live Template**。然后[動態模板](http://www.hmoore.net/%E5%8F%82%E8%80%83/%E8%AE%BE%E7%BD%AE%E5%8F%82%E6%95%B0%E5%AF%B9%E8%AF%9D%E6%A1%86/%E7%BC%96%E8%BE%91%E5%99%A8/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/README.md)頁面打開了，焦點在[模板文本](http://www.hmoore.net/%E5%8F%82%E8%80%83/%E8%AE%BE%E7%BD%AE%E5%8F%82%E6%95%B0%E5%AF%B9%E8%AF%9D%E6%A1%86/%E7%BC%96%E8%BE%91%E5%99%A8/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/README.md#%E6%A8%A1%E6%9D%BF%E7%BC%96%E8%BE%91%E5%8C%BA%E5%9F%9F)區域。 3. 在**Abbreviation**字段，輸入識別你的新動態模板的縮寫。 4. 指定新模板的縮寫，輸入模板主體，定義變量和模板組，配置選項，按照[模板修改](http://www.hmoore.net/ervinhua/phpstorm/441772#%E4%BF%AE%E6%94%B9%E7%8E%B0%E6%9C%89%E6%A8%A1%E6%9D%BF)規程的描述。 5. 準備好后點擊**OK** ## 搜索動態模板列表 **要搜索動態模板列表** * 在[動態模板](http://www.hmoore.net/%E5%8F%82%E8%80%83/%E8%AE%BE%E7%BD%AE%E5%8F%82%E6%95%B0%E5%AF%B9%E8%AF%9D%E6%A1%86/%E7%BC%96%E8%BE%91%E5%99%A8/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/README.md)頁面，輸入任意字符串，這些字符串是你想要的模板中縮寫，主體或描述的一部分。 PhpStorm顯示所有匹配的模板： ![顯示匹配的模板](http://image.jellychen.cn/uploads/2016/11/SpeedSearchInLiveTemplates.png) ## 重置為默認 **要重置模板的設置為默認** 注意，修改后的模板的顯示顏色是藍色的。 1. 在[動態模板](http://www.hmoore.net/%E5%8F%82%E8%80%83/%E8%AE%BE%E7%BD%AE%E5%8F%82%E6%95%B0%E5%AF%B9%E8%AF%9D%E6%A1%86/%E7%BC%96%E8%BE%91%E5%99%A8/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/README.md)頁面，右鍵單擊一個修改后的模板來顯示出上下文菜單 2. 選擇這個修改后模板的上下文菜單中的**Restore defaults** # 創建和編輯模板變量在這個頁面中： * [基礎](http://www.hmoore.net/ervinhua/phpstorm/441773#%E5%9F%BA%E7%A1%80) * [在模板中配置和使用變量](http://www.hmoore.net/ervinhua/phpstorm/441773#%E5%9C%A8%E6%A8%A1%E6%9D%BF%E4%B8%AD%E9%85%8D%E7%BD%AE%E5%92%8C%E4%BD%BF%E7%94%A8%E5%8F%98%E9%87%8F) * [在動態模板變量中使用的預定義變量](http://www.hmoore.net/ervinhua/phpstorm/441773#%E5%9C%A8%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF%E5%8F%98%E9%87%8F%E4%B8%AD%E4%BD%BF%E7%94%A8%E7%9A%84%E9%A2%84%E5%AE%9A%E4%B9%89%E5%8F%98%E9%87%8F) ## 基礎在一個[模板](http://www.hmoore.net/%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8/%E5%B8%B8%E8%A7%84%E6%8C%87%E5%8D%97/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/README.md)展開之后，它的變量編輯器中呈現為輸入區域。這些區域的值可以被用戶編輯或者被PhpStorm計算填充。要讓它自動完成，每個變量你需要指定下面： * 表達式，與變量相關的表達式來被計算 * 默認值，如果計算失敗那么輸入區域要被寫入的默認值 PhpStorm中展開表達式之后輸入區域的處理順序，取決于列表中變量的順序。 **在模板中配置和使用變量** 1. [打開模板設置](http://www.hmoore.net/%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8/%E5%B8%B8%E8%A7%84%E6%8C%87%E5%8D%97/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/%E5%88%9B%E5%BB%BA%E5%92%8C%E7%BC%96%E8%BE%91%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF.md)，然后在[模板文本](http://www.hmoore.net/%E5%8F%82%E8%80%83/%E8%AE%BE%E7%BD%AE%E5%8F%82%E6%95%B0%E5%AF%B9%E8%AF%9D%E6%A1%86/%E7%BC%96%E8%BE%91%E5%99%A8/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/README.md#%E6%A8%A1%E6%9D%BF%E7%BC%96%E8%BE%91%E5%8C%BA%E5%9F%9F)區域點擊**Edit Variables**按鈕。 **Edit Variables**按鈕僅在模板主體中包含至少一個用戶定義變量時可用，也就是說，和`$END$`或`$SELECTION$`不同的變量。 [編輯模板變量對話框](http://www.hmoore.net/%E5%8F%82%E8%80%83/%E8%AE%BE%E7%BD%AE%E5%8F%82%E6%95%B0%E5%AF%B9%E8%AF%9D%E6%A1%86/%E7%BC%96%E8%BE%91%E5%99%A8/%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF/%E7%BC%96%E8%BE%91%E6%A8%A1%E6%9D%BF%E5%8F%98%E9%87%8F%E5%AF%B9%E8%AF%9D%E6%A1%86.md)打開了，在這你可以定義當模板使用時變量將被如何處理。 2. 在**Name**文本框，指定要在模板主體中使用的變量名。 3. 在**Expression**下拉列表中，指定要被PhpStorm計算的表達式當模板展開后。執行以下操作之一： * 輸入一個在兩個引號中的字符串常量 * 輸入一個預定義函數及可能的參數或者從下拉列表中選擇一個一個函數的參數可能是一個常量或者另一個預定義函數。參見頁面下方的[預定義函數列表](http://www.hmoore.net/ervinhua/phpstorm/441773#%E5%9C%A8%E5%8A%A8%E6%80%81%E6%A8%A1%E6%9D%BF%E5%8F%98%E9%87%8F%E4%B8%AD%E4%BD%BF%E7%94%A8%E7%9A%84%E9%A2%84%E5%AE%9A%E4%B9%89%E5%8F%98%E9%87%8F)。 4. 要啟用PhpStorm來處理下一個輸入區域，如果一個輸入區域關聯的當前變量已經定義，選擇**Skip if defined**復選框 5. 要安排PhpStorm切換變量相應的輸入框的順序，使用**Move Up**或**Move Down**按鈕。 ## 在動態模板變量中使用的預定義變量 | **Item** | **Description** | | --- | --- | | `camelCase(String)` | 返回作為參數傳遞的字符串，轉換為駝峰式寫法。例如`my-text-file`/`my text file`/`my_text_file`將被轉換為`myTextFile` | | `capitalize(String)` | 將作為參數傳遞的名字的首字母大寫 | | `capitalizeAndUnderscore(sCamelCaseName)` | 將作為參數傳來的駝峰式名字轉為首字母大寫，并在單詞重建插入下劃線。例如，如果傳來的參數是`FooBar`，那么函數返回`FOO_BAR`。 | | `classNameComplete()` | 這個表達式用來在變量位置替換[類名稱](http://www.hmoore.net/%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8/%E5%B8%B8%E8%A7%84%E6%8C%87%E5%8D%97/%E4%BB%A3%E7%A0%81%E8%A1%A5%E5%85%A8/README.md) | | `clipboard()` | 返回系統剪貼板的內容 | | `snakeCase(String)` | 從蛇形字符串返回駝峰式寫法的字符串。例如，如果傳來的參數字符串是`foo_bar`，函數將返回`fooBar`。 | | `complete()` | 這個表達式在變量位置代替行使代碼補全 | | `completeSmart()` | 這個表達式在變量位置代替行使只能類型補全 | | `date(sDate)` | 用指定格式返回當前系統日期。默認的，當前日期被返回為系統默認格式。然而，如果你用兩個引號指定日期格式，日期將被呈現為指定格式： ![指定日期格式](http://image.jellychen.cn/uploads/2016/11/date_format.png) | | `decapitalize(sName)` | 用相應的小寫字母替換作為參數傳遞的名字的首字母。 | | `enum(sCompletionString1,sCompletionString2,...)` | 用逗號分隔的字符串建議作為模板調用時的完成列表 | | `escapeString(sEscapeString)` | 避開指定的字符串 | | `expectedType()` | 返回整個模板期望的類型。這是有道理的，如果模板在正確的位置展開，在返回之后，等等 | | `fileName(sFileName)` | 返回帶擴展名的文件名 | | `fileNameWithoutExtension()` | 返回文件名不要擴展名 | | `firstWord(sFirstWord)` | 返回作為參數傳遞的字符串的第一個單詞 | | `lineNumber()` | 返回當前行號 | | `lowercaseAndDash(String)` | 返回作為參數傳遞的字符串以用破折號分隔的小寫形式。例如，字符串`MyExampleName`轉換為`my-example-name` | | `snakeCase(sCamelCaseText)` | 從駝峰式寫法的字符串返回蛇形字符串 | | `spaceSeparated(String)` | 傳遞來的駝峰式字符串轉換為空格分隔的單詞。例如，如果川里來的字符串參數是`fooBar`，那么返回值就是`foo bar` | | `time(sSystemTime)` | 放回當前系統時間。 | | `timestamp()` | 這個參數沒有參數，返回的是1970-1-1到現在的毫秒時間。參考文章[Ubix time](https://en.wikipedia.org/wiki/Unix_time) | | `underscoresToCamelCase(sCamelCaseText)` | 從下環線分隔的字符串轉換為駝峰式寫法，例如，如果傳來的參數是`foo_bar`，那么函數返回值就是`fooBar` | | `underscoresToSpaces(sParameterWithSpaces)` | 從下環線分隔的字符串轉換為空格分隔式寫法 | | `user()` | 返回當前用戶名稱 | | `JsArrayVariable` | 返回當前JavaScript數組名稱 | | `jsClassName()` | 返回JavaScript類名稱 | | `jsComponentType` | 返回當前JavaScript組件類型 | | `jsMethodName()` | 返回當前JavaScript方法名稱 | | `jsQualifiedClassName` | 返回當前JavaScript類的完整名稱 | | `jsSuggestIndexName` | 返回索引的建議名稱 | | `jsSuggestVariableName` | 返回變量的建議名稱 | 3.