1. 程式人生 > >2019 模板開發基礎指南(適用於emlog5)

2019 模板開發基礎指南(適用於emlog5)

本文分析emlog5下的模板基本結構以及基本變數、函式的作用,詳細瞭解本文,有助於更快掌握emlog5的模板開發基礎。

emlog的模板位於安裝目錄content\templates\資料夾下,每個模板都是一個單獨的資料夾,資料夾以模板名字命名。通過後臺上傳安裝的模板都儲存在這個目錄下。

模板檔案目錄說明

一般來說,一個模板都會包含以下幾個部分:

  • images資料夾:存放模板所需圖片。
  • echo_log.php:顯示日誌內容。
  • footer.php:頁面底部。
  • header.php:頁面頭部。
  • log_list.php:顯示日誌列表內容。
  • main.css:模板的css檔案。
  • module.php:模板公共程式碼,包含側邊widgets、評論、引用、編輯等,該檔案是模板最核心的模組。
  • page.php:自定義的頁面內容的模板。
  • preview.jpg:在後臺模板選擇介面顯示的模板預覽圖,300×225 jpg格式。
  • side.php:模板側邊欄檔案,如製作單欄模板則該檔案不是必須的。
  • t.php:顯示emlog系統自帶的微博(碎語)內容。
  • 404.php 自定義404頁面未找到時的報錯頁面

在一般的emlog模板開發中,以上提及的部分中echo_log.php、log_list.php、module.php、page.php、 t.php、header.php以及preview.jpg是不可或缺的,一旦預設,模板將無法執行。此外的side.php、footer.php、 main.css、images資料夾等,只需要對模板程式碼做小部分更改,那麼它們都是可以改名、移動、甚至刪除的。

下面我們將對以上各模組進行簡要分析:

公共程式碼分析

通過預覽整個模板中的各個檔案,你會發現以下程式碼同時存在於多個檔案中,這些程式碼分別有以下用途: if(!defined('EMLOG_ROOT')) {exit('error!');} 此行程式碼存在於模板目錄下的每個php檔案起始部分(事實上為了安全起見,該行程式碼也在admin目錄下的幾乎所有php檔案起始部分存在),其作用是防 止程式碼所在的php指令碼被直接訪問執行。 require_once View::getView('side'); require_once View::getView('footer'); 這兩行程式碼存在於log_list.php、echo_log.php、page.php、t.php裡面,其作用是呼叫模板資料夾下的side.php 和footer.php的程式碼到當前檔案的當前位置。View是emlog的模板檢視控制器,View::getView('檔名','檔案字尾')將 返回當前模板安裝路徑下對應的檔案。getView函式的第二個引數為預設引數,在不傳入值的情況下,將預設作為.php檔案字尾返回檔案路徑。

header.php

開頭註釋內容是模板資訊,該資訊顯示在模板選擇介面

  • Template Name:模板名稱
  • Description:模板介紹描述
  • Author:模板作者
  • Author Url:作者或模板釋出的URL
  • Sidebar Amount:標記該模板有幾個側邊欄,一般為1,有些模板有兩個側邊欄則標記2。這樣可以在後臺widgets裡識別管理(具體可下載體驗官方收錄的模板G7)。

之後是具體程式碼部分:

if(!defined('EMLOG_ROOT')) {exit('error!');}

該行程式碼同樣存在於其它模板檔案中,為防止該檔案被直接執行。

require_once View::getView('module');

載入模板公共程式碼.

* $site_title:站點標題 * $site_key:關鍵字 * $site_description:輸出部落格設定的摘要 * BLOG_URL:部落格首頁的URL,* TEMPLATE_URL:模板資料夾的URL,用於載入模板內的css、js及其他內容, * BLOG_URL.Option::get('topimg'):這句可以無視,因為只預設模板可以自定義banner,其它模板沒這功能(卡片語:很沒營養的設定,嗯。)

<?php echo $curpage == CURPAGE_HOME ? 'current' : 'common';?> 判斷當前是否首頁,是則給導航加current類,用於表現當前位置。

<?php if($istwitter == 'y'):?>…….<?php endif;?> 如後臺設定在前臺顯示碎語,則輸出…….中的內容。

<?php echo $curpage == CURPAGE_TW ? 'current' : 'common';?> 判斷當前URL是否為碎語並選擇加類名。

<?php foreach ($navibar as $key ⇒ $val):?>…….<?php endforeach;?> 輸出自定義頁面的連結

footer.php

Option::EMLOG_VERSION:獲得版本號。

$icp:獲得後臺設定的ICP備案號。

<?php doAction('index_footer'); ?> 頁尾底部掛載點加入。

log_list.php

<?php doAction('index_loglist_top'); ?> 頁尾底部掛載點加入。

$value['logid'] 該變數為當前日誌的id

<?php topflg($value['top']); ?> 顯示置頂標記,該函式位於模板module.php內。

<?php echo $value['log_url']; ?> 輸出日誌URL

<?php echo $value['log_title']; ?> 輸出日誌標題

<?php blog_author($value['author']); ?>

輸出日誌的作者,該函式位於模板module.php內。

<?php echo gmdate('Y-n-j G:i l', $value['date']); ?>

輸出日誌釋出時間,引數'Y-n-j G:i l'用於定義日期格式。

<?php blog_sort($value['logid']); ?>

輸出日誌所屬的分類,該函式位於模板module.php內。

<?php editflg($value['logid'],$value['author']); ?>

當管理員或作者登陸時顯示“編輯”連結,該函式位於模板module.php內。

<?php echo $value['log_description']; ?>

輸出日誌摘要(沒有摘要則輸出全文)。

<?php blog_att($value['logid']); ?>

如日誌有附件則輸出附件,該函式位於模板module.php內。

<?php blog_tag($value['logid']); ?> 輸出日誌的標籤,該函式位於模板module.php內。

<?php echo $value['comnum']; ?> 輸出當前日誌的評論數

<?php echo $value['tbcount']; ?> 輸出當前日誌的引用量

<?php echo $value['views']; ?> 輸出當前日誌的瀏覽量

<?php echo $page_url;?> 顯示當前列表頁的翻頁功能。

<?php include View::getView('side'); include View::getView('footer'); ?>

加入側邊欄及加入頁尾。

echo_log.php

該檔案功能函式與列表頁一致,但引數有區別,注意區分。 $logid 該變數為當前日誌的id

<?php topflg($top); ?> 顯示置頂標記,該函式位於模板module.php內。

<?php echo $log_title; ?> 輸出日誌標題。

<?php blog_author($author); ?> 輸出日誌的作者,該函式位於模板module.php內。

<?php echo gmdate('Y-n-j G:i l', $date); ?> 輸出日誌釋出時間,引數'Y-n-j G:i l'用於定義日期格式。

<?php blog_sort($logid); ?> 輸出日誌所屬的分類,該函式位於模板module.php內。

<?php editflg($logid,$author); ?> 當管理員或作者登陸時顯示“編輯”連結,該函式位於模板module.php內。

<?php echo $log_content; ?> 輸出日誌全文內容。

<?php blog_att($logid); ?> 如日誌有附件則輸出附件,該函式位於模板module.php內。

<?php blog_tag($logid); ?> 輸出日誌的標籤,該函式位於模板module.php內。

<?php echo $comnum; ?> 日誌頁顯示評論數

<?php echo $tbcount; ?> 日誌頁顯示引用數

<?php echo $views; ?> 日誌頁顯示瀏覽量

<?php doAction('log_related', $logData); ?> 相關日誌的掛載點,與3.x版本不同,4.0帶第二引數。

<?php neighbor_log($neighborLog); ?> 輸出鄰近,就是上一篇及下一篇,該函式位於模板module.php內。

<?php blog_trackback($tb, $tb_url, $allow_tb); ?> 輸出該日誌被引用的資訊列表,與3.x不同注意區分。

<?php blog_comments($comments); ?> 輸出該日誌評論列表,與3.x不同注意區分。

<?php blog_comments_post($logid,$ckname,$ckmail,$ckurl,$verifyCode,$allow_remark); ?> 輸出發表評論框,與3.x不同注意區分。

page.php

該檔案寫法與echo_log.php類似,不再重複。

t.php

與之前相同的內容不再重複。 <?php echo $avatar; ?> 輸出頭像。

<?php echo $author; ?> 輸出作者名。

<?php echo $val['t'];?> 輸出碎語內容。

<?php echo DYNAMIC_BLOGURL; ?> 根據當前url輸出部落格地址,主要用於js,解決跨域問題。

<?php echo $tid;?> 輸出碎語所在資料庫中的id號。

<?php echo $val['date'];?> 釋出碎語的時間。

$reply_code :其值為‘n’或‘y’,後臺設定是否啟用碎語回覆驗證碼。

<?php echo $rcode; ?> 輸出驗證碼。

side.php

側邊欄,主要負責根據後臺widgets設定資訊輸出側邊欄內容。建議該檔案內程式碼保持不變。

module.php

模板公共程式碼,包含側邊widgets、評論、引用、編輯等。 該檔案由若干函式組成,被部落格前臺檔案呼叫,可在內自定義函式實現更多功能。 如在自定義函式內呼叫emlog快取時,假設讀取user快取資訊,則形如: global $CACHE; $user_cache = $CACHE→readCache('user'); 如需要操作資料庫,則形如: $DB = MySql::getInstance(); $res = $DB→query($sql); 以上兩點與3.x不同,請注意區分。

404.php

用於自定義404頁面的模板。

最後附:前臺模板部分掛載點一覽

 

doAction('index_footer'); 頁尾底部掛載點

doAction('index_loglist_top'); 首頁日誌列表頂部掛載點

doAction('log_related', $logData); 相關日誌掛載點

doAction('diff_side'); 側邊欄掛載點