到現(xiàn)在為止婿牍，我還在為自己當(dāng)初大多數(shù)人都無法正常訪問安裝Octobercms的情況下選擇了OctoberCMS而慶幸，當(dāng)時選擇OctoberCMS除了其方便的特性和眾多的插件之外隐绵，還基于其是基于Laravel開發(fā)的，而Laravel的生態(tài)也是大勢所趨。
而后在開發(fā)過程中越來越證明我的判斷是對的介蛉，每當(dāng)業(yè)務(wù)邏輯需要一個新功能時爆阶，我基本都能找到合適的輪子并迅速上線燥透，真正地專注于業(yè)務(wù)邏輯。
下面講一講在Octobercms中如何如何引入Laravle生態(tài)中的開發(fā)拓展包
分兩種情況
分為兩種情況辨图，一種是全局安裝班套，需要在octobercms的根目錄引入composer，還有一種是在自己的插件目錄局部引入故河，局部引入的好處是不用動全局的任務(wù)文件吱韭。
下面我們以https://github.com/mewebstudio/Purifier為例來實例講解下。
相關(guān)環(huán)境：
- October最新版(laravel5.*內(nèi)核)
- PHP7.0
- HTMLPurifier laravel表單過濾插件（
https://github.com/mewebstudio/Purifier）
注其它不同版本和環(huán)境也可參考同樣的流程鱼的。
一理盆、在全局安裝方式
準(zhǔn)備工作
全局安裝需要你先把Octobercms的在線安裝與管理模式全部改為composer來安裝與維護。
如果你一開始是基于composer命令行安裝（參看https://octobercms.com/docs/console/commands#console-install-composer）的凑阶，那么恭喜你猿规，可以直接引入Laravel包了；
如果你一開始是用的在線自動安裝的話那還有點小糾結(jié)宙橱，這里不展開說了姨俩，請對照官網(wǎng)自行操作（參看https://octobercms.com/docs/console/commands#console-install-composer）。
《如何在既有經(jīng)典安裝方式的項目上引入composer來管理》引自官網(wǎng)
To use composer with an October instance that has been installed using the Wizard installation, simply copy thetests/directory,composer.jsonfile andserver.phpfile from GitHub into your October instance and then runcomposer install.
如何安裝
那么進入到這一步就相對簡單了养匈，直接參考laravel包的安裝說明即可
1哼勇、在octobercms的根目錄直接用命令引入包
composer require mews/purifier
或者，如果出現(xiàn)下面的錯誤則可以用編輯composer配置文件呕乎，再更新的方式
This package can be installed via Composer by requiring the
mews/purifierpackage in your project'scomposer.json:
source-json
{
"require": {
"laravel/framework": "~5.0",
"mews/purifier": "~2.0",
}
}
再運行composer update或composer install积担，如果不也什么意外就安裝好了，再接著就是如何調(diào)用了猬仁。
重點一般來說Laravel 5.0以上的很多插件引入時會自動修改配置文件帝璧，但october好像并不認(rèn)，需要手動配置修改文件config/app.php如下兩處湿刽。
修改config/app.php 的providers的烁，加入HTMLPurifier服務(wù)
'providers' => [
// ...
Mews\Purifier\PurifierServiceProvider::class,
]
修改config/app.php 中的aliases配置
'aliases' => [
// ...
'Purifier' => Mews\Purifier\Facades\Purifier::class,
]
發(fā)布配置文件
修改完配置文件后就要生成插件相關(guān)文件了，再在命令行輸入：
php artisan vendor:publish --provider="Mews\Purifier\PurifierServiceProvider"
安裝完畢诈闺。
2渴庆、引入laravel插件到octobercms開發(fā)文件中
在octobercms的相關(guān)文件頂部直接引入就行
//引入laravel插件Invite
use Invite;
二、在Octobercms插件開發(fā)目錄獨立引入
在octobercms的插件中可以為每一個當(dāng)前開發(fā)的插件單獨地寫composer文件來管理依賴，這樣就可以避免影響到全站文件襟雷，方便管理了刃滓，下面為譯文，因原文的說明也有點亂耸弄，故修正下放在這里咧虎，沒時間翻譯了，以后再整理吧计呈。
簡單地說明下流程砰诵，就是直接在octobercms的插件目錄中直接配置composer.json文件來引入，這點很簡單捌显，難的是如何引入這個插件茁彭。
composer.json寫法參考：
{
"name": "luketowers/oc-laravelpackagesexample-plugin",
"type": "october-plugin",
"description": "OctoberCMS plugin for demonstrating the use of Laravel Packages within October plugins",
"homepage": "https://github.com/LukeTowers/oc-laravelpackagesexample-plugin",
"authors": [
{
"name": "Luke Towers",
"email": "octobercms@luketowers.ca"
}
],
"require": {
"mews/purifier": "~2.0"
}
}
引入方法：
在當(dāng)前插件根目錄的Plugin.php文件中引入配置文件，并在其中用boot()方法來進行調(diào)用苇瓣，記得尉间，別忘記plugin.php文件頂部文件的頂部包含必要的facades和命名空間偿乖，另外击罪，記得在正式請求路由之前運行boot()。
Plugin.php文件寫法參考：
<?php namespace LukeTowers\LaravelPackagesExample;
use App;
use Config;
use System\Classes\PluginBase;
use Illuminate\Foundation\AliasLoader;
/**
* Class Plugin
*/
class Plugin extends PluginBase
{
/**
* Returns information about this plugin.
*
* @return array
*/
public function pluginDetails()
{
return [
'name' => 'Laravel Packages Example',
'description' => 'OctoberCMS plugin for demonstrating the use of Laravel Packages within October plugins',
'author' => 'Luke Towers',
'icon' => 'icon-leaf'
];
}
/**
* 在請求路由之前運行 Runs right before the request route
*/
public function boot()
{
// Setup required packages
$this->bootPackages();
}
/**
* Boots (configures and registers) any packages found within this plugin's packages.load configuration value
*
* @see https://luketowers.ca/blog/how-to-use-laravel-packages-in-october-plugins
* @author Luke Towers <octobercms@luketowers.ca>
*/
public function bootPackages()
{
// Get the namespace of the current plugin to use in accessing the Config of the plugin
$pluginNamespace = str_replace('\\', '.', strtolower(__NAMESPACE__));
// Instantiate the AliasLoader for any aliases that will be loaded
$aliasLoader = AliasLoader::getInstance();
// Get the packages to boot
$packages = Config::get($pluginNamespace . '::packages');
// Boot each package
foreach ($packages as $name => $options) {
// Setup the configuration for the package, pulling from this plugin's config
if (!empty($options['config']) && !empty($options['config_namespace'])) {
Config::set($options['config_namespace'], $options['config']);
}
// Register any Service Providers for the package
if (!empty($options['providers'])) {
foreach ($options['providers'] as $provider) {
App::register($provider);
}
}
// Register any Aliases for the package
if (!empty($options['aliases'])) {
foreach ($options['aliases'] as $alias => $path) {
$aliasLoader->alias($alias, $path);
}
}
}
}
}
接著建立一個配置文件config/config.php
格式如下：
<?php return [
// This contains the Laravel Packages that you want this plugin to utilize listed under their package identifiers
'packages' => [
'mews/purifier' => [
// 這里的配置一般在laravel拓展插件的安裝說明里面有Service providers to be registered by your plugin
'providers' => [
'\Mews\Purifier\PurifierServiceProvider',
],
// 這里的配置一般在laravel拓展插件的安裝說明里面有Aliases to be registered by your plugin in the form of $alias => $pathToFacade
'aliases' => [
'Purifier' => '\Mews\Purifier\Facades\Purifier',
],
// 下邊配置插件的命名空間The namespace to set the configuration under. For this example, this package accesses it's config via config('purifier.' . $key), so the namespace 'purifier' is what we put here
'config_namespace' => 'purifier',
// 下邊定義的是Laravel包自己原有的配置贪薪，直接把目標(biāo)Laravel包中的配置文件拷過來就行媳禁，如本例中對應(yīng)的是https://github.com/mewebstudio/Purifier/blob/master/config/purifier.php
// The configuration file for the package itself. Start this out by copying the default one that comes with the package and then modifying what you need.
'config' => [
'encoding' => 'UTF-8',
'finalize' => true,
'cachePath' => storage_path('app/purifier'),
'cacheFileMode' => 0755,
'settings' => [
'default' => [
'HTML.Doctype' => 'XHTML 1.0 Strict',
'HTML.Allowed' => 'div,b,strong,i,em,u,a[href|title],ul,ol,li,p[style],br,span[style],img[width|height|alt|src]',
'CSS.AllowedProperties' => 'font,font-size,font-weight,font-style,font-family,text-decoration,padding-left,color,background-color,text-align',
'AutoFormat.AutoParagraph' => true,
'AutoFormat.RemoveEmpty' => true,
],
'test' => [
'Attr.EnableID' => true
],
"youtube" => [
"HTML.SafeIframe" => 'true',
"URI.SafeIframeRegexp" => "%^(http://|https://|//)(www.youtube.com/embed/|player.vimeo.com/video/)%",
],
],
],
],
],
];
引入原文：
當(dāng)我在OctoberCMS中開發(fā)插件的時候，有過很多次想在其中使用Laravel開發(fā)拓展包的沖動画切，但問題是……
Several times while developing plugins for October, I've needed to include Laravel Packages in the plugin. The problem with doing this is that these packages assume that one will be able to configure them at a project level with things like config files for that specific package that get published to the config folder, or service providers and aliases that need to be registered with the application before you can use them.
I've written a blog post about how to deal with these packages within your October plugins in a clean and easy to use way. You can view the post here https://luketowers.ca/blog/how-to-use-laravel-packages-in-october-cms-plugins/
作者寫了兩篇文章關(guān)于如何在octobercms中使用laravel拓展包的文章竣稽。
http://octobercms.com/forum/post/how-to-use-laravel-packages-in-october-plugins
https://luketowers.ca/blog/how-to-use-laravel-packages-in-october-cms-plugins/
正文如下：
How to use Laravel Packages in OctoberCMS Plugins
This is just a quick guide on how to easily include Laravel Packages in OctoberCMS plugins.
Laravel Packages are often more complicated than simple classes that you can include in your project wherever. They can offer several things that are relatively easy to manage within a barebones Laravel application such as configuration files, service providers, and aliases; however things get slightly more complicated when you wish to use these packages within an October plugin.
The first thing that you’ll need to do in order to use a Laravel Package within your plugin is to require it via composer. Create a composer.json file in your plugin’s folder, and then add the packages you wish to use to the require object. An example of a composer.json for an October CMS plugin that requires a Laravel Package is below:
{
"name": "luketowers/oc-laravelpackagesexample-plugin",
"type": "october-plugin",
"description": "OctoberCMS plugin for demonstrating the use of Laravel Packages within October plugins",
"homepage": "https://github.com/LukeTowers/oc-laravelpackagesexample-plugin",
"authors": [
{
"name": "Luke Towers",
"email": "octobercms@luketowers.ca"
}
],
"require": {
"mews/purifier": "~2.0"
}
}
After you add your packages to composer.json, run composer update from the root of your project; this will pull those dependencies into your project so that you can use them. No need to run composer update or install from your plugin folder itself, if your plugin is being submitted to the October CMS marketplace the marketplace will generate the vendor folder for your plugin automatically.
現(xiàn)在，要做拓展包的初始設(shè)置/安裝了霍弹，你不能僅僅只運行默認(rèn)的擴展包安裝命令就完事兒毫别，你需要注冊service providers和aliases，然后典格，也還要提供一個方法給你的plugin插件岛宦，用來管理拓展包的配置文件。所有這些工作都可以在Octobercms的插件項目中相對輕松地完成耍缴，但是當(dāng)您想要確保您的插件可以實際用于其他人的項目時砾肺，就會遇到棘手的問題。
Now, as far as package initial setup / installation goes, you can’t just run the default installation commands for the package and be done, you need to register service providers and aliases, and then also provide a method for your plugin to manage the configuration of that package. All of these things can be done within an October project relatively painlessly, but the tricky bit comes when you want to make sure that your plugin can actually be used on other people’s projects.
但不要害怕防嗡，因為OctoberCMS包含了好幾種簡單的方法來動態(tài)注冊包的各個組件变汪。下面是我創(chuàng)建的一個方法，它可以方便地給你的plugin插件項目注冊任何的Laravel拓展包蚁趁。將此方法放置在當(dāng)前插件根目錄的Plugin.php文件中裙盾，然后從插件的boot()方法來調(diào)用（同樣在Plugin.php中操作）。
Never fear however, as October includes several easy ways to dynamically register the various components of the package. Below is a method that I’ve created that will easily register any Laravel packages for your plugin. Place this method in your plugin’s Plugin.php file, and then call it from the plugin’s boot() method (also in Plugin.php).
要確保你的plugin.php文件的頂部包含必要的facades，參考下面的寫法：
Also ensure that your Plugin.php includes the necessary facades at the top of the file below the namespace declaration as below:
use App;
use Config;
use Illuminate\Foundation\AliasLoader;
/**
* Boots (configures and registers) any packages found within this plugin's packages.load configuration value
*
* @see https://luketowers.ca/blog/how-to-use-laravel-packages-in-october-plugins
* @author Luke Towers <octobercms@luketowers.ca>
*/
public function bootPackages()
{
// Get the namespace of the current plugin to use in accessing the Config of the plugin
$pluginNamespace = str_replace('\\', '.', strtolower(__NAMESPACE__));
// Instantiate the AliasLoader for any aliases that will be loaded
$aliasLoader = AliasLoader::getInstance();
// Get the packages to boot
$packages = Config::get($pluginNamespace . '::packages');
// Boot each package
foreach ($packages as $name => $options) {
// Setup the configuration for the package, pulling from this plugin's config
if (!empty($options['config']) && !empty($options['config_namespace'])) {
Config::set($options['config_namespace'], $options['config']);
}
// Register any Service Providers for the package
if (!empty($options['providers'])) {
foreach ($options['providers'] as $provider) {
App::register($provider);
}
}
// Register any Aliases for the package
if (!empty($options['aliases'])) {
foreach ($options['aliases'] as $alias => $path) {
$aliasLoader->alias($alias, $path);
}
}
}
}
現(xiàn)在你可以通過在你的插件的配置文件中包含這些包來加載任何的拓展包了番官。
Now, you can load any packages you want by including them in your plugin’s configuration file, which is located here: /plugins/vendorName/pluginName/config/config.php.
任何在vendorName.pluginName::packages配置文件中發(fā)現(xiàn)的包都將自動加載童芹。
Any packages found in the ‘vendorName.pluginName::packages’ config value will be loaded.
下邊是一個用來加載 mews/purifier Laravel package的config.php的寫法示例：
Below is an example of a config.php file that is configured to load the mews/purifier Laravel package.
現(xiàn)在，您可以通過將它們包括在你的插件的配置文件中來加載任意的包了鲤拿，該文件位于這里：
/plugin s/vendorName/pluginName/config/config.php假褪。
config/config.php
所有的包，只要在vendorName.pluginName::packages配置了值的近顷，都會被加載生音。
下面是一份config.php的配置文件示例，該文件被配置為加載mews/purifier Laravel package的laravel包窒升。
<?php return [
// This contains the Laravel Packages that you want this plugin to utilize listed under their package identifiers
'packages' => [
'mews/purifier' => [
// Service providers to be registered by your plugin
'providers' => [
'\Mews\Purifier\PurifierServiceProvider',
],
// Aliases to be registered by your plugin in the form of $alias => $pathToFacade
'aliases' => [
'Purifier' => '\Mews\Purifier\Facades\Purifier',
],
// The namespace to set the configuration under. For this example, this package accesses it's config via config('purifier.' . $key), so the namespace 'purifier' is what we put here
'config_namespace' => 'purifier',
// The configuration file for the package itself. Start this out by copying the default one that comes with the package and then modifying what you need.
'config' => [
'encoding' => 'UTF-8',
'finalize' => true,
'cachePath' => storage_path('app/purifier'),
'cacheFileMode' => 0755,
'settings' => [
'default' => [
'HTML' => [
'Doctype' => 'XHTML 1.0 Strict',
'Allowed' => 'div,b,strong,i,em,a[href|title],ul,ol,li,p[style],br,span[style],img[width|height|alt|src]',
],
'CSS' => [
'AllowedProperties' => 'font,font-size,font-weight,font-style,font-family,text-decoration,padding-left,color,background-color,text-align',
],
'AutoFormat' => [
'AutoParagraph' => true,
'RemoveEmpty' => true,
],
],
'test' => [
'Attr' => ['EnableID' => true]
],
"youtube" => [
"HTML" => ["SafeIframe" => 'true'],
"URI" => ["SafeIframeRegexp" => "%^(http://|https://|//)(www.youtube.com/embed/|player.vimeo.com/video/)%"],
],
],
],
],
],
];
文件的源碼參考
https://github.com/LukeTowers/oc-laravelpackagesexample-plugin
內(nèi)容有些亂缀遍，給自己做個記號，下次再整理了饱须。
