CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法

2018/08/11 2019/03/02

CakePHP3で vendorに置いたプラグインを手動で読み込み使う方法解説

CakePHP3でのプラグインは Composerを利用してインストールする方法がメイン

　
CakePHP3で外部のライブラリやプラグインを使う場合は、Composerを使ってインストールしましょう、と書いてあります。
公式サイトや解説してくれているブログなども Composerを利用する方法の解説がほとんどです。
　
私も下記の様に、Composerを使ってプラグインをインストールする方法を解説しています。
CakePHP3でcomposerを利用してライブラリ・プラグインをインストールする方法
　
　
ですが、自作のライブラリであったり、Composerからインストールするファイルが用意されていないプラグインもありまして、そのようなプラグインをどうやって利用するか、詳しく解説しているサイトが見当たらない状況でした。
　
　
そんなある日、とあるサービスの APIを利用して、とある Webサービスを開発することになりましたが、その APIから提供されているサンプルプログラムには Composerを利用してインストールする仕組みが用意されていなかったのです。
　
そんなわけで、サンプルソースをダウンロードしてきたものの、それをどう使えばいいのかがよく分からない！という状況になってしまったのです。
　
そんなわけで、Composerを利用せずに外部ライブラリ、プラグインをインストール、読み込む方法、それを利用する方法を調べましたので、解説します。
　
　
ちなみに、この記事で解説する方法は、Composerは使用しますので、Composerは必要です。
Composerすら使わない方法はまたいずれ。
　

「/vendor/」にプラグインのファイル一式を設置

　
「/vendor/testabc/src/」にプラグインのファイル一式を設置します。
　
下記のサンプルは、「/vendor/testabc/src/」に設置したファイル一式のうちの一つ、「/vendor/testabc/src/GetTestData.php」ファイルです。
　

<?php
namespace TestAbc;
use SoapUtils;
class GetTestData {
    public function getData($id) {
        require_once(dirname(__FILE__).'/SoapUtils.class.php');

       （プラグインの処理）

    }
}

<?php

namespace TestAbc;

use SoapUtils;

class GetTestData {

public function getData($id) {

require_once(dirname(__FILE__).'/SoapUtils.class.php');

（プラグインの処理）

}

　
コントローラーやシェルから呼び出されるファイルの最初には「namespace」を記述します。
ここに記述する「namespace」の名前「TestAbc」は、次の項で説明する「/composer.json」に付けるプラグインの名称、もしくは、プラグインの名称からのパスを記述します。
　
　
また、6行目で「require_once()」でファイルを読み込んでいますが、プラグイン内から読み込むファイル「SoapUtils.class.php」には、「namespace」の追加などの対応は必要ありません。
　
　

「namespace」の付け方

　
「namespace」の付け方は先に少し説明しましたが、「/composer.json」に付けるプラグインの名称、もしくは、プラグインの名称からのパスを記述します。
　
例えば、
「/vendor/testabc/src/GetTestData.php」
にファイルを設置したとします。
　
そして、「composer.json」には、
「"TestAbc\\": "vendor/testabc/src/"」
と記述したとします。
　
この場合の「namespace」は
「namespace TestAbc;」
となります。
　
　
また、「GetTestData.php」を置いたフォルダの中にさらにフォルダを作成し、下記のように
「/vendor/testabc/src/Abc/xyz/GetTestData2.php」
にファイルを設置したとします。
　
この場合は、「GetTestData.php」のプラグインの関連プログラムなので、「composer.json」は変更しません。
　
この場合の「namespace」は、「/vendor/testabc/src/」からのパスを付けて記述しますので
「namespace Abc\xyz\TestAbc;」
となります。
　
　

「/composer.json」ファイルにプラグインの情報を追記

　
続いて、前項で設置したプラグインの情報を「/composer.json」ファイルに記述します。
追加する内容は、下記の 5行目の情報になります。
　

    "autoload": {
        "psr-4": {
            "App\\": "src/",

            "TestAbc\\": "vendor/testabc/src/"
        }

"autoload": {

"psr-4": {

"App\\": "src/",

"TestAbc\\": "vendor/testabc/src/"

}

　
この「TestAbc」は、自由に分かりやすい名称を付与します。
この名称「TestAbc」は、前項で説明した、呼び出される側のプログラムの「namespace」として設定するほか、Controller側、Shell側で呼び出すときの「use句」で「use TestAbc」のように指定する時の名称になります。
　
「vendor/testabc/src/」は、プラグインのファイルを設置したフォルダのパスを指定します。
　
　
また、3行目の「"src/"」の行末の「,（カンマ）」の付け忘れに注意しましょう。忘れがちですので。
　

「composer.json」ファイルの設定変更を有効にするためのコマンドを実行

　
前項で設定を変更した「composer.json」ファイルの内容を有効にするために、下記のコマンドを実行します。
　

$ composer dump-autoload
Generating autoload files
> Cake\Composer\Installer\PluginInstaller::postAutoloadDump

$ composer dump-autoload

Generating autoload files

> Cake\Composer\Installer\PluginInstaller::postAutoloadDump

　
このコマンドを実行することで、下記のファイルなどの「/vendor/composer/」フォルダの中にある設定情報が更新されます。
　
　/vendor/composer/autoload_psr4.php
　/vendor/composer/autoload_static.php
　
　
Composerにパスが通っていない場合などは、上記のコマンドではエラーが発生する場合があります。
その場合は、下記のコマンドを試してみてください。
　

$ php composer.phar dump-autoload

1	$ php composer.phar dump-autoload

設定したプラグインをコントローラー、シェルから呼び出す方法

　
前項までの設定で、プラグイン、ライブラリ側の設定が終り、呼び出せる状態にすることができました。
　
あとは、コントローラーやシェルに、そのプラグイン、ライブラリを呼び出す記述をするだけです。
　
　
サンプルとしてシェル「GetDataShell.php」を作成しました。
　

<?php
namespace App\Shell;

use Cake\Console\ConsoleOptionParser;
use Cake\Console\Shell;

use TestAbc;

class GetDataShell extends Shell {

    public function main() {

        // GetTestDataクラス読み込み
        $getDataObject = new TestAbc\GetTestData;

        // データ取得の実行
        $getDataArray = $getDataObject->getData();

        （以下省略）

<?php

namespace App\Shell;

use Cake\Console\ConsoleOptionParser;

use Cake\Console\Shell;

use TestAbc;

class GetDataShell extends Shell {

public function main() {

// GetTestDataクラス読み込み

$getDataObject = new TestAbc\GetTestData;

// データ取得の実行

$getDataArray = $getDataObject->getData();

（以下省略）

　
まず、7行目で、「use句」を使ってプラグインを使用することを宣言します。
　
続いて、14行目の「new TestAbc\GetTestData」ように「プラグイン名 \ クラス名」として、インスタンスを作成します。
　
これで、ようやく 17行目の記述でアクションが実行できるようになります。
　
　
CakePHP3でシェルを作成する方法については、下記の記事で解説しています。
CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い
　
　
一般的には、シェルよりコントローラーとしてプログラムを開発することの方が多いと思いますが、その場合もシェルと大きな違いはありません。
サンプルとしてコントローラー「GetDataController.php」を作成するとすると、下記の様になります。
　

<?php
namespace App\Controller;

use App\Controller\AppController;

use TestAbc;

class GetDataController extends AppController {

    public function index() {

        // GetTestDataクラス読み込み
        $getDataObject = new TestAbc\GetTestData;

        // データ取得の実行
        $getDataArray = $getDataObject->getData();

        （以下省略）

<?php

namespace App\Controller;

use App\Controller\AppController;

use TestAbc;

class GetDataController extends AppController {

public function index() {

// GetTestDataクラス読み込み

$getDataObject = new TestAbc\GetTestData;

// データ取得の実行

$getDataArray = $getDataObject->getData();

（以下省略）

　
まさに「Shell」が「Controller」に変わっただけです。
　
　

CakePHP3で vendorに置いたプラグインを手動で読み込み使えるようにする方法のあとがき

　
APIなどでサンプルとして提供されているソースファイルなどを CakePHP3で使用する場合、vendorの中に設置して、そのサンプルソース、ライブラリなどを利用したい、と思う場面がありました。
　
ですが、それをどうやったら使えるのか。
　
ググっても、プラグインのインストールには Composerを使ってインストールしましょう、というサイトばかりが出てきます。
Composerでインストールできるファイルを提供していないプラグインの場合はどうすればいいのでしょうか？
　
Composerを使わずにインストールする方法が書いてあるサイトも、情報が少なすぎてそのサイトだけを見ても分からないサイトばかりでした。
　
というワケで、CakePHP3になれていない方であっても分かるように、かなり細かなところまで解説した記事を作成しました。
私と同じように悩んでいる方の助けになれば、と思います。
　
　

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

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

Message コメントをキャンセル

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

: CakePHP3のcontroller内でテンプレート、レイアウトを変更する際の指定方法

CakePHP3でテンプレートファイルやレイアウトファイルをデフォルトのものから別のものに変更したい場合の指定方法を解説。

: CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う

CakePHP3、CakePHP4では処理を高速化する手法の一つとしてキャッシュを利用している。しかし、その情報は元の情報を更新しても反映されない場合がある。そんなときはキャッシュを削除する必要がある。

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

CakePHP3でcomposerを使ってパッケージ（ライブラリ、プラグイン）をインストールする方法の解説。PHPを使うのはCakePHP3が初めてというような方への使い方から解説。

: CakePHP 2.x系　Viewでのコメントの記述方法など

CakePHPにおいて View、ctpファイルでコメントを記述する方法を解説。

: CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説

CakePHP3でJavaScriptやCSSを編集する基本形から、それらやテンプレート（エレメント）を特定のテンプレートを読み込んだときのみ編集、実行するための方法、ブロック化について解説。

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

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

: CakePHP3の画像、ファイルアップロードプラグインUpload Plugin 3.0の設置解説・その１

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその1で基本的な導入方法の解説で読みながら簡単に導入が可能。

: CakePHP3ログファイルへの出力・$this->log()、独自ログへの出力方法の解説

コントロール、モデルの変数の中身を見るときはログに出力する方法が有効です。$this->log()を利用すると変数だけじゃなく、連想配列、オブジェクトも簡単にログ出力ができます。

: MySQL、CakePHP 2.3で「tinyint(1)」の Boolean型の動作を再確認

MySQL＋CakePHPの環境で「tinyint(1)」を利用する際の動作を検証。「tinyint(1)」の Boolean型について CakePHPでは自動処理が実施されていることを確認しました。