首頁 > 文章 > 後端開發 > 建立您的第一個 ExpressionEngine 插件

建立您的第一個 ExpressionEngine 插件

王林原創: 2023-09-01 22:33:021429瀏覽

無論 CMS 多麼出色，有時您需要滿足的特定需求根本無法開箱即用。在這裡，我們將探索為 ExpressionEngine 建立插件來滿足此類需求。

#版本說明

最近，ExpressionEngine 的創作者 EllisLab 宣布 ExpressionEngine 2.0 的正式發布日期為 2009 年 12 月 1 日。請注意，本教學是根據 1.6.x 版本的詳細資訊編寫的。 2.0 版本中的某些細節（例如檔案路徑和全域物件）將會發生變化。雖然這些細節會有所不同，但 ExpressionEngine 外掛程式所建立的一般應用程式和方法將保持不變。

ExpressionEngine 外掛程式的類型

與大多數可用的強大管理系統一樣，ExpressionEngine 或「EE」為開發人員提供了多種方法來新增預設情況下可能不存在的功能。與 WordPress 等流行系統不同，EE 對這些附加元件有不同的名稱，這取決於它們與您的網站互動的方式。您可以透過三種主要方式為 EE 1.6.x 新增功能，即插件、擴充功能和模組。插件主要處理修改模板程式碼，並且往往更像是前端工作。擴充通常透過綁定到系統中的「掛鉤」來調整後端或控制面板的功能。模組的範圍往往更大，在控制面板中有自己的區域，也可以在 EE 網站的前端使用。模組可以是位於 EE 並利用會員資格、模板、資料庫等的成熟應用程式。

所需經驗

在繼續之前了解一些肯定會有所幫助的事情：

如何在開發環境中設定和安裝 ExpressionEngine
基本上了解 ExpressionEngine 的控制面板和範本解析
對 PHP 和物件導向程式設計有基本了解
如何閱讀文件！

我們的外掛程式

在本教程中，我們將創建一個簡單的插件，用於掃描傳遞給它的資料並使用 HTML 標籤包裝某些字串。這是一個非常簡單的 EE 插件應用程序，應該向您展示插件開發入門是多麼容易。我們的插件將用於搜尋和替換我們作為開發人員使用的首字母縮寫。為了舉例，我們將堅持使用三個：HTML、CSS 和 RSS。我們將該插件命名為“Auto Acronym”。

我要從哪裡開始？

EE 附加元件開發的最佳起點是官方 ExpressionEngine 文件。在深入開發 ExpressionEngine 之前，您應該閱讀他們的指南，如果您遵循這些指南，將有助於保持系統良好運作。該指南涵蓋命名約定、效能和安全性等內容。我將給您幾分鐘時間閱讀 ExpressionEngine 附加開發指南

创建您的首个 ExpressionEngine 插件

# 好的，現在您已經閱讀了我們可以開始了解如何實際創建插件以及簡單插件的組成部分。

拼圖的碎片

每個插件都需要一個類別和至少一個函數。命名約定非常具體，因此我們需要確保正確且仔細地進行命名。我們的插件的名稱是 Auto Acronym，它與我們的檔案名稱、類別名稱和 EE 標籤一起發揮作用。檔案名稱採用插件的名稱，並用底線替換所有空格，同時在前面加上“pi”。到前面。所有字母必須小寫。這將使我們的檔案名為「pi.auto_acronym.php」。所有 EE 插件都進入位於 system/plugins 下的單一目錄（想像一下）。

類別名稱與檔案名稱類似，只是第一個字母大寫。這使得我們的類別名稱為“Auto_acronym”。該插件只需要一個函數，因此它將與類別具有相同的名稱。這些也將是我們在 EE 外掛標籤中使用的名稱。外掛標籤總是以“exp:”開頭，它告訴模板解析器，“嘿！我需要在這裡進行一些處理！”。接下來是您的班級名稱，全小寫，給我們：「exp:auto_acronym」。插件標籤的第三段呼叫插件類別中的函數。在我們的範例中，我們將只使用一個函數，即建構函數，因此我們只需要類別名稱。到目前為止，我們對外掛程式的了解如下：

创建您的首个 ExpressionEngine 插件

#將其寫入程式碼

讓我們看看到目前為止我們的程式碼是什麼：

<?php

class Auto_acronym
{
   
   function Auto_acronym()
   {
      
   }
   
}

/* End of file pi.auto_acronym.php */
/* Location: ./system/plugins/pi.auto_acronym.php */

對於熟悉 WordPress 外掛程式開發的人來說，您知道 WordPress 在外掛程式管理器中顯示詳細資訊時會從註解程式碼中提取一些資料。 ExpressionEngine 執行類似的操作，但使用外掛程式檔案中的陣列除外。讓我們繼續將其添加到類別上方的文件中，並為其提供適當的資訊。

<?php

$plugin_info       = array(
   'pi_name'        => 'Auto Acronym',
   'pi_version'     => '1.0',
   'pi_author'      => 'Erik Reagan',
   'pi_author_url'  => 'http://erikreagan.com',
   'pi_description' => 'Automatically wraps certain acronyms in the HTML <acronym> tag',
   'pi_usage'       => Auto_acronym::usage()
   );

class Auto_acronym
{

   function Auto_acronym()
   {

   }

}

/* End of file pi.auto_acronym.php */
/* Location: ./system/plugins/pi.auto_acronym.php */

每个数组键的用途都应该非常明显。然而，最后一个键有点不同。它显然不只是像其他字符串一样。它用于告诉 ExpressionEngine 控制面板在哪里可以找到插件的用法或简单文档。每个 EE 插件都应该在插件文件中包含一些基本文档，以便使用该插件的人可以在控制面板中查看它并了解如何使用标签。这是通过向插件类添加一个名为“usage”的函数来完成的。我喜欢将使用函数放在类的最后，所以让我们继续从 ExpressionEngine 插件文档复制并粘贴示例，并删除 ?> 和


   // ----------------------------------------
   //  Plugin Usage
   // ----------------------------------------

   // This function describes how the plugin is used.
   //  Make sure and use output buffering

   function usage()
   {
   ob_start(); 
   ?>

   

   <?php
   $buffer = ob_get_contents();

   ob_end_clean(); 

   return $buffer;
   }

我们的用法将在我们完成插件后编写。现在，我们只是输入一些文本以进行测试。请记住，此文本将被视为预先格式化，并且所有字符都将转换为 HTML 实体； HTML 将不起作用。让我们看看到目前为止我们的插件的整体情况

<?php

$plugin_info       = array(
   'pi_name'        => 'Auto Acronym',
   'pi_version'     => '1.0',
   'pi_author'      => 'Erik Reagan',
   'pi_author_url'  => 'http://erikreagan.com',
   'pi_description' => 'Automatically wraps certain acronyms in the HTML <acronym> tag',
   'pi_usage'       => Auto_acronym::usage()
   );

class Auto_acronym
{

   function Auto_acronym()
   {

   }
   
   
   // ----------------------------------------
   //  Plugin Usage
   // ----------------------------------------

   // This function describes how the plugin is used.
   //  Make sure and use output buffering

   function usage()
   {
   ob_start(); 
   ?>

   This is where our simplified documentation will go

   <?php
   $buffer = ob_get_contents();

   ob_end_clean(); 

   return $buffer;
   }

}

/* End of file pi.auto_acronym.php */
/* Location: ./system/plugins/pi.auto_acronym.php */

现在我们有了一个简单的插件文件，我们需要将其保存到 system/plugins 目录中，以确保系统正确读取它。保存后，您将在“管理”>“实用程序”>“插件管理器”下看到它。如果您点击我们的新插件，您应该会看到这样的页面，其中包含我们刚刚添加到插件中的信息

创建您的首个 ExpressionEngine 插件

让它发挥作用

现在我们的插件已正确引入 ExpressionEngine 系统，我们可以让它真正做某事。每个插件都会返回某种形式的数据。该数据始终来自 EE 将查找的标准化变量，称为“return_data”。我们要做的第一件事是在类中的第一个函数之前定义它。然后，出于测试目的，我们将在第一个函数中使用它来返回一个简单的字符串。

class Auto_acronym
{
   
   var $return_data  = "";
   
   function Auto_acronym()
   {
      $this->return_data = "Just making sure this works";
      
   }

现在我们已经返回了一些数据，我们可以在网站的前端对其进行测试。我现在正在使用一个非常小的模板用于测试目的，但您可以在任何 ExpressionEngine 模板中使用它。如果您还记得之前我们的插件标签是 {exp:auto_acronym} ，并且由于我们只有一个函数，因此我们不需要在此插件中使用第三个段。这是我的模板代码的样子，然后是我的浏览器显示的内容：

<h1>Plugin Tutorial</h1>

<p>{exp:auto_acronym}</p>

创建您的首个 ExpressionEngine 插件

虽然不完全是开创性的，但它让我们离我们的目标又近了一步。现在我们知道如何传回数据，我们可以看看如何获取传递给插件的数据。

使用我们的插件处理数据

我们将重点关注的处理数据的第一个方法是 ExpressionEngine 读取插件标签对之间的所有数据。我您还不知道，我们的标签 pair 与 HTML 标签对的工作方式非常相似。我们有一个开放标记，后跟数据，然后是结束标记，如下所示：

{exp:auto_acronym}
This gets processed
{/exp:auto_acronym}

通过使用模板对象，ExpressionEngine 可以非常轻松地获取这些数据。在这种情况下，我们需要在我们的函数中将其设置为全局，以便我们可以访问它。然后我们通过调用“tagdata”变量来定义我们的变量。该变量是我们的打开和关闭标记对之间的数据。看看：

function Auto_acronym()
{
   global $TMPL;

   $data = $TMPL->tagdata;
}

现在让我们对数据做一些非常简单的事情，并将其设置为粗体，因为它现在只是文本。我们将在其周围添加 标签，然后相应地定义我们的 return_data 变量。这就是我们的代码、模板和渲染页面现在的样子：

插件：

function Auto_acronym()
{
   global $TMPL;

   $data = '<strong>'.$TMPL->tagdata.'</strong>';
   
   $this->return_data = $data;
}

模板：

<h1>Plugin Tutorial</h1>

{exp:auto_acronym}
<p>This gets processed</p>
{/exp:auto_acronym}

在浏览器中呈现：

创建您的首个 ExpressionEngine 插件

已经做点什么了！

好吧好吧。现在让我们真正享受一下这个乐趣。我们使用此插件的目标是扫描传递给它的数据以查找常见的 Web 开发首字母缩略词。我提到我们将在本教程中使用 3 个：HTML、CSS 和 RSS。我们要做的第一件事是将它们全部放入函数中的数组中。请注意，如果我们在整个插件中使用此数组并且具有多个函数，我们可能希望将其存储在构造函数之外，以便任何函数都可以调用它。

function Auto_acronym()
{
   global $TMPL;

   $data = $TMPL->tagdata;
   
   $acronyms = array(
      'HTML' => 'HyperText Markup Language',
      'CSS' => 'Cascading Style Sheets',
      'RSS' => 'Really Simple Syndication'
      );
}

现在我们有了标签数据以及首字母缩略词数组，我们需要对首字母缩略词运行 foreach() 循环。我们要做的第一件事是通过 strpos() 函数运行缩写词和标签数据，以确保缩写词实际上在我们的字符串内。我们这样做的原因是为了不运行不需要的字符串替换。如果您的首字母缩略词词典有数百个值，并且您在一篇冗长的文章中运行它，则可能会冒不必要的处理时间的风险。当且仅当首字母缩略词位于我们的标签数据中时，我们才会使用 str_replace() 函数实际添加标签。在 foreach() 循环之后，我们将相应地定义 return_data 变量。它看起来像这样：

function Auto_acronym()
{
   global $TMPL;

   $data = $TMPL->tagdata;

   $acronyms = array(
      'HTML' => 'HyperText Markup Language',
      'CSS' => 'Cascading Style Sheets',
      'RSS' => 'Really Simple Syndication'
      );
      
   foreach ($acronyms as $short => $long)
   {
      if (strpos($data, $short) !== FALSE)
      {
         $data = str_replace($short, '<acronym title="'.$long.'">'.$short.'</acronym>', $data);
      }         
   }
   
   $this->return_data = $data;
   
}

为了正确测试这一点，我们需要更改模板，以便它实际上包含一些我们想要的首字母缩略词。我将把我的模板更改为：

<h1>Plugin Tutorial</h1>

{exp:auto_acronym}
<p>My name is Erik and I am an addict. I stay up late into the night marking up HTML and CSS with magical alignment.
Whitespace speaks volumes of my care and finesse of the code. My RSS subscribers wait on their toes for my next
example of code beauty. Okay...not really.</p>
{/exp:auto_acronym}

保存我们的模板并刷新浏览器应该会产生以下结果：

创建您的首个 ExpressionEngine 插件

现在我们已经取得进展了！

现在我们已经正确处理了插件的打开标签和关闭标签之间的标签，让我们看看另一个选项：在单个标签内传递数据。将单个标签与插件一起使用将需要添加参数，以便数据仍然传递到插件进行处理。您可以随意命名参数。在我们的例子中，我们将使用它并将其添加到我们的模板中：

{exp:auto_acronym data="HTML"}

现在我们有了一个标签，我们需要找到一种在插件中使用它的方法。您想要在插件中使用的任何参数都可以使用我们之前使用的相同模板对象来获取。您需要使用名为 fetch_param() 的函数来获取它，而不是通过变量来获取它。我们希望我们的 pluign 可以与单个标签或标签对一起使用，因此在定义 $data 变量时我们会考虑到这一点。这就是我们要改变的：

// Original 
$data = $TMPL->tagdata;

// New
$data = ($TMPL->fetch_param('data')) ? $TMPL->fetch_param('data') : $TMPL->tagdata ;

如果您不熟悉这个语法，基本上就是“如果数据参数存在（或返回 true），则将其用作我们的数据变量，否则使用标签对之间的 tagdata”。这一更改将使我们能够使用定义了数据参数的标签对和单个标签。这是我们的模板现在应该呈现的内容：

创建您的首个 ExpressionEngine 插件

即将完成！

现在我们有了一个功能齐全的 ExpressionEngine 插件。完成它的最后一步是添加有用的“使用”信息。让我们深入到 use() 函数并为控制面板添加一些简单的文档。

function usage()
{
   ob_start(); 
?>

The "dictionary" of acronyms is stored in an array within the plugins/pi.auto_acronym.php file.

Automatically turn a string into an HTML acronym if it is within our acronym dictionary. You can do this with individual words or large blocks of text.


Simple Example
===========================

{exp:auto_acronym data="HTML"}

This outputs:
HTML in your ExpressionEngine template.



Large Block Example
===========================

{exp:auto_acronym}

My name is Erik and I am an addict. I stay up late into the night marking up HTML and CSS with magical alignment.
Whitespace speaks volumes of my care and finesse of the code. My RSS subscribers wait on their toes for my next
example of code beauty. Okay...not really.

{/exp:auto_acronym}

This outputs:
My name is Erik and I am an addict. I stay up late into the night marking up HTML and CSS with magical alignment.
Whitespace speaks volumes of my care and finesse of the code. My RSS subscribers wait on their toes for my next
example of code beauty. Okay...not really.


现在我们的控制面板应该看起来像这样：

恭喜！

您现在已经完成了第一个 ExpressionEngine 插件。希望这将为您打开大门，因为您会看到它是多么容易。获取和返回数据非常简单，您可以从插件本身运行许多 PHP 魔法。我在我的 GitHub 帐户上托管此插件，如果您愿意，您可以在那里下载完整的插件代码。接下来，在我们的 ExpressionEngine 附加组件系列中，我们将着眼于为控制面板创建一个简单的扩展。请继续关注！
附注
别忘了查看其他精彩的 ExpressionEngine 教程！

使用 EE 创建 Google 地图
使用 Slideshow Pro 和 ExpressionEngine 创建幻灯片
5 天内成为 ExpressionEngine 超级明星


在 Twitter 上关注我们，或订阅 Nettuts+ RSS Feed 以获取网络上最好的 Web 开发教程。

以上是建立您的第一個 ExpressionEngine 插件的詳細內容。更多資訊請關注PHP中文網其他相關文章！

陳述：

本文內容由網友自願投稿，版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容，請聯絡admin@php.cn

上一篇：使用 PHP 的內建數學函數探索三角學、隨機數生成等下一篇：使用 PHP 的內建數學函數探索三角學、隨機數生成等

看更多