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

2017/01/22 2020/03/28

CakePHP3でcomposerを利用する方法

CakePHP3でcomposerコマンドを実行

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

$ composer --version
Composer version 1.6.5 2018-05-04 11:44:59

1 2	$ composer --version Composer version 1.6.5 2018-05-04 11:44:59

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

$ composer --version
-bash: composer: コマンドが見つかりません

1 2	$ composer --version -bash: composer: コマンドが見つかりません

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

$ php composer.phar --version
Composer version 1.6.5 2018-05-04 11:44:59

1 2	$ php composer.phar --version Composer version 1.6.5 2018-05-04 11:44:59

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

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

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

composer require phpoffice/phpexcel

1	composer require phpoffice/phpexcel

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

C:\xampp\htdocs\cake3> composer require phpoffice/phpexcel
Using version ^1.8 for phpoffice/phpexcel
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
  - Installing phpoffice/phpexcel (1.8.1) Downloading: 100%
Writing lock file
Generating autoload files
> Cake\Composer\Installer\PluginInstaller::postAutoloadDump

C:\xampp\htdocs\cake3>

C:\xampp\htdocs\cake3> composer require phpoffice/phpexcel

Using version ^1.8 for phpoffice/phpexcel

./composer.json has been updated

Loading composer repositories with package information

Updating dependencies (including require-dev)

Package operations: 1 install, 0 updates, 0 removals

- Installing phpoffice/phpexcel (1.8.1) Downloading: 100%

Writing lock file

Generating autoload files

> Cake\Composer\Installer\PluginInstaller::postAutoloadDump

C:\xampp\htdocs\cake3>

　

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

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

composer require phpoffice/phpexcel

1	composer require phpoffice/phpexcel

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

composer require phpoffice/phpexcel:1.6

1	composer require phpoffice/phpexcel:1.6

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

composer require phpoffice/phpexcel:1.*

1	composer require phpoffice/phpexcel:1.*

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

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

C:\xampp\htdocs\cake3> composer require
Search for a package: php-simple-html-dom-parser

Found 15 packages matching php-simple-html-dom-parser

   [0] monashee/php-simple-html-dom-parser
   [1] emanueleminotto/simple-html-dom
   [2] rdir/simple-html-dom
   [3] sunra/php-simple-html-dom-parser
   [4] sb15/php-simple-html-dom-parser
   [5] simple-html-dom/simple-html-dom
   [6] shent/simple-html-dom
   [7] alc/dom-parser-helper
   [8] dimabdc/php-fast-simple-html-dom-parser
   [9] royalmar/simple-html-dom-parser
  [10] axllent/simplehtmldom
  [11] asymptix/php-html-dom-parser
  [12] aayaresko/yii2-advanced-html-dom
  [13] newrey/simplehtmldom
  [14] mgargano/simplehtmldom

Enter package # to add, or the complete package name if it is not listed: 3
Enter the version constraint to require (or leave blank to use the latest version):
Using version ^1.5 for sunra/php-simple-html-dom-parser
Search for a package:
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
  - Installing sunra/php-simple-html-dom-parser (v1.5.2) Loading from cache
Writing lock file
Generating autoload files
> Cake\Composer\Installer\PluginInstaller::postAutoloadDump

C:\xampp\htdocs\cake3>

C:\xampp\htdocs\cake3> composer require

Search for a package: php-simple-html-dom-parser

Found 15 packages matching php-simple-html-dom-parser

[0] monashee/php-simple-html-dom-parser

[1] emanueleminotto/simple-html-dom

[2] rdir/simple-html-dom

[3] sunra/php-simple-html-dom-parser

[4] sb15/php-simple-html-dom-parser

[5] simple-html-dom/simple-html-dom

[6] shent/simple-html-dom

[7] alc/dom-parser-helper

[8] dimabdc/php-fast-simple-html-dom-parser

[9] royalmar/simple-html-dom-parser

[10] axllent/simplehtmldom

[11] asymptix/php-html-dom-parser

[12] aayaresko/yii2-advanced-html-dom

[13] newrey/simplehtmldom

[14] mgargano/simplehtmldom

Enter package # to add, or the complete package name if it is not listed: 3

Enter the version constraint to require (or leave blank to use the latest version):

Using version ^1.5 for sunra/php-simple-html-dom-parser

Search for a package:

./composer.json has been updated

Loading composer repositories with package information

Updating dependencies (including require-dev)

Package operations: 1 install, 0 updates, 0 removals

- Installing sunra/php-simple-html-dom-parser (v1.5.2) Loading from cache

Writing lock file

Generating autoload files

> Cake\Composer\Installer\PluginInstaller::postAutoloadDump

C:\xampp\htdocs\cake3>

PHPフレームワーク CakePHP 3入門

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

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

    "require": {
         ：
        "sunra/php-simple-html-dom-parser": "^1.5"
    },

"require": {

：

"sunra/php-simple-html-dom-parser": "^1.5"

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

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

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

- CakePHP 3.x 4.x 5.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3でレコードを保存（追加、更新、Insert、Update）する複数の方法を紹介

CakePHP3でレコードを追加、更新（Insert、Update）する記述方法を解説。1件ずつ処理、全件をまとめて処理、条件に該当する複数件のレコードを処理方法をサンプルコードを用いて解説。

: CakePHP4のcake cache clear_allでPermission deniedはパーミッションの変更が必要

CakePHP4でキャッシュをクリアするコマンドcake cache clear_allでPermission deniedのエラーが出るのはcakeにパーミッションが足りないとき。その対処方法を解説。

: CakePHP5でヘルパーから他のヘルパーを読み込む方法・CakePHP4からの変更点

CakePHP5のヘルパーで他のヘルパーを読み込む方法を解説。公式の日本語CookbookはCakePHP4のソースのままで間違っているため注意が必要。CakePHP4からの移行の際も同じ点に注意が必要。

: CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法

CakePHP4でテンプレートやレイアウトファイルをデフォルトから変更する場合は「render()」を使用するが、記述場所はできるだけコントローラー内の最後の方に書く方がいい。

: CakePHP4、5のnewEmptyEntityで作成したオブジェクトは空なのか、確認してみた

CakePHPでレコードを新規登録をする際にnewEmptyEntity()を使って空のEntityを作成するが、これのempty、is_nullなどのでの判定結果がtrueかfalseか確認してみた。

: CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説

CakePHP3でデータ保存処理のログを取得する方法。save()では true、falseの戻り値しか取得できないが、saveOrFail()と try…catch文を使いエラーログ、エンティティを取得し、不具合の解析を行う。

: CakePHP4 でコマンドプログラム（シェルプログラム）を作成する方法解説

CakePHP4でバッチ処理を行うためのコマンド・シェルの実装方法について解説。bakeでテンプレートファイルを作成し、「execute()」に処理を記述する方法を解説。

: Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法

CakePHP4のコマンド（シェル）に対して、環境変数を指定して実行する方法を解説。LinuxとWindows上のXAMPPとでは記述方法が異なるため、Windowsのsetコマンドについても詳細解説。

: CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その３

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。