💽 👌🏿 ◀️ Laravelのパッケージを作成する 🔑 🕔 ♠️

こんにちはHabr！

Laravelフレームワークは急速に人気を集めており、すでに多くのファンを獲得しています。この記事では、Laravel用の単純なパッケージの開発、およびcomposer.jsonの1行でパッケージをプロジェクトに追加するためにpackagist.orgで作成したパッケージの公開について説明します。

それで、これについてのすべては何ですか

公式のドキュメントに書かれているように、パッケージはLaravelに新しい機能を追加する主な方法です。 Laravel専用のパッケージを作成します。これは、エントリのリストと記事を表示するためのページを備えたシンプルなブログです。私たちは、カスタマイズの可能性がたくさんある優れた普遍的なブログを書くことを目指していません。パッケージを作成することの詳細はすべて、日常的なタスクを解決するときにプロジェクトでコードの重複を避けるのに役立つ独立した拡張機能としてのみ考慮します。

最後に、それを取得します。

私たちが学ぶこと

プロジェクトの機能を拡張するパッケージを作成する方法。
パッケージ内の基本的な構造を理解しましょう。
ルートを追加する方法を理解しましょう。
テンプレートを保存する場所を見つけます。
スタートアップに追加する必要があるクラスを作曲家に示します。
移行を作成し、テーブルに初期データを入力してみましょう。
パッケージの外部リソース（css、js-ファイル）を利用可能にします。

必要なツール

私はPhpStorm IDEを使用してMacOS用に開発しており、サイト自体は公式Vagrantボックス-Homesteadで回転します。

habrには、Vagrantイメージの設定方法とLaravel自体のインストール方法に関する有用な記事が既にありました。

パッケージは最終的に何を表しますか？

彼には2つのルートがあります。

投稿のリストがあるページ。
別の投稿ページ。

いくつかのテンプレート：

ブログの一般的なレイアウト。
エントリのリストがあるページ。
投稿リストのエントリの短いビュー。
記録の全景。

フィールドを持つ1つの投稿モデル：

役職
ユニークな投稿リンク
投稿テキスト
作成時間
更新時間

また、エントリのテキストから最初の120文字が取得される計算フィールドカット。

すべてに加えて、必要なデータをテンプレートにバインドするために、ページ表示ロジックと追加のコンパイラファイルをグループ化するコントローラークラスを作成します。

結論として、投稿を含むテーブル移行ファイルを作成し、一定量の初期データを含むシードクラスも作成します。

アプリケーションのパブリックフォルダーにパッケージスタイルを公開します。

仕事を始める

これで、Laravelがインストールされ、お気に入りのIDEが開かれ、開始できます。

名前とメールのパラメーターをapp / config / workbench.phpファイルに書き込みます。将来、これらはパラメーターとしてcomposer.jsonで使用されます。

これらのパラメーターを登録したら、コンソールで実行します。

php artisan workbench vendor/package --resources

vendorはサービスプロバイダーの名前で、packageは作成するパッケージの名前です。

たとえば、githubでのログインはcherryoffであり、作成したパッケージnbblogを呼び出したいので、コマンドを実行する必要があります。

 php artisan workbench --resources cherryoff/nbblog

resoursesフラグは、Laravel固有のフォルダー（移行、ビュー、構成など）も作成する必要があることを示しています。

すべてが順調に進んだ場合、プロジェクトのルートに表示されます：

Laravelがアプリケーションの起動時にパッケージを自動的にロードするには、 providers配列のapp / config / app.phpファイルに行を追加する必要があります。

 'Cherryoff\Nbblog\NbblogServiceProvider',

サービスプロバイダーのクラス名は[Package] ServiceProviderスキームに従いますが、完全なクラススペース名はこの前に指定されます

パッケージ構造

srcフォルダーには、おなじみのフォルダーの構造があり、その名前はそれ自体を表しています。

src / Cherryoff / Nbblog /フォルダーにはサービスプロバイダーのクラスが含まれており、パッケージのすべての補助クラスがそこに配置されていることに注意してください。

NbblogServiceProviderクラスをご覧ください 。 registerメソッドは、パッケージが登録されるとすぐに呼び出され、 bootメソッドは、リクエストを処理する前に毎回呼び出されます。

ブログの作成に焦点を当てる

パッケージのsrcフォルダーで、2つのルートを含むroutes.phpファイルを作成します 。

 Route::get('/blog/', array( 'as' => 'posts_list', 'uses' => 'Cherryoff\Nbblog\NbblogController@showList' )); Route::get('/blog/{link}', array( 'as' => 'post', 'uses' => 'Cherryoff\Nbblog\NbblogController@showPost' ))->where('link', '[A-Za-z-_]+');

コントローラーとして、まだ作成されていないコントローラーへのフルパスを指定します。

次に、 コントローラーフォルダーで、次の内容のNbblogControllerコントローラーを作成します。

 <?php namespace Cherryoff\Nbblog; use Illuminate\Support\Facades\App; use Illuminate\Support\Facades\Config; use Illuminate\Routing\Controller; use Illuminate\Support\Facades\Redirect; use Illuminate\Support\Facades\Response; use Illuminate\Support\Facades\Request; use Illuminate\Support\Facades\View; use Illuminate\Support\Facades\Input; use Illuminate\Support\Facades\File; use Illuminate\Support\Facades\Session; use Illuminate\Support\Facades\URL; class NbblogController extends Controller { public function showList() { return 'Posts list'; } public function showPost($link) { return 'Get post:'.$link; } }

さて、これでパスが設定され、コントローラーは簡単なメッセージで応答するはずです。しかし、リンクsandbox.local / blogをたどると、ページが見つからなかったという例外が発生します。問題は、パッケージが独自のパスを持っていることをアプリケーションが認識していないことです。これを修正するために、 NbblogServiceProviderクラスのbootメソッドの最後にroutes.phpファイルを含めます。

 include __DIR__.'/../../routes.php';

しかし、その後でも何も機能せず、エラーをキャッチします。

クラスCherryoff \ Nbblog \ NbblogControllerは存在しません

これは、パッケージ内の作曲家が新しく追加されたコントローラーについて何も知らないことを示しています。 composerに必要なファイルを探す場所を示すには、 classmapセクションのcomposer.json （私たちのパッケージ!!!）に「src / controllers」という行を追加してから、実行します

 composer dump-autoload

今、私たちが行く場合：

sandbox.local /ブログ

次の行が表示されます。

投稿リスト

やった！これは、パスが機能することを意味し、コントローラーが選択されました！

次に、 modelsフォルダーとその中にPost.phpファイルを作成します。ファイルリストを以下に示します。

 <?php namespace Cherryoff\Nbblog; use Illuminate\Database\Eloquent\Model; use Illuminate\Support\Str; use Illuminate\Support\Facades\Config; /** *     */ class Post extends Model { protected $table = 'posts'; //     protected $appends = array('cut'); //     protected $fillable = array('header', 'link', 'article'); //   public static $rules = array( 'header' => 'required|max:256', 'link' => 'required|between:2,32|unique', 'article' => 'required' ); public function getCutAttribute(){ return Str::limit($this->attributes['article'], 120); } }

ここで、 モデルフォルダーをプロジェクトのスタートアップセクションcomposer.jsonに追加し（上記の「 src / controllers 」行を追加する必要があります）、コントローラーの場合と同じようにcomposer dump-autoloadを実行する必要があります。

Laravel WebサイトでEloquentモデルの詳細を読むことができます。

コンソールの行により、パッケージの移行が作成されます。

  php artisan migrate:make create_nbblog_posts_table --bench="cherryoff/nbblog"

src / migrations /フォルダに、新しく作成された移行のクラスが表示されました。彼のupメソッドでは、次のように記述します。

 Schema::create('posts', function (Blueprint $table) { $table->increments('id'); $table->string('link', 32); $table->string('header', 256); $table->text('article'); $table->timestamps(); $table->softDeletes(); });

downメソッドでは：

 Schema::dropIfExists('posts');

したがって、 upメソッドでは、モデルに必要なフィールドを持つテーブルを作成し、 downメソッドでは、存在する場合は削除します

それでは、移行を完了する時が来ました。

 php artisan migrate --bench="cherryoff/nbblog"

データベース接続を正しく構成すると、コンソールに次のようなものが表示されます。

 Migration table created successfully. Migrated: 2014_10_23_115450_create_nbblog_posts_table

次に、新しく作成したテーブルに初期データを入力します。これを行うには、srcフォルダーで、次の内容のNbblogSeeder.phpファイルを使用してseedsフォルダーを作成します。

NbblogSeeder.php

 <?php namespace Cherryoff\Nbblog; use Illuminate\Database\Seeder; class NbblogSeeder extends Seeder { public function run() { $posts = [ [ 'header'=>'Header post number one', 'link'=>'one', 'article'=>' In condimentum facilisis porta. Sed nec diam eu diam mattis viverra. Nulla fringilla, orci ac euismod semper, magna diam porttitor mauris, quis sollicitudin sapien justo in libero. Vestibulum mollis mauris enim. Morbi euismod magna ac lorem rutrum elementum. Donec viverra auctor lobortis. Pellentesque eu est a nulla placerat dignissim. Morbi a enim in magna semper bibendum. Etiam scelerisque, nunc ac egestas consequat, odio nibh euismod nulla, eget auctor orci nibh vel nisi. Aliquam erat volutpat. Mauris vel neque sit amet nunc gravida congue sed sit amet purus. Quisque lacus quam, egestas ac tincidunt a, lacinia vel velit. Aenean facilisis nulla vitae urna tincidunt congue sed ut dui. Morbi malesuada nulla nec purus convallis consequat. Vivamus id mollis quam. Morbi ac commodo nulla. In condimentum orci id nisl volutpat bibendum. Quisque commodo hendrerit lorem quis egestas. Maecenas quis tortor arcu. Vivamus rutrum nunc non neque consectetur quis placerat neque lobortis. Nam vestibulum, arcu sodales feugiat consectetur, nisl orci bibendum elit, eu euismod magna sapien ut nibh. Donec semper quam scelerisque tortor dictum gravida. In hac habitasse platea dictumst. Nam pulvinar, odio sed rhoncus suscipit, sem diam ultrices mauris, eu consequat purus metus eu velit. Proin metus odio, aliquam eget molestie nec, gravida ut sapien. Phasellus quis est sed turpis sollicitudin venenatis sed eu odio. Praesent eget neque eu eros interdum malesuada non vel leo. Sed fringilla porta ligula egestas tincidunt. Nullam risus magna, ornare vitae varius eget, scelerisque. ', ], [ 'header'=>'Very important news', 'link'=>'news', 'article'=>' Donec congue lacinia dui, a porttitor lectus condimentum laoreet. Nunc eu ullamcorper orci. Quisque eget odio ac lectus vestibulum faucibus eget in metus. In pellentesque faucibus vestibulum. Nulla at nulla justo, eget luctus tortor. Nulla facilisi. Duis aliquet egestas purus in blandit. Curabitur vulputate, ligula lacinia scelerisque tempor, lacus lacus ornare ante, ac egestas est urna sit amet arcu. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Sed molestie augue sit amet leo consequat posuere. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Proin vel ante a orci tempus eleifend ut et magna. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus luctus urna sed urna ultricies ac tempor dui sagittis. In condimentum facilisis porta. Sed nec diam eu diam mattis viverra. Nulla fringilla, orci ac euismod semper, magna diam porttitor mauris, quis sollicitudin sapien. ', ], ]; foreach ($posts as $post){ Post::create($post); } } }

seedsフォルダーを起動セクションcomposer.jsonに追加して、再度実行します

 composer dump-autoload

次のコマンドで初期データをロードします。

  php artisan db:seed --class="\Cherryoff\Nbblog\NbblogSeeder"

すべてを正しければ、すべてがエラーなしで終了しました。

src / viewsフォルダーに配置して、ブログのビューテンプレートを作成しましょう。

layout.blade.php

 <!DOCTYPE html> <html> <head> <link href='http://fonts.googleapis.com/css?family=Lora&subset=latin,cyrillic' rel='stylesheet' type='text/css'> <title> @yield('title') </title> </head> <body> <div class="content"> <header> <h1>My simple blog</h1> <small>Just blog package for Laravel</small> </header> <nav> <ul> <li><a href="/">Main page</a></li> <li><a href="/blog/">Blog</a></li> </ul> </nav> @yield('content') </div> </body> </html>

list.blade.php

 @section('title') List @stop @section('content') <small>Number of posts in the blog: {{$count}}</small> <ul class="posts-list"> @forelse($posts as $post) @include('nbblog::preview') @empty <li><h3>No records</h3></li> @endforelse </ul> @stop

preview.blade.php

 <li> <span><small>{{$post->created_at}}</small></span> <h2><a href="/blog/{{$post->link}}">{{$post->header}}</a></h2> <p>{{$post->cut}}</p> </li>

post.blade.php

 @section('title') {{$header}} @stop @section('content') <div class="post-block"> <span><small>{{$created_at}}</small></span> <h2>{{$header}}</h2> <p> {{$article}} </p> </div> @stop

次のようなパッケージタイプにアクセスする必要があることに注意してください。

package_name :: path_to_file 、この場合：

nbblog ::プレビュー

したがって、テンプレートが完成したら、今度はテンプレートをデータで埋め始めることができます。これを行うには、 srcフォルダーにviewComposers.phpファイルを直接作成します。（このファイルはパッケージのどこにでも作成できますが、主なことは接続を忘れないことです）。

viewComposers.php

 <?php /** *          */ View::composer(array('nbblog::list', 'nbblog::post'), function($view){ $view->with('uri', 'blog'); }); View::composer('nbblog::list', function ($view) { $view->with('count', \Cherryoff\Nbblog\Post::count())->with('posts', \Cherryoff\Nbblog\Post::all()); });

uri変数を投稿リストテンプレートと投稿テンプレートにリンクしました（将来、設定からこの変数を取得するとき、1つの場所でビューに転送する方が便利になるでしょう）と、投稿リストテンプレートと共に、すべてのレコードを一度に提供します。

ここで、ファイルroute.phpで行ったように、作成したファイルをサービスプロバイダーのクラス（ src / Cherryoff / Nbblog / NbblogServiceProvider.php ）に接続する必要があります。

  /** *   viewComposers */ include __DIR__.'/../../viewComposers.php';

コントローラーのクラスを変更して、次のようにします。

 class NbblogController extends Controller { public function __construct(){ $this->layout = View::make('nbblog::layout'); } public function showList() { $this->layout->content = View::make('nbblog::list'); } public function showPost($link) { $post = Post::where('link', '=', $link)->firstOrFail(); $this->layout->content = View::make('nbblog::post', $post); } }

これで、ブログの準備が整いました。これは、 sandbox.local / blogで評価できます。

エントリのリストが表示され、投稿が表示されます。

しかし、見た目はあまり良くないので、修正したいと思います。これを行うには、パッケージのパブリックフォルダーにcssフォルダーを作成し、次の内容のmain.cssファイルを追加します。

main.css

 html, body { font-family: 'Lora', "Times New Roman", serif; padding: 0; color: #383840; background-color: #F2F2F2; } a { color: #676673; } a:hover { color: #383840; } span, small { color: #B8B8BF; } .content { width: 600px; margin: 0 auto; } header { text-align: center; } header h1 { margin-bottom: 5px; } nav { width: auto; margin: 0 auto; text-align: center; } nav ul { padding: 0; margin-top: 10px; margin-bottom: 20px; } nav li { list-style: none; display: inline-block; padding: 10px 5px; margin: 0 20px; } .posts-list { padding: 0; } .posts-list li { list-style: none; border-bottom: 1px dotted #B8B8BF; padding-bottom: 10px; margin-top: 20px; margin-bottom: 60px; } .posts-list li > span, .post-block > span { width: 100%; text-align: center; display: inline-block; border-bottom: 1px dotted #B8B8BF; height: 10px; } .posts-list li > span small, .post-block > span small { background-color: #F2F2F2; padding: 10px; } .posts-list h2 { text-align: center; } .posts-list a { text-decoration: none; padding: 10px 20px; }

次のコマンドを使用して、パッケージの外部リソースを公開します。

 php artisan asset:publish --bench="cherryoff/nbblog"

おそらくこれに気づかなかったかもしれませんが、 main.cssファイルは、アプリケーションのパブリックフォルダーに現れました。このフォルダーは、 packages / cherryoff / nbblog / css / folderにあります。

ご想像のとおり、laravelはすべての外部パッケージリソースを処理します。これは、外部リソースのこの命名規則が、テンプレートからこのファイルにアクセスするのに役立つことを意味します。

layout.blade.phpテンプレートで、 タイトルタグの前に行を挿入します 。

 {{ HTML::style('/packages/cherryoff/nbblog/css/main.css') }}

これは、アプリケーションのパブリックフォルダーにあるファイルへのパスです。

ページを更新すると、作成した最も単純なブログが表示されます。

スタイルで、彼は著しく良くなり始めました。

宿題の形式では、ブログのURL設定とテンプレート名で設定ファイルを作成するだけで済みます。これにより、サイト上のブログへのパスを変更したり、独自のテンプレートを使用してコンテンツを表示したりできます。

ここでは、githubでプロジェクトを見ることができます。

ライブデモ。

または、Laravelプロジェクト行のcomposer.jsonに依存関係を追加します： "cherryoff / nbblog"： "dev-master"

まとめ

そのため、Laravel用のパッケージの作成方法を学び、パッケージの構成を確認しました。サードパーティのパッケージをフォークして、ニーズに合わせて簡単に調整できるようになりました。パッケージ内でルーティングがどのように発生するかを確認し、スタートアップ用のファイルを取得する場所をコンポーザーに示す方法を学習し、パッケージ内での移行とシードの実行方法を学習し、アプリケーションのパブリックフォルダーにリソースを公開しました。

この記事は、私が計画したものよりも少し多くなったため、次の記事で説明する内容について少し説明しました。

パッケージ設定を作成し、パッケージファイル自体に触れることなくユーザーに変更する機能を提供する方法を示します。
パッケージフォルダーのgitリポジトリを展開します。
そして、すべてをGithubに書きます。
必要に応じて、新しく作成したパッケージをpackagistで公開します。
githubにアップグレードするときに、packagistでパッケージの自動更新を有効にします。
純粋なLaravelでパッケージをロールします。

これが興味深いことが判明した場合、パッケージの機能を拡張します。

タグを投稿に追加します。
投稿を追加/編集/削除するためのインターフェースを追加します;
パッケージをさらにカスタマイズ可能にしましょう。

うまくいけば、疲れない、きれいなコードです！

記事を書く際に使用されるリンク

LaravelのWebサイト

公式文書の翻訳 ;

情勢を紹介します;

ホームステッドについて語る。

Laravelのパッケージを作成する