IntelliJ IDEA：Drupal的使用

Drupal

此功能僅在Ultimate版本中受支持。

您可以將IntelliJ IDEA用作Drupal開發(fā)的IDE，包括模塊，主題和核心。支持的版本是6，7和8。

IntelliJ IDEA在開發(fā)Drupal模塊和核心時提供Symfony2和Drupal 8之間的集成。

開始之前 

在使用Drupal之前，請?jiān)诓寮撁嫔习惭b并啟用PHP和Drupal支持存儲庫插件。

下載并安裝Drupal 

從Drupal官方網(wǎng)站下載Drupal并按照Drupal安裝說明中的說明進(jìn)行安裝。

在IntelliJ IDEA中設(shè)置Drupal項(xiàng)目

選項(xiàng)1：使用Drupal模塊創(chuàng)建IntelliJ IDEA項(xiàng)目

您可以通過Drupal Module模板創(chuàng)建IntelliJ IDEA項(xiàng)目，該項(xiàng)目將根據(jù)Drupal要求進(jìn)行設(shè)置和配置。

IntelliJ IDEA根據(jù)所選的Drupal版本生成并配置項(xiàng)目存根。對于Drupal 8，生成module_name.info.yml文件。

1. 打開“新建項(xiàng)目”對話框，選擇：文件|新建|項(xiàng)目，或者在歡迎界面上單擊“創(chuàng)建新項(xiàng)目”。
2. 選擇項(xiàng)目類型和位置 在左側(cè)窗格中，單擊列表中的PHP，然后在右側(cè)窗格中選擇Drupal Module，然后單擊“下一步”。在向?qū)У牡诙撋?，指定?xiàng)目名稱以及將在其中創(chuàng)建項(xiàng)目的文件夾。
3. 選擇要使用的Drupal安裝 指定Drupal安裝的根文件夾并選擇要使用的Drupal版本，支持的版本是6,7和8。稍后您可以更改Drupal安裝并在“框架”頁面上重新配置包含路徑。
4. 配置包含路徑 選擇“設(shè)置PHP|包含路徑”復(fù)選框以使Drupal包含為項(xiàng)目自動配置的路徑。當(dāng)你離開對話框，下列路徑將被添加到包括路徑列表中的PHP頁面：<drupal installation root>/includes，<drupal installation root>/modules，和<drupal installation root>/sites/all/modules

選項(xiàng)2：導(dǎo)入現(xiàn)有的Drupal模塊

當(dāng)您打開現(xiàn)有的Drupal模塊時，IntelliJ IDEA會識別Drupal特定的結(jié)構(gòu)，并建議激活Drupal支持。

1. 打開你的項(xiàng)目單擊歡迎屏幕上的“打開”或在主菜單上選擇：文件|打開，然后選擇存儲Drupal模塊的文件夾。IntelliJ IDEA檢測特定于Drupal的結(jié)構(gòu)并顯示通知：
2. 啟用Drupal支持 單擊通知中的“啟用”。在打開的Drupal Module對話框中，選擇“啟用Drupal集成”復(fù)選框并按照使用Drupal模塊創(chuàng)建項(xiàng)目時繼續(xù)：指定Drupal安裝的根文件夾，選擇要使用的版本，并配置包含路徑。

無論是在現(xiàn)有的IntelliJ IDEA項(xiàng)目中啟用Drupal支持還是使用Drupal模塊創(chuàng)建新項(xiàng)目，IntelliJ IDEA都會檢查是否為Drupal開發(fā)正確配置了開發(fā)環(huán)境。

在事件日志工具窗口中報(bào)告任何檢測到的不一致，并作為彈出窗口針對每個差異，IntelliJ IDEA建議修復(fù)。要應(yīng)用建議，請單擊報(bào)告的事件旁邊的鏈接。

將Drupal特定文件與PHP文件類型相關(guān)聯(lián)

IntelliJ IDEA將文件識別并視為php文件，并根據(jù)文件類型關(guān)聯(lián)提供代碼突出顯示。

選項(xiàng)1：使用事件日志 

• 在“事件日志”工具窗口中，單擊消息Drupal support: <*.file extension> files are not associated with PHP file type旁邊的“修復(fù)”。

選項(xiàng)2：使用“文件類型”頁面 

• 在“設(shè)置/首選項(xiàng)”對話框（Ctrl+Alt+S）中，導(dǎo)航到：編輯器|文件類型。

  在打開的“文件類型”頁面上，在“已注冊的模式” 區(qū)域中定義文件掩碼 。

更改Drupal設(shè)置

選項(xiàng)1：啟用或禁用Drupal集成

• 在“設(shè)置/首選項(xiàng)”對話框（Ctrl+Alt+S）中，導(dǎo)航到“語言和框架|PHP|框架。在打開的“框架”頁面上，切換“啟用Drupal集成”復(fù)選框以激活或停用當(dāng)前IntelliJ IDEA項(xiàng)目中的Drupal。 

• 要使用另一個Drupal安裝，請鍵入相關(guān)安裝文件夾的路徑。如有必要，請更改版本。

選項(xiàng)2：更新包含路徑

• 在“設(shè)置/首選項(xiàng)” 對話框（Ctrl+Alt+S）中，導(dǎo)航到：語言和框架|PHP。

  在打開的PHP頁面上，在“包含路徑”區(qū)域中進(jìn)行所需的更改。

在IntelliJ IDEA中使用Drupal鉤子

IntelliJ IDEA在.module文件中提供Drupal鉤子的完全本機(jī)支持。 

• 使用代碼完成來進(jìn)行鉤子聲明

  IntelliJ IDEA索引任何鉤子調(diào)用，因此在代碼完成中鉤子名稱可用于創(chuàng)建鉤子實(shí)現(xiàn)。要完成聲明，請開始鍵入鉤子名稱并按下Ctrl+Space。

  

• 導(dǎo)航到鉤子調(diào)用

  • 要從編輯器導(dǎo)航到鉤子調(diào)用，請單擊裝訂線中的圖標(biāo)。

  • 在多次調(diào)用的情況下，IntelliJ IDEA會顯示可用的鉤子調(diào)用列表，以便您可以選擇跳轉(zhuǎn)到哪一個。

    

    您將被導(dǎo)航到使用module_invoke_all()，module_invoke()或drupal_alter()調(diào)用的相關(guān)的鉤子的行。

• 查看鉤子文檔

  將光標(biāo)定位在鉤子的名稱上，然后選擇：視圖|快速文檔查找，或按下Ctrl+Q。

在IntelliJ IDEA項(xiàng)目中設(shè)置Drupal代碼樣式

如果項(xiàng)目被識別為Drupal模塊，或者在現(xiàn)有項(xiàng)目中啟用Drupal集成，或者使用Drupal模塊創(chuàng)建新項(xiàng)目，IntelliJ IDEA會自動提供應(yīng)用預(yù)配置的Drupal編碼標(biāo)準(zhǔn)（代碼樣式）。但是，您可以隨時在“設(shè)置”對話框的“代碼樣式：PHP”頁面上更改或自定義此設(shè)置。

在項(xiàng)目中使用預(yù)先配置的Drupal代碼樣式

• 在“事件日志”工具窗口中，單擊Drupal-style formatting can be set for this project旁邊的“設(shè)置”。

您還可以在“代碼樣式：PHP”頁面上設(shè)置預(yù)定義代碼樣式。在“設(shè)置/首選項(xiàng)” 對話框（Ctrl+Alt+S）中，導(dǎo)航到“編輯器|代碼風(fēng)格|PHP。然后，單擊“設(shè)置自”并選擇：預(yù)定義|Drupal。

如果適用，請使用頁面上的控件自定義代碼樣式。

根據(jù)Drupal編碼標(biāo)準(zhǔn)檢查代碼 

使用IntelliJ IDEA，您可以結(jié)合Coder使用PHP Code Sniffer工具檢測編碼標(biāo)準(zhǔn)問題，Coder為PHP Code Sniffer提供了一組Drupal特定標(biāo)準(zhǔn)。這將確保您的代碼干凈，一致并且沒有一些常見錯誤。

首先，使用安裝和配置PHP Code Sniffer中描述的任何技術(shù)安裝PHP Code Sniffer?？赡茏詈唵蔚姆椒ㄊ鞘褂肅omposer安裝它 。

安裝PHP Code Sniffer

1. 從composer.json的上下文菜單中，選擇：Composer|管理依賴關(guān)系，或者從主菜單選擇：工具|Composer|管理依賴項(xiàng)。

2. 在打開的“管理Composer依賴關(guān)系”對話框中，可以使用搜索字段從Available Packages列表中選擇squizlabs/php_codesniffer包。

   從要安裝的版本列表中選擇相關(guān)版本。

3. 如有必要，請展開“設(shè)置隱藏”區(qū)域并指定高級安裝選項(xiàng)。在“命令行參數(shù)”字段中，鍵入其他命令行參數(shù)。建議提供--dev：選項(xiàng)：在這種情況下，包將添加到composer.json文件的require-dev部分而不是默認(rèn)的require部分。 

4. 單擊“安裝”。

接下來，安裝Coder，它將為PHP Code Sniffer提供Drupal特定標(biāo)準(zhǔn)。

安裝編碼器 

1. 從composer.json的上下文菜單中，選擇：Composer|管理依賴關(guān)系，或者從主菜單選擇：工具|Composer|管理依賴關(guān)系。

2. 在打開的“管理Composer依賴關(guān)系”對話框中，可以使用搜索字段從Available Packages列表中選擇drupal/coder包。

   從要安裝的版本列表中選擇相關(guān)版本。

3. 如有必要，請展開“設(shè)置隱藏”區(qū)域并指定高級安裝選項(xiàng)。在“命令行參數(shù)”字段中，鍵入其他命令行參數(shù)。建議提供--dev：選項(xiàng)：在這種情況下，包將添加到composer.json文件的require-dev部分而不是默認(rèn)的require部分。

4. 單擊“安裝”。

所述編碼器包將被安裝，以及相應(yīng)的Drupal標(biāo)準(zhǔn)將被選擇用于PHP代碼嗅探器驗(yàn)證自動檢查。如有必要，您可以在“設(shè)置/首選項(xiàng)”對話框（Ctrl+Alt+S）的“編輯器|檢查”頁面上進(jìn)一步自定義檢查。

從IntelliJ IDEA查看Drupal API文檔

在IntelliJ IDEA編輯器中，選擇您感興趣的符號，然后從上下文菜單中選擇“在Drupal API中搜索”。在Drupal的API文檔打開。

使用IntelliJ IDEA中的Drush命令行工具

1. 按照https://github.com/drush-ops/drush中的說明下載并安裝Drush。

2. 將Drush配置為命令行工具：

   • 在“設(shè)置/首選項(xiàng)” 對話框（Ctrl+Alt+S）中，導(dǎo)航到：工具|命令行工具支持。

   • 在打開的“命令行工具支持”頁面上，指定工具類型和可見性。單擊“添加”并在“選擇要添加的工具”對話框中選擇“Drush”，選擇Drush是否可用于當(dāng)前項(xiàng)目（項(xiàng)目可見性或所有IntelliJ IDEA項(xiàng)目（全局可見性））。單擊“確定”時，將打開“Drush”對話框。

   • 指定Drush可執(zhí)行文件。

     在打開的Drush對話框中，IntelliJ IDEA自動填充了默認(rèn)的可執(zhí)行文件位置，通常是Windows上的C：/ProgramData/Drush/drush.bat，和macOS或Linux上的/usr/bin/drush。如果您遵循標(biāo)準(zhǔn)安裝過程，則預(yù)定義路徑將是正確的，只需單擊“確定”即可。

     如果是自定義安裝，請鍵入Drush可執(zhí)行文件的路徑，然后單擊“確定”。

     在任何一種情況下，IntelliJ IDEA都會自動加載命令定義并返回“命令行工具支持”頁面。

   • 指定Drush的別名。

     在“別名”字段中，指定要在工具命令調(diào)用中使用的別名。如有必要，接受默認(rèn)別名或?qū)ζ溥M(jìn)行編輯。

   • 激活Drush

     選中“啟用”復(fù)選框以激活檢測到的命令集。

3. 運(yùn)行Drush命令

   打開“輸入”窗格（工具|運(yùn)行命令）并鍵入<alias>（默認(rèn)為drush），然后按 Ctrl+Space 以調(diào)用完成。命令執(zhí)行結(jié)果顯示在“輸出”選項(xiàng)卡中，并帶有命令的名稱。

使用Drupal 8和Symfony2 

IntelliJ IDEA提供Drupal，版本8和Symfony2之間的緊密集成。通過這種集成，Symfony2組件與Drupal基礎(chǔ)架構(gòu)相連。要使用這種集成需要滿足下列條件：

1. 安裝Drupal Symfony2 Bridge插件

   在“設(shè)置/首選項(xiàng)”對話框（Ctrl+Alt+S）中，導(dǎo)航到“插件”頁面。單擊“瀏覽存儲庫”，選擇插件，然后單擊“安裝”。

2. 啟用注釋

   為了獲得先進(jìn)的注解的支持，按照“管理插件”中的說明安裝PHP注解插件。

Drupal 8 - Symfony2集成有哪些編碼幫助？

• 完成包含Drupal模塊信息的<module_name> .info.yml文件中的主要Drupal特定參數(shù)。
• 適合在Drupal特定的t()函數(shù)內(nèi)使用的字符串，在您的項(xiàng)目中編制索引并提供完成。
• 完成url()和其他Drupal API函數(shù)中的相關(guān)yml鍵值，這樣可以更輕松地搜索正確的值。 
• 按下Ctrl+B或選擇：導(dǎo)航|轉(zhuǎn)到聲明，以導(dǎo)航到y(tǒng)ml文件。 
• 完全支持yml文件中描述的服務(wù)容器，包括使用Ctrl+B來完成和導(dǎo)航。 
• 支持Twig模板引擎，現(xiàn)在是Drupal 8的默認(rèn)模板引擎，包括Drupal函數(shù)的完成，導(dǎo)航和識別。