在Laravel中創建自己的PHP幫助函數

neu 發布于2019-07-01 14:21 / 3456人閱讀

摘要：轉至應用程序根目錄中的命令行并運行以下命令以創建新的服務提供者。將會提示運行結果一旦服務提供者成功創建，打開該文件。現在我們的服務提供者已經完成，我們需要注冊我們的服務提供者，所以，會在引導期間加載它。這就是為服務提供者創建你的幫手。

Laravel 為我們提供了許多內置的幫助函數，你可以在應用程序中的任何位置調用它。它們使你可以方便地處理數組和對象，路徑，字符串，URL和其他類型的工作流。

盡管在 Laravel 核心中定義了許多幫助函數，但你可以在 Laravel 中定義自己的幫助函數以避免重復相同的代碼。它確保你的應用程序有更好的可維護性。

我們來看看如何創建自己的定制 Laravel 幫助函數

Laravel 中的幫助函數

Laravel 中有許多內置的幫助程序可供你的應用程序使用。它們根據它們提供的功能類型進行分組。這是一個完整的內置 Laravel 幫助文件。

數組和對象

在這個組中，助手提供了處理數組和對象的能力。該組包含用于添加兩個數組的輔助函數，將多維數組折疊成單個數組，返回數組的第一個元素，檢查數組中是否存在給定的項目或項目，并執行許多其他類型的操作。

路徑

這組helper返回Laravel應用程序中不同目錄的絕對路徑，例如 app，config，public，resource，storage和你的應用程序的基本路徑。

字符串

該組中的助手使用字符串操作。你可以將字符串轉換為駱駝大小寫，找到該類的基本名稱，運行 htmlspecialchars，將文本轉換為kebab大小寫，將文本轉換為大小寫，并執行許多其他類型的字符串操作。

URL

助手的URLs組與生成URL一起工作。你可以為控制器操作生成URL，命名為route，以及指定路徑的完全限定URL。

雜項

這類幫助程序包含處理頁面狀態，服務容器，認證，緩存等功能。

在Laravel中創建幫助文件

在本節中，我們將通過創建Laravel幫助程序文件，該文件可以在Laravel應用程序中全局使用。你可以組織你的幫助程序文件的位置，但是，我更愿意將我的Laravel項目幫助程序文件保存在 app/Helpers/Helper.php 中。在本教程中，我們將在我想要的位置創建一個幫助文件。

創建一個幫助文件

你可以將你的幫助程序文件放在你的Laravel應用程序的任何位置，將它放在你的應用程序目錄下是標準的。
讓我們在app下創建一個 Helpers 目錄并創建一個 Helper.php 文件。這些是該文件的以下內容。


如果你正在使用一個類并且它的方法是你的助手，你可以用命名空間聲明來啟動這個文件。
namespace AppHelpers;
如果你不使用命名空間聲明，則這些函數將變為全局可用，你甚至可以在不指定名稱空間的情況下使用它們。 所有Laravel內置的幫助函數都是在沒有命名空間的情況下定義的。 此外，助手類也將在全局范圍內提供。 因此，如果你想在不指定命名空間的情況下使用助手，只需刪除這一行。
定義這些函數時有一些注意事項。所有的Laravel助手文件函數都會被檢查以避免函數定義沖突。
if (!function_exists("human_file_size")) {
    function human_file_size($bytes, $decimals = 2)
    {
        // ...
    }
}
如果跳過此檢查，則每次重新定義具有相同定義的函數時都會發生沖突。你可以使用這個檢查，或者你也可以用你的函數名稱作為前綴來避免沖突。
使用幫助文件
現在，就我們的幫助文件而言，就是這樣。讓我們看看如何在Laravel應用程序中使用助手文件。

你可以使用 composer 自動加載助手文件。然后，你可以在應用程序的任何位置使用這些功能。
你也可以使用Laravel服務提供者注冊此文件。 Laravel會將其與其他依賴關系一起加載。
你也可以使用一個包含所有這些功能的軟件包。

讓我們看看如何使用所有這些方法。
通過Composer自動加載
第一個非常簡單直接。 只需轉到位于Laravel項目中的 composer.json 文件，你將看到自動加載 key。 Composer 有一個key files（你想自動加載的文件路徑數組），你可以在自動 `autoload 中使用它。 如：
"autoload": {
    "files": [
        "app/Helpers/Helper.php"
    ],
    "classmap": [
        "database/seeds",
        "database/factories"
    ],
    "psr-4": {
        "App": "app/"
    }
},
更改composer.json文件并向文件數組添加新路徑后，需要重新生成自動加載文件。只需從Laravel項目目錄中的終端運行此命令即可。
composer dump-autoload
現在，你的幫助程序文件將自動加載到你的Laravel項目中。
通過服務提供者加載
讓我們來看看如何使用服務提供者來自動加載助手文件。轉至應用程序根目錄中的命令行并運行以下命令以創建新的服務提供者。
php artisan make:provider HelperServiceProvider
將會提示運行結果
Provider created successfully.
一旦服務提供者成功創建，打開該文件。在注冊方法中添加你的助手文件。
public function register()
{
    $file = app_path("Helpers/Helper.php");
    if (file_exists($file)) {
        require_once($file);
    }
}
在注冊方法中，我們包含了我們的依賴關系。 在大型項目中，你可能在目錄中有多個幫助程序文件，并且你想要全部這些文件。 你可以更改注冊方法，如下所示，你的服務提供商將加載Helpers目錄中的所有文件。
public function register()
{
    foreach (glob(app_path() . "/Helpers/*.php") as $file) {
        require_once($file);
    }
}
它將需要 app/Helpers 目錄中的所有文件。
現在我們的服務提供者已經完成，我們需要注冊我們的服務提供者，所以，Laravel會在引導期間加載它。 為此，請轉至 config/app.php 并在結尾處的 providers 數組中添加以下行。
AppProvidersHelperServiceProvider::class,
如果你的幫助文件涉及到一個擁有這些幫助方法的類，并且你已經指定了命名空間，那么你可以通過定義一個別名來毫不費力地使用它們。 您可以通過在 config/app.php 文件中的別名數組末尾添加以下內容輕松完成此操作。
"Helper" => AppHelpersHelper::class,
通過將這添加到別名數組中，你將能夠使用Helper關鍵字調用助手。這就是為服務提供者創建你的幫手。
使用第三方包加載
你也可以使用第三方package: Laravel helpers package。你可以通過在控制臺中從你的應用程序的根目錄運行此命令來通過編寫器安裝它。
composer require browner12/helpers
在 config/app.php 中的 providers 數組中添加以下行
browner12helpersHelperServiceProvider::class,
如果你正在使用Laravel的自動包發現功能，則可以跳過此步驟。 完成必要的步驟之后，你可以使用此命令創建助手文件。
php artisan make:helper Helper
它將在 AppHelpers 中創建一個 Helper.php 文件，你可以輕松添加所有幫助程序功能。
Helper 的具體使用
現在我們的函數在Helper文件中定義，沒有定義名稱空間，我們可以很容易地使用它們。 只需在 routes/web.php 中找到你的路由文件，并將此功能用于首頁。 例如，這是完整的 routes/web.php 文件：

它將簡單地返回作為參數傳遞的字節數的可讀大小。你可以從任何地方控制器或視圖調用這些函數。
資源

查看所有可用的 內置Laravel助手

一個簡單的包來創建助手文件 browner12/helpers

了解有關使用 Composer Autoloader 的更多信息

歡迎留言討論。
更多PHP相關，請前往PHPCasts

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/31992.html

[譯] 使用 Sami 生成 PHP 文檔

摘要：原文地址為方法類函數生成文檔已經成為了程序員的習慣所以需要知道通過源代碼生成獨立的文檔本文中我會介紹一款新的文檔生成工具什么是是插入到類接口方法屬性頂部的多行注釋為了闡明這個我們看下中的代碼片段開始于結束于每行之間使用當定義一個類屬性或者原文地址: Generating PHP Documentation with Sami 為方法, 類, 函數生成文檔已經成為了程序員的習慣, 所以...

banana_pi 2019-06-28 13:35 評論0 收藏0
Laravel 中創建 Zip 壓縮文件并提供下載

摘要：文章轉自更多文章如果您需要您的用戶支持多文件下載的話，最好的辦法是創建一個壓縮包并提供下載。你看，你不需要任何的擴展包來實現這個壓縮方式。 showImg(https://segmentfault.com/img/remote/1460000018734388?w=1500&h=800); 文章轉自：https://learnku.com/laravel/t... 更多文章：https...

aboutU 2019-07-01 12:38 評論0 收藏0
PHP 項目中單獨使用 Laravel Eloquent 查詢語句來避免 SQL 注入

摘要：是一個記錄當前應用所受威脅情況的項目。怎么做呢用參數化查詢對數據格式化，并使查詢語句與數據分離。使用參數化查詢，可以確保程序遠離注入風險。例子如下除此之外，還有一種安全的做法，就是在項目中使用對象關系映射或者是查詢構造器。 showImg(https://segmentfault.com/img/remote/1460000018641613?w=1680&h=859); OWASP?...

dayday_up 2019-07-01 12:36 評論0 收藏0
Laravel 測試： PHPUnit 入門教程

摘要：介紹是最古老和最著名的單元測試包之一。它主要用于單元測試，這意味著可以用盡可能小的組件測試代碼，但是它也非常靈活，可以用于很多不僅僅是單元測試。這時，的測試助手可以使這些測試像單元測試簡單組件一樣容易。新的測試代碼如下注意到，在我們新建的 showImg(https://segmentfault.com/img/remote/1460000018355157?w=1440&h=585)...

張憲坤 2019-07-01 12:32 評論0 收藏0
Laravel深入學習5 - 應用架構

摘要：控制只是用來接收請求并請求邏輯處理類。事實上，業務邏輯無需感知網絡，網絡僅僅接入應用的傳輸機制，他不應超出應用中的路由和控制器的范疇。職責分離是編寫健壯應用的關鍵。其他通常，類庫應該以規范組織在我們的應用中。聲明：本文并非博主原創，而是來自對《Laravel 4 From Apprentice to Artisan》閱讀的翻譯和理解，當然也不是原汁原味的翻譯，能保證90%的原汁性，另...

lixiang 2019-06-27 16:32 評論0 收藏0