エス技研

WordPress、CakePHP、PHP、baserCMSなどの Web系システムを中心に情報を提供します!


CakePHP3でcomposerを利用してライブラリ・プラグインをインストールする方法

      2020/03/28

CakePHP3でcomposerを利用する方法

 

CakePHP3でcomposerコマンドを実行

 
ライブラリやプラグインをインストールする場合は、「composer require」コマンドを実行します。
 
CakePHP3では、各アプリごとに CakePHP3をインストールする際にも composerを使いますので、composerはインストールされているものとして話を進めます。
 
 
ちなみに、Composerがインストールされているか、否かを確認したいときは下記のコマンドを実行します。

 
バージョンが表示される場合はインストールされています。
下記のように「コマンドが見つかりません」「command not found」と表示される場合は Composerはインストールされていませんのでインストールが必要です。
 

 
 
また、Composerはインストールされていても、「composer.phar」のままの場合は、下記の記述方法で確認することができます。
 

 
これでバージョンが表示される場合は、「composer.phar」を「composer」として適切な場所に移動させるか、「php composer.phar require phpoffice/phpexcel」のようにコマンドを実行する必要があります。
(「composer.phar」を適切な場所に移動させる方法は、検索して探してください。)
 
 

composerコマンド・ライブラリ名が分かっている場合

 
例えば、「CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法」で紹介していますが、PHPからエクセルファイルを出力するプラグインをインストールする際は、下記のような形になります。
 

 
コマンドを実行すると、自動的にプラグインのファイルを取得しに行き、インストールしてくれます。
環境によっては、インストールが始まるまで 1分程度なんのレスポンスもない場合もありますが、きちんとインストールの処理は実行されていますので、そのまま待ちましょう。
 

 

 
上記の画面は、ローカルの Windows状に構築した XAMPP環境で実行しています。
 
 

composerコマンド・ライブラリをバージョン指定でインストールする場合

 

 
先に解説したように、上記のコマンドでライブラリをインストールすると、最新のバージョンでインストールされます。
 
ですが、バージョンを指定したい場合もあるでしょう。そういう場合は下記のように「:1.6」のように指定するバージョンを追加します。
 

 
 
また、具体的なバージョンを指定するのではなく、「1.x系」の最新版をインストールしたいという場合は、下記のように「*」を指定します。
 

 
 

composerコマンド・ライブラリ名があやふやな場合

 
プラグインをインストールする際に、正確なライブラリ名、プラグイン名が分からない場合もあるかと思います。
そのような場合は、ライブラリ名、プラグイン名の一部を入力すると、関連するライブラリのリストを表示してくれますので、その中から選択してインストールする方法もあります。
 
まずは、「composer require」だけを入力します。
 
そうすると「Search for a package:」と表示されますので、ライブラリ名の一部を入力します。
 
その結果、入力したライブラリ名にマッチしたパッケージのリストを表示してくれますので、インストールしたいものの番号を入力すれば OKです。
 
下記の場合は、「php-simple-html-dom-parser」を指定し、「3」を指定しています。
その後は待つだけです。
 

 
 


 

CakePHP3でcomposerコマンドを実行すると作成・更新されるファイル

 
composerコマンドを実行すると、指定したパッケージをインストールしてくれるだけではなく、CakePHP3で利用するために必要なファイルの更新も行ってくれます。
 
具体的には、ルートフォルダにある「/composer.json」「/composer.lock」ファイルが更新されます。
 
「/composer.json」には、「require」の値として、インストールしたパッケージの情報が追加されます。

 
また、「/composer.lock」には、ファイルのパスやバージョン、権限などの設定情報が追加されます。追加される情報はかなり多いので、ここでは割愛します。
 
 
もちろん、インストールしたパッケージ(ライブラリ、プラグイン)も所定の場所である「/vendor」フォルダの中に設置されています。
 
 
composerコマンドでは、これらの処理をまとめて行います。
「/composer.lock」に追加される情報は、アナログ的な対応で設定することは限りなく面倒なので、CakePHP3では、ライブラリやプラグインのインストールは、composerコマンドを使うものだということを理解しておきましょう。
 
 

CakePHP3で composerを使わずにプラグインやライブラリをインストールして使用するする方法

 
ここで記事を書いていますが、CakePHP3でプラグインを利用する場合は、基本的には Composerを利用してインストールをします。
ですが、Composer用のインストーラーが用意されていないプラグインもあります。
そんな場合は、ファイルをダウンロードしてきて、Vendorにファイルを設置して、という手順を踏みますが、手動でプラグインをインストールする方法は下記に記事を書いていますので、こちらを参考にしてください。
CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法
 
 

CakePHP3の関連記事

CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
CakePHP3のInsert On Duplicate Key Update(upsert)構文を解説・バルク処理も
CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順
CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法
CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定
CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する
CakePHP3で環境変数を設定して本番環境と開発環境を分けて処理をする場合
 
その他の「CakePHP3」に関する記事一覧
 
 

 - CakePHP 2.x 3.x

GoogleAdwords

GoogleAdwords

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!

Message

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

下記の空欄を埋めてください。 * Time limit is exhausted. Please reload CAPTCHA.

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)

※入力いただいたコメントは管理者の承認後に掲載されます。

  関連記事

CakePHP3のユーザ管理・認証プラグイン CakeDC/Usersの導入・機能解説・3.1.5対応
CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応

CakePHP3のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。

CakePHP3のメール送信の処理・テンプレート使用・添付ファイル送信も解説
CakePHP3のメール送信の処理・テンプレート使用・添付ファイル送信も解説

CakePHP3からメールを送信する方法解説。基本的な記述方法を基にして、テンプレートを使う方法、ファイルを添付する方法へと拡張しながら解説。

CakePHP 2.3 ID以外のカラムでアソシエーション(連携)をさせる場合の詳細ページの注意点

ID以外のカラムでアソシエーション(連携)させて詳細ページを表示させる際の考え方と注意点をサンプルソースを用いて解説しています。

CakePHP3の検索プラグイン「friendsofcake/search」の様々な検索の仕方の実装方法
CakePHP3の検索プラグイン「friendsofcake/search」の様々な検索の仕方の実装方法

CakePHP3で検索をするプラグイン「friendsofcake/search」の検索条件のカスタマイズ方法の解説。検索項目を増やしたり、以上、以下での検索や、チェックボックスによる検索の方法などを解説。

CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可
CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可

CakePHP3のユーザ管理、ログイン認証プラグインである「CakeDC/Users」のメッセージを日本語にする手順の解説とともに、日本語の翻訳ファイルを提供。ファイルを設置すれば日本語になる!

CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法
CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

CakePHP3のキャッシュファイルのパーミッションエラー Error: SplFileInfo::openFile()が発生した場合の対応方法解説。app.phpにキャッシュファイルのパーミッション設定を行い、既存のファイルは削除。

CakePHP 2.3 連携先のテーブルの項目で条件抽出する場合

アソシエーション(連携)している先のテーブルの項目で条件抽出する際の考え方と注意点をサンプルソースを用いて説明しています。

CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する
CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する

CakePHP3のkeywordsとdescriptionを設定する方法の解説。CakePHP3にはmetaタグを編集するHTMLヘルパーが用意されているためそれを利用すればOK!ポイントはブロック化を有効にすること。

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法
CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法を解説。複数の方法があるが、getParam()メソッドを使う方法が汎用性があって便利かも。

CakePHP3で値を入力直後にバリデーションする方法解説
CakePHP3で値を入力直後にバリデーションする方法解説

CakePHP3でバリデーションの実行を保存する時から入力情報を受け取るときに変更する処理の解説。CakePHP3ではnewEntity()の処理でバリデートするため1行追加で対応可能。