shirane lab - personal notes on drupal & web application

Drupal recipes について

shirane — Wed, 21 Dec 2022 23:16:21 +0000

Drupal recipes について shirane 2022/12/22(木) - 08:16

この記事は、Drupal Advent Calendar 2022 の 22 日目です。

Drupal recipes は、Drupal サイトに特定の機能を追加できるようにする新しい仕組みです。Portland DrupalCon 2022 の Driesnote で Starter templates として紹介されたアイデアで、現在では Drupal recipes という名前で Distributions & Recipes initiative によって開発が進められています。

※Drupal コミュニティの initiative とは、特定の関心事に基づく作業グループのことです。中でも Dries 氏が特に重要と感じたものは Strategic initiatives に指定されています。Distributions & Recipes initiative も Startegic initiatives の１つです。

現在、こちらのリポジトリで仕様の検討と試験的な実装による検証を繰り返している段階と思われます。全体の計画や現在の状況は、下記ページで知ることができます。

目指すもの

Drupal は高度な柔軟性と拡張性を備えていますが、それを活用して特定の要件を満たす構成を実現する仕事はサイトビルダーに任されています。多くの初心者はここで行き詰まります。ですが、事前に定義された構成設定（例：SEO 対策、ブログ、ショッピングカート、等）が汎用的な「レシピ」として利用できるとしたらどうでしょう。もっと簡単にサイトを構築できると思いませんか？これが Drupal recipes の目指すところです。

Distributions & Recipes initiative としては、次のような目標を掲げています。

必要なレシピを（将来は Project Browser で）探せる
同じサイトで複数のレシピを使用できる
インストール後のサイトにもレシピを導入できる
開始時の構成を共有する大量の複数サイトを容易に保守できる
インストール済みのサイトを簡単に更新できる（Update Helper の利用）
drupal.org と Composer によるサポートの強化
デモ用コンテンツを同梱できる

従来、定義済みの構成設定を利用させる手段としてディストリビューションやインストールプロファイルが使われてきました。これらはサイト構成全体をインストール時の初期状態として提供します。他方、レシピは（サイト全体ではなく）個別の機能や構成設定を提供するもので、既にインストール済みのサイトに後から追加することや、同じサイトで複数のレシピを組み合わせて利用することもできます。

詳細については、Alex Pott 氏（プロジェクトリード）による DrupalCon Prague 2022 のセッションで解説とデモを見ることができます。

サンプル

上記セッションのデモを参考に Drupal 10 でサンプルを作ってみました。現在、Drupal recipes の試験実装を利用するには Drupal core にパッチを適用する必要があるため、自作のインストールプロファイル「SQbase」の 10.0-demo-recipe ブランチとして、適用済みの D10 プロジェクトを公開しています。

試してみるには、まず、ローカルサイトをインストールします。
(自作の Drupal 実習用仮想マシン環境 ffdsm での例を示します)

### サイトをインストールする
$ cd /var/www
$ git clone https://github.com/bkenro/sqbase.git -b 10.0-demo-recipe
$ cd sqbase
$ composer install
$ drush @local sql:create -y
$ drush @local site:install sqbase -y

これでローカルのサイトが立ち上がります。初期状態では、記事と基本ページという２つのコンテンツタイプが用意されています。

このプロジェクトには、現行の Drupal recipes の試験実装、およびそれを利用したレシピのサンプル（web/recipes/myevent フォルダ）が組み込まれています。サンプルの内容は「イベント」というコンテンツタイプの追加と、関連するロールと権限を設定するものです。

レシピの定義ファイル recipe.yml ファイルを示します。

name: 'My Event'
description: 'イベントのコンテンツタイプを追加する Drupal recipe サンプル'
type: 'Content type'

install:
  - datetime_range
  - field
  - field_group
  - field_ui
  - menu_ui
  - node
  - path
  - text

config:
  actions:
    user.role.editor:
      ensure_exists:
        label: 'イベント編集者'
      grantPermissions:
        - 'delete any event content'
        - 'edit any event content'

install キーは、レシピに必要なコンポーネント（モジュール）のリストです。レシピ適用時に自動インストールされます。また、config / actions キーは、Config Actions という API を利用して新しいロールと権限を追加する設定です。

これを、いまインストールしたサイトに適用してみます。試験実装では Drupal CLI の drupal コマンドに recipe というサブコマンドが追加されるので、この引数として組み込むレシピのパスを指定します。

### Webルートに移動してCLIでレシピを組み込む
$ cd web
$ php core/scripts/drupal recipe recipes/myevent

 [OK] My Event applied successfully

正常に実行されると、「イベント」コンテンツタイプ、および関連するロールと権限が追加されるはずです。

上記は自作プロファイルを利用した例でしたが、別のインストールプロファイルでインストールしたサイトでも同様にこのレシピを適用することができます。

### 最小プロファイルでインストールする例
$ drush @local site:install minimal -y
### 標準プロファイルでインストールする例
$ drush @local site:install standard -y
### Umami プロファイルでインストールする例
$ drush @local site:install demo_umami -y

どのプロファイルでインストールした場合でも、myevent レシピを適用することで、上の例と同様、「イベント」コンテンツタイプや関連するロール／権限が追加されることがわかると思います。

このように、レシピを利用すると、サイトのインストールに使用したプロファイル（またはディストリビューション）に関係なく、既にインストール済みのサイトに対して、特定の機能や構成を追加で組み込むことができます。

SEO 対策、ブログ機能、ショッピングカート機能、…といった汎用的な「レシピ」が豊富に提供されるようになれば、サイト要件に応じて必要なレシピを組み込むことで、高度な Web アプリケーションを簡単に構築できるようになるかもしれません。

おわりに

ディストリビューションのようにサイト全体の構成設定が一体化したモノリシックな構造ではなく、より小さい粒度の汎用的な機能や構成をレシピとして定義できるようになれば、より幅広い層の人たちが Drupal のサイトビルダーとして活躍できる可能性があります。

Drupal core の機能をネジ・クギとするなら、レシピは目的ごとに用意された汎用的な組み立て部品、ディストリビューションはそれらをパッケージした手作りキットのようなイメージでとらえることができるでしょうか。

他方、開発中のリポジトリのドキュメントなどを見ると、解決しなければならない課題も少なくないようで、かなり挑戦的な取り組みのように思えます。最終的に Drupal core に取り込まれる時期や、先述の目標がすべて達成されるのかどうかはまだわかりません。ただ、個人的には、ディストリビューションの作成やメンテナンスという観点から、現行の実装でもレシピは十分に有用な技術だと考えています。今後の展開に注目していきたいと思います。

『D9 おいしいレシピ集2』がパワーアップして商業誌に

shirane — Mon, 20 Jun 2022 00:33:44 +0000

『D9 おいしいレシピ集2』がパワーアップして商業誌に shirane 2022/06/20(月) - 09:33

『Drupal 9 おいしいレシピ集2』がインプレスR&Dさん技術の泉シリーズから商業誌として発売。今回も Drupal ユーザーに役立つ情報満載、同人誌発行後の加筆修正でさらなる充実の内容です。

【目次】
第1章　settings.php探訪
第2章　Webformをアンケート収集に活用しよう
第3章　Feedsモジュールの活用とDrupalから記事配信まで
第4章　Geofieldモジュールで位置情報を可視化
第5章　Drupalで理解するOAuth 2.0
第6章　インストールプロファイルを作ってみよう
第7章　Drushの独自コマンドを作ってみよう

私は第6章の「インストールプロファイルを作ってみよう」と、今回新たに追加になった第7章「Drush の独自コマンドを作ってみよう」を書きました。drush generate module コマンドでモジュールのひな形コードを生成したり、Xdebug でステップ実行したり、drush php:cli コマンドで PHP REPL の PsySH を使って Drupal コアが提供するサービスを調査したり、調べた Drupal のサービスを DI（依存性注入）してコマンドを実装したりする話です。私の担当章は毎度ニッチなネタですが（笑）ご興味ある方は是非チェックしてみていただけると嬉しいです。

よろしくお願いいたします。

Tag

書籍

『Drupal 9 おいしいレシピ集』の続編が発売！

shirane — Wed, 19 Jan 2022 14:05:47 +0000

『Drupal 9 おいしいレシピ集』の続編が発売！ shirane 2022/01/19(水) - 23:05

昨年末に商業誌版が刊行された『Drupal 9 おいしいレシピ集』ですが、早くもこの１月の技術書典12で続編『Drupal 9 おいしいレシピ集2』が出ます。

タイトなスケジュールの中、Drupal Meetup 豊田支部の有志が年末年始と土日の休みを捧げて（笑）書き上げた一冊です。既刊に引き続き今回も各章独立のオムニバス形式、多彩なテーマで Drupal 9 の実践テクニックを紹介しています。

やはり目玉は計2ページの4コマ漫画。今回は「あとがき」にもにゃんコツが登場します。まるでアニメを見終わった後のような名残惜しさが漂う…

第1章　settings.php 探訪
第2章　Webform をアンケート収集に活用しよう
第3章　Feeds モジュールの活用と Drupal から記事配信まで
第4章　Geofield モジュールで位置情報を可視化
第5章　Drupal で理解する OAuth 2.0
第6章　インストールプロファイルを作ってみよう

私は、第6章「インストールプロファイルを作ってみよう」を担当。Drupal の構成管理と Default Content モジュールを利⽤して、事前に⽤意した構成とコンテンツに基づいて新規サイトをインストールする例を紹介しています。

どんなことができるのかを動画にまとめてみました。

ご興味をお持ちいただけたなら、ぜひ本をチェックしてみてください。すぐに役立つ Drupal の情報満載の一冊です。技術書典、BOOTH のほか、Kindle でもお読みいただけます。

よろしくお願いいたします。

Tag

書籍

.ssh/config を変更したら vagrant ssh が動かなくなったので

shirane — Fri, 14 Jan 2022 04:06:57 +0000

.ssh/config を変更したら vagrant ssh が動かなくなったので shirane 2022/01/14(金) - 13:06

Windows の Git をアップデート後、git でリモートリポジトリにアクセスしようとしたらエラーになった。

>git fetch origin
Unable to negotiate with ～ port ～: no matching host key type found. Their offer: ssh-rsa
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

~/.ssh/config に下記エントリを追加して回避すると、

HostkeyAlgorithms +ssh-rsa
PubkeyAcceptedAlgorithms +ssh-rsa

今度は vagrant ssh コマンドが動かなくなった。

>vagrant ssh
C:\\Users\\shirane/.ssh/config: terminating, 1 bad configuration options

困った。どうするか。

回避策１

vagrant ssh は次のようにする：

>vagrant ssh -- -F /dev/null

回避策２

空の config ファイルを作って Vagrantfile で指定する。たとえば、empty_config という名前の空のファイルを作り、次の記述を

config.ssh.config = "empty_config"

Vagrantfile に追加する。

１と２のどちらかで、とりあえず git も vagrant ssh も使えるようになった。

参考資料

Tag

ffdsm

Vagrant

DruxtJS について

shirane — Tue, 21 Dec 2021 23:11:21 +0000

DruxtJS について shirane 2021/12/22(水) - 08:11

この記事は Drupal Advent Calendar 2021 の22日目です。

DruxtJS は、Nuxt.js と Drupal を組み合わせたフルデカップルのサイトや SPA を構築するためのフレームワークです。Drupal をコンテンツリポジトリとして利用しながら、Nuxt.js ベースの SPA や SSG サイトを構築することができます。

TL;DR: Druxt = DRUpal + nUXT.

Drupal と Vue.js でデカップル構成のシステムを構築する際の有力な選択肢になりそうです。ここでは、DruxtJS 公式サイトの資料に従って、デモサイトの動作とクイックスタートの手順を確認してみた内容をレポートします。

Umami デモ

Drupal のデモ用インストールプロファイルである Umami を利用したデモが用意されています。GitHub 上に、Drupal プロジェクト（バックエンド）と Nuxt プロジェクト（フロント）のリポジトリが公開されています。

まずは、これをインストールしてみました。どちらも Gitpod 上で動かせるように構成されていますが、今回はローカルの仮想マシン環境で動かすことにします。なお、Gitpod を利用した Drupal の開発環境については、Drupal Advent Calendar 2021 の5日目「最短でDrupal開発環境（お試し環境）を手に入れる2021」に解説があります。

Drupal（バックエンド）側

通常の Drupal サイトの要領でインストールします。ここでは、Drush とサイトエイリアス @local の定義を追加して次のようにローカルサイトを立ち上げました。

$ cd /var/www
$ git clone https://github.com/druxt/demo-api.druxtjs.org.git
$ cd demo-api.druxtjs.org
$ composer require drush/drush
$ drush @local sql:create
$ drush @local site:install demo_umami

なお、サイトエイリアスの使い方については、先日発売されたインプレスR&D「技術の泉」シリーズの商業誌『Drupal 9 おいしいレシピ集』にまとめましたので、是非そちらもチェックしてみてください。

ここでは、上記プロジェクトの web サブディレクトリを umami.internal という仮想ホストとして構成しました。仮想ホストの設定手順は、こちらの動画とトレーニング教材にまとめています。

正常にインストールできたら、DruxtJS Umami モジュールを有効にします。

$ drush pm:enable druxt_umami

管理用テーマの Gin がデフォルトに設定された Umami サイトが立ち上がりました。いつもの umami テーマとは違う外観で、ちょっと新鮮な感じです。

以下では、このサイト http://umami.internal/ をリポジトリサーバーとして利用します。外部から DruxtJS のリソースへのアクセスができるように、匿名ユーザーにアクセス権を設定しておきます。

$ drush role-add-perm anonymous 'access druxt resources'

Nuxt（フロント）側

次にフロント側の Nuxt プロジェクトをインストールします。今回使用した仮想マシン ffdsm には Node.js が入っていないので、まずインストールしておきます。ffdsm は Ubuntu 20.04 ベースなので、Qiita の記事「Ubuntuに最新のNode.jsを難なくインストールする」を参考にさせていただきました。

$ sudo apt install -y nodejs npm
$ sudo npm install n -g
$ sudo n stable
$ sudo apt purge -y nodejs npm
$ exec $SHELL -l

上記手順で無事インストールされました。

$ node -v
v16.13.1
$ npx -v
8.1.2

フロント側のプロジェクトはホームディレクトリにクローンした後、ディレクトリを移動して、nuxt.config.js ファイルをエディタで開きます。

$ cd ~
$ git clone https://github.com/druxt/demo.druxtjs.org.git
$ cd demo.druxtjs.org
$ vi nuxt.config.js

119行目付近にある baseUrl の値を、先に立ち上げたバックエンド側の URL に設定します。

～
   // Druxt Configuration
   druxt: {
     baseUrl: 'http://umami.internal',
     blocks: {
～

パッケージをインストールして起動します。今回は仮想マシン上で動かすので、ホスト OS 側からアクセスできるように環境変数 HOST を 0.0.0.0 に設定しておきます。

$ npm install
$ HOST=0.0.0.0 npm run dev
…
✔ Druxt schema generated                                                      06:26:47
✔ Nuxt files generated                                                        06:26:48

✔ Client
  Compiled successfully in 53.45s

✔ Server
  Compiled successfully in 38.24s

ℹ Waiting for file changes                                                    06:27:45
ℹ Memory usage: 316 MB (RSS: 497 MB)                                          06:27:45
ℹ Listening on: http://10.0.2.15:3000/

DeprecationWarning の警告が表示されますが、ポート 3000 の待ち受けで Web サーバーが起動しました。ブラウザで http://umami.internal:3000 にアクセスしてみます。

一見、普通の Umami サイトのように見えますが、Nuxt ベースのアプリケーションなので、Vue.js devtools でコンポーネントの階層を確認することができます。

設定が不十分なためか、パスが未解決になるリンクもありますが、おなじみの Umami サイトが Nuxt アプリケーションとして再現される様子はインパクトがあります。

フロント側を自作してみる

今度は、Nuxt のプロジェクトを自分で作ってアクセスしてみます。プロジェクト名は druxt にしました。

$ cd ~
$ npx create-nuxt-app druxt

create-nuxt-app v4.0.0
✨  Generating Nuxt.js project in druxt
? Project name: druxt
? Programming language: JavaScript
? Package manager: Npm
? UI framework: None
? Nuxt.js modules: (Press <space> to select, <a> to toggle all, <i> to invert selection)
? Linting tools: (Press <space> to select, <a> to toggle all, <i> to invert selection)
? Testing framework: None
? Rendering mode: Universal (SSR / SSG)
? Deployment target: Server (Node.js hosting)
? Development tools: (Press <space> to select, <a> to toggle all, <i> to invert selection)
? What is your GitHub username?
? Version control system: None

公式の Getting started with DraxtSite に従って、使用するモジュールのインストールと設定を行います。

$ cd druxt
$ npm i druxt-site
～
$ vi nuxt.config.js

nuxt.config.js ファイルの最後の部分を次のように編集します。

～

  // Modules: https://go.nuxtjs.dev/config-modules
  modules: [
    'druxt-site'
  ],
  druxt: {
    baseUrl: 'http://umami.internal'
  },
  // Build Configuration: https://go.nuxtjs.dev/config-build
  build: {
  }
}

生成されたプロジェクトには、pages ディレクトリの下にデフォルトの index.vue が生成されていますが、とりあえずファイル名を変更して無効にしておきます。

$ cd pages
$ mv index.vue index.vue.org
$ cd ..

この状態で実行してみます。

$ HOST=0.0.0.0 npm run dev

> druxt@1.0.0 dev
> nuxt

ℹ [HPM] Proxy created: /sites/default/files  -> http://umami.internal         07:16:52

   ╭────────────────────────────────────────╮
   │                                        │
   │   Nuxt @ v2.15.8                       │
   │                                        │
   │   ▸ Environment: development           │
   │   ▸ Rendering:   server-side           │
   │   ▸ Target:      server                │
   │                                        │
   │   Listening: http://10.0.2.15:3000/    │
   │                                        │
   │   Druxt @ v0.15.0                      │
   │   API: http://umami.internal/jsonapi   │
   │                                        │
   ╰────────────────────────────────────────╯

ℹ Preparing project for development                                           07:16:54
ℹ Initial build may take a while                                              07:16:54
ℹ Discovered Components: .nuxt/components/readme.md                           07:16:54
✔ Builder initialized                                                         07:16:54
✔ Druxt schema generated                                                      07:16:55
✔ Nuxt files generated                                                        07:16:55

✔ Client
  Compiled successfully in 26.63s

✔ Server
  Compiled successfully in 23.81s

ℹ Waiting for file changes                                                    07:17:25
ℹ Memory usage: 226 MB (RSS: 345 MB)                                          07:17:25
ℹ Listening on: http://10.0.2.15:3000/

無事起動したので、ブラウザでアクセスしてみます。

pages のほか、layouts や components の各ディレクトリも空の状態なので、この場合は DruxtSite のデフォルトの出力として、利用可能なブロックコンポーネントがすべて表示されます。必要な情報が不足しているブロックは、枠線の中にコンポーネントのオプションとブロックの設定が表示されるようです。

バックエンド側から JSON:API で提供される情報に基づいて、フロント側で自動的にコンポーネントのインスタンスが用意されるので、それらを利用して、API のドキュメントを見つつレイアウトやページをコーディングしていく流れになるのかなと思います。このあたりは、筆者に Nuxt 力がないため、Theming の具体的な検証には至りませんでした。

Storybook

最後に、Storybook を入れてみました。

$ npm i @nuxtjs/storybook
$ npx nuxt storybook

コンポーネントとして提供されるブロック、メニュー、エンティティ、ビューなどがカタログ化され、ブラウズできます。

まとめ

DruxtJS を利用したサイト作成について、導入のところを簡単に試してみました。モジュールを入れて動かすだけで、Drupal バックエンドが提供する各種ブロックが自動的にコンポーネントとして登録され、DruxtJS の API を通じて利用できるようになるので、デカップル構成におけるサイト制作がかなり楽になるのではと思いました。

DruxtJS には、他にも Proxy や JSON:API Client などの API があり、これらを利用してフォーム送信や検索といったアプリケーション機能の実装もサポートされるようです。このあたりは、Nuxt 力をつけてから改めて検証してみたいと思います。

より網羅的な紹介は、DrupalCon Europe 2021 のセッション「MAKERS & BUILDERS - DruxtJS 101- Fully Decoupled Drupal with JSON-API and Nuxtjs」をご覧になるのが良いと思います。

大変興味深い内容なので、おすすめです。

参考資料

Tag

Drupal 9 おいしいレシピ集がパワーアップしてインプレスR&D「技術の泉シリーズ」から発売

shirane — Thu, 16 Dec 2021 11:07:18 +0000

Drupal 9 おいしいレシピ集がパワーアップしてインプレスR&D「技術の泉シリーズ」から発売 shirane 2021/12/16(木) - 20:07

技術書典11の同人誌『Drupal 9 おいしいレシピ集』が大幅にパワーアップして、インプレスR&D「技術の泉シリーズ」の商業誌として発売されます。

私は４章「Drushとサイトエイリアスで楽々サイト管理」を担当。ローカル、Docker、リモートの各環境で稼働する Drupal サイトに対し、簡潔で直感的に種々の Drush コマンドを実行できるようにする手法を紹介しています。リモートサイトの操作や環境間のデータコピーなど、Drush を使ったサイト管理作業がグッと楽になること請け合いです。

他にも、オープンソース CMS の Drupal 9 に関する実践ノウハウ＆テクニック集が満載。各章完結オムニバス形式、章末の４コマ漫画にご注目！

【目次】

第1章　GitLab.comで手軽に始めるCI環境構築
第2章　オンプレミスで自分だけのCI環境構築
第3章　モジュール開発でCI実践
第4章　Drushとサイトエイリアスで楽々サイト管理
第5章　Groupモジュールで会員限定サイトを構築
第6章　JamstackでヘッドレスDrupalを爆速構築
第7章　Webformで簡単フォーム作成
第8章　MauticとDrupalで行う自動連携

Tag

Drupal9

書籍

drush php:cli と psysh について

shirane — Fri, 10 Dec 2021 15:16:36 +0000

drush php:cli と psysh について shirane 2021/12/11(土) - 00:16

この記事は Drupal Advent Calendar 2021 の11日目です。

ちょっとしたコードを CLI で動かしたい時に便利な環境が REPL です。Drupal 9 では、Drush の php:cli コマンドで PsySh という PHP の REPL が利用できます。

インストールと実行

Drush の依存関係に PsySh が含まれているので、Composer で Drush を入れるだけで使えます。

ただし、2021年12月5日にリリースされた最新の PsySh v0.11 が導入されると、現状の Drush ではエラーが発生します。このため、いま現在 Drush の新規インストールやアップデートを行うと php:cli コマンドが動作しない状態に陥る可能性があります。

修正のプルリクが出ていますが、反映されるまでの回避策として、PsySh の旧 0.10 版を手動で入れる方法が考えられます。PsySh v0.10.12 を上書きインストールする例を示します。


$ cd <プロジェクトのルート>
$ curl -L https://github.com/bobthecow/psysh/archive/refs/tags/v0.10.12.tar.gz | tar xzf - --strip=1 -C vendor/psy/psysh

追記（2021-12-17）
Drush 10.6.2 で psysh への依存関係が次のように変更されて解決しました。

"psy/psysh": ">=0.6 <0.11",

Drush をアップデートしてみたところ、psysh がダウングレードされ、drush php:cli コマンドで正常に対話シェルが起動することを確認しました。

$ composer update drush/drush -w
Loading composer repositories with package information
Updating dependencies
Lock file operations: 0 installs, 2 updates, 0 removals
  - Upgrading drush/drush (10.6.1 => 10.6.2)
  - Downgrading psy/psysh (v0.11.0 => v0.10.12)
Writing lock file
Installing dependencies from lock file (including require-dev)
Package operations: 0 installs, 2 updates, 0 removals
  - Downgrading psy/psysh (v0.11.0 => v0.10.12): Extracting archive
  - Upgrading drush/drush (10.6.1 => 10.6.2): Extracting archive
Package doctrine/reflection is abandoned, you should avoid using it. Use roave/better-reflection instead.
Package webmozart/path-util is abandoned, you should avoid using it. Use symfony/filesystem instead.
Generating autoload files
45 packages you are using are looking for funding.
Use the `composer fund` command to find out more!
$

導入されている PsySh のバージョンが 0.10.x であれば正常に起動します。

$ drush php:cli
Psy Shell v0.10.12 (PHP 7.4.3 — cli) by Justin Hileman
DEMO site (Drupal 9.3.0)
>>>

起動したら、プロンプト（>>>）に PHP コードを入力して、変数、関数、クラスなどを定義できます。

>>> $msg = 'Hello!';
=> "Hello!"
>>> function greet($peer) {
...   echo "Hi, $peer!";
...   return $peer;
... }
>>> class Person {
...   private $name = '';
...   
...   public function __construct($name) {
...     $this->name = $name;
...   }
...   
...   public function greet($peer) {
...     echo "Hi $peer, I'm $this->name!";
...     return $this->name;
...   }
... }
>>>

式を入力すると評価結果が表示され、ステートメントを入力すると実行されます。

>>> $msg
=> "Hello!"
>>> greet("Jiro");
Hi, Jiro!⏎
=> "Jiro"
>>> $taro = new Person("Taro");
=> Person {#4524}
>>> $taro->greet("Jiro");
Hi Jiro, I'm Taro!⏎
=> "Taro"
>>>

PsySh の機能

PsySh manual に詳しい説明があります。以下、一部を紹介します。

マジック変数

最後に使用した値が情報の種類別に保持されており、これをマジック変数（$ で始まる定義済みの変数）で取得することができます。

>>> $_    // 最後の結果を保持するマジック変数
=> "Taro"
>>> greet('Hanako');
Hi, Hanako!⏎
=> "Hanako"
>>> $_
=> "Hanako"
>>>

PsySh コマンド

PsySh は種々の組み込みコマンドを備えています。たとえば、ls コマンドを実行すると、ローカル変数やインスタンス等の一覧が表示されます。

>>> ls 
Variables: $container, $msg, $taro
>>> ls -al

Variables:
  $container   Drupal\Core\DependencyInjection\Container {#768 …620}  
  $msg         "Hello!"                                               
  $taro        Person {#4524}                                         
  $_           "Hanako"                                               
  $__out       "Hi, Hanako!"

各コマンドの詳しい情報は、help コマンドで確認できます。

>>> help ls
Usage:
 ls [--vars] [-c|--constants] [-f|--functions] [-k|--classes] [-I|--interfaces] [-t|--traits] [--no-inherit] [-p|--properties] [-m|--methods] [-G|--grep GREP] [-i|--insensitive] [-v|--invert] [-g|--glob>

Aliases: dir

Arguments:
 target             A target class or object to list.

Options:
 --vars             Display variables.
 --constants (-c)   Display defined constants.
 --functions (-f)   Display defined functions.
 --classes (-k)     Display declared classes.
 --interfaces (-I)  Display declared interfaces.
 --traits (-t)      Display declared traits.
 --no-inherit       Exclude inherited methods, properties and constants.
 --properties (-p)  Display class or object properties (public properties by default).
 --methods (-m)     Display class or object methods (public methods by default).
 --grep (-G)        Limit to items matching the given pattern (string or regex).
 --insensitive (-i) Case-insensitive search (requires --grep).
 --invert (-v)      Inverted search (requires --grep).
 --globals (-g)     Include global variables.
 --internal (-n)    Limit to internal functions and classes.
 --user (-u)        Limit to user-defined constants, functions and classes.
 --category (-C)    Limit to constants in a specific category (e.g. "date").
 --all (-a)         Include private and protected methods and properties.
 --long (-l)        List in long format: includes class names and method signatures.
 --help (-h)        Display this help message.

Help:
 List variables, constants, classes, interfaces, traits, functions, methods,
 and properties.
 
 Called without options, this will return a list of variables currently in scope.
 
 If a target object is provided, list properties, constants and methods of that
 target. If a class, interface or trait name is passed instead, list constants
 and methods on that class.
 
 e.g.
 >>> ls
 >>> ls $foo
 >>> ls -k --grep mongo -i
 >>> ls -al ReflectionClass
 >>> ls --constants --category date
 >>> ls -l --functions --grep /^array_.*/
 >>> ls -l --properties new DateTime()

dump コマンドは、オブジェクトや基本型の値をダンプします。

>>> dump -a $taro
Person {#4524
  -name: "Taro",
}
>>>

doc コマンドを使用すると、PHP のオブジェクト、クラス、定数、メソッド、プロパティのドキュメントを閲覧できます。ただし、事前に PHP マニュアルをダウンロードしてインストールしておく必要があります。日本語版をインストールする例を示します。

$ wget http://psysh.org/manual/ja/php_manual.sqlite -P ~/.local/share/psysh

以後は、調べたいものを引数に指定して doc コマンドを実行すると、そのマニュアルが表示されます。

>>> doc implode
function implode($glue, $pieces)

Description:
  配列要素を文字列により連結する
  
  配列の要素を $glue 文字列で連結します。
  
  implode()は、歴史的な理由により、引数をどちら の順番でも受けつけることが可能です。しかし、
  explode() との統一性の観点からは、 ドキュメントに記述された引数の順番を使用しないことは推奨されま
  せん。

Param:
  string  $glue    デフォルトは空文字列です。
  array   $pieces  連結したい文字列の配列。

Return:
  string  すべての配列要素の順序を変えずに、各要素間に $glue 文字列をはさんで 1 つの文字列にして返し
          ます。

See Also:
   * explode()
   * preg_split()
   * http_build_query()

>>>

シェルコマンドの実行

PsySh の中からシェルのコマンドを実行することもできます。実行するコマンドラインをバッククォートで囲みます。コマンドの実行結果は、文字列のリテラル（"〜"）として表示されます。

>>> `pwd`
=> "/var/www/hoge/web\n"
>>> `ls -l`
=> """
   total 84\n
   -rw-rw-r-- 1 vagrant vagrant   315 Dec  8 12:05 autoload.php\n
   drwxrwxr-x 1 vagrant vagrant  4096 Nov 24 23:27 core\n
   -rw-rw-r-- 1 vagrant vagrant  1507 Nov 27 17:27 example.gitignore\n
   -rw-rw-r-- 1 vagrant vagrant   549 Nov 27 17:27 index.php\n
   -rw-rw-r-- 1 vagrant vagrant    94 Nov 27 17:27 INSTALL.txt\n
   drwxrwxr-x 1 vagrant vagrant  4096 Dec  8 12:05 modules\n
   drwxrwxr-x 1 vagrant vagrant  4096 Nov 27 17:27 profiles\n
   -rw-r--r-- 1 vagrant vagrant 12484 Dec  8 21:14 q\n
   -rw-rw-r-- 1 vagrant vagrant  3205 Nov 27 17:27 README.md\n
   -rw-rw-r-- 1 vagrant vagrant  1586 Nov 27 17:27 robots.txt\n
   drwxrwxr-x 1 vagrant vagrant  4096 Dec  8 11:59 sites\n
   drwxrwxr-x 1 vagrant vagrant  4096 Nov 27 17:27 themes\n
   -rw-r--r-- 1 vagrant vagrant 12484 Dec  8 14:28 t q\n
   -rw-rw-r-- 1 vagrant vagrant   804 Nov 27 17:27 update.php\n
   -rw-rw-r-- 1 vagrant vagrant  4016 Nov 27 17:27 web.config\n
   """
>>>

Drupal における利用

Drush から起動した PsySh のプロンプトは、Drupal で必要なファイルがすべて読み込まれた状態になっており、モジュール内のコードと同じように Drupal API を呼び出してサイトの操作や情報取得ができます。

// Drupal の構成設定 API でサイト名を取得する例
>>> \Drupal::config('system.site')->get('name');
=> "DEMO site"

// settings.php で設定された $settings['hash_salt'] の値を取得する例
>>> \Drupal\Core\Site\Settings::get('hash_salt');
=> "7bb8S5Y7pZ4tvwciwBR8jsk0Ol2_Piy38vErPATD1TEPwjX0CpZLWkzgaXdALjEcP_ohmiJzkw"

ls コマンドを実行すると、Drupal\Core\DependencyInjection\Container 型の $container という変数が利用できることがわかります。

>>> ls -l

Variables:
  $container   Drupal\Core\DependencyInjection\Container {#768 …604}  
>>>

このオブジェクトの get() メソッドを利用して Drupal のコアサービスのインスタンスを取得できます。entity_type.manager サービスの例を示します。

// entity_type.manager サービスを取得する例
>>> $manager = $container->get('entity_type.manager');
=> Drupal\Core\Entity\EntityTypeManager {#943
     +"_serviceId": "entity_type.manager",
   }

取得したインスタンスの型の詳細は doc コマンドで閲覧できます。

>>> doc $manager
class Drupal\Core\Entity\EntityTypeManager extends Drupal\Core\Plugin\DefaultPluginManager implements Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, Drupal\Component\Plugin\Discovery\DiscoveryInterface, Drupal\Component\Plugin\Factory\FactoryInterface, Drupal\Component\Plugin\Mapper\MapperInterface, Drupal\Component\Plugin\PluginManagerInterface, Drupal\Core\Cache\CacheableDependencyInterface, Drupal\Core\Entity\EntityTypeManagerInterface, Symfony\Component\DependencyInjection\ContainerAwareInterface

Description:
  Manages entity type plugin definitions.
  
  Each entity type definition array is set in the entity type's annotation and
  altered by hook_entity_type_alter().
  
  Do not use hook_entity_type_alter() hook to add information to entity types,
  unless one of the following is true:
  - You are filling in default values.
  - You need to dynamically add information only in certain circumstances.
  - Your hook needs to run after hook_entity_type_build() implementations.
  Use hook_entity_type_build() instead in all other cases.

See: \Drupal\Core\Entity\Annotation\EntityType
See: \Drupal\Core\Entity\EntityInterface
See: \Drupal\Core\Entity\EntityTypeInterface
See: hook_entity_type_alter()
See: hook_entity_type_build()

ls コマンドを使用すると、クラスのメンバを調べることができます。

>>> ls -al $manager;

Class Properties:
  $additionalAnnotationNamespaces        []                                   >
  $alterHook                             "entity_type"                        >
  $cacheBackend                          Drupal\Core\Cache\ChainedFastBackend >
  $cacheKey                              "entity_type"                        >
  $cacheTags                             [ …1]                                >
  $classResolver                         Drupal\Core\DependencyInjection\Class>
  $container                             Drupal\Core\DependencyInjection\Conta>
…

Class Methods:
  alterDefinitions                protected function alterDefinitions(&$defini>
  alterInfo                       protected function alterInfo($alter_hook)   >
  cacheGet                        protected function cacheGet($cid)           >
  cacheSet                        protected function cacheSet($cid, $data, $ex>
  clearCachedDefinitions          public function clearCachedDefinitions()    >
  createHandlerInstance           public function createHandlerInstance($class>
  createInstance                  public function createInstance($plugin_id, a>
  doGetDefinition                 protected function doGetDefinition(array $de>
  extractProviderFromDefinition   protected function extractProviderFromDefini>
  findDefinitions                 protected function findDefinitions()        >
  getAccessControlHandler         public function getAccessControlHandler($ent>
  getActiveDefinition             public function getActiveDefinition($entity_>
  getCacheContexts                public function getCacheContexts()          >
  getCachedDefinitions            protected function getCachedDefinitions()   >
  getCacheMaxAge                  public function getCacheMaxAge()            >
  getCacheTags                    public function getCacheTags()              >
  getDefinition                   public function getDefinition($entity_type_i>
  getDefinitions                  public function getDefinitions()            >
  getDiscovery                    protected function getDiscovery()           >
  getFactory                      protected function getFactory()             >
  getFormObject                   public function getFormObject($entity_type_i>
  getHandler                      public function getHandler($entity_type_id, >
  getInstance                     public function getInstance(array $options) >
  getListBuilder                  public function getListBuilder($entity_type_>
  getRouteProviders               public function getRouteProviders($entity_ty>
  getStorage                      public function getStorage($entity_type_id) >
…

doc コマンドは、メソッドの詳細の確認にも利用できます。

>>> doc $manager->getStorage
class Drupal\Core\Entity\EntityTypeManager extends Drupal\Core\Plugin\DefaultPluginManager implements Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, Drupal\Component\Plugin\Discovery\DiscoveryInterface, Drupal\Component\Plugin\Factory\FactoryInterface, Drupal\Component\Plugin\Mapper\MapperInterface, Drupal\Component\Plugin\PluginManagerInterface, Drupal\Core\Cache\CacheableDependencyInterface, Drupal\Core\Entity\EntityTypeManagerInterface, Symfony\Component\DependencyInjection\ContainerAwareInterface
public function getStorage($entity_type_id)

Description:
  {@inheritdoc}

---

interface Drupal\Core\Entity\EntityTypeManagerInterface extends Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, Drupal\Component\Plugin\Discovery\DiscoveryInterface, Drupal\Component\Plugin\Factory\FactoryInterface, Drupal\Component\Plugin\Mapper\MapperInterface, Drupal\Component\Plugin\PluginManagerInterface
abstract public function getStorage($entity_type_id)

Description:
  Creates a new storage instance.

Throws:
  \Drupal\Component\Plugin\Exception\PluginNotFoundException           Thrown if the entity type doesn't exist.
  \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException  Thrown if the storage handler couldn't be loaded.

Param:
  string  $entity_type_id  The entity type ID for this storage.

Return:
  \Drupal\Core\Entity\EntityStorageInterface  A storage instance.

こうした情報を確認しながら、種々の API を呼び出していくことができます。

// uid=1 のユーザーを読み込む例
>>> $user = $manager->getStorage('user')->load(1);
=> Drupal\user\Entity\User {#5435
     #uid: Drupal\Core\Field\FieldItemList {#5370},
     #uuid: Drupal\Core\Field\FieldItemList {#5573},
     #langcode: Drupal\Core\Field\FieldItemList {#5579},
     #preferred_langcode: Drupal\Core\Field\FieldItemList {#5593},
     #preferred_admin_langcode: Drupal\Core\Field\FieldItemList {#5607},
     #name: Drupal\Core\Field\FieldItemList {#5609},
     #pass: Drupal\Core\Field\FieldItemList {#5615},
     #mail: Drupal\Core\Field\FieldItemList {#5625},
     #timezone: Drupal\Core\Field\FieldItemList {#5631},
     #status: Drupal\Core\Field\FieldItemList {#5637},
     #created: Drupal\Core\Field\FieldItemList {#5643},
     #changed: Drupal\Core\Field\ChangedFieldItemList {#5649},
     #access: Drupal\Core\Field\FieldItemList {#5655},
     #login: Drupal\Core\Field\FieldItemList {#5661},
     #init: Drupal\Core\Field\FieldItemList {#5667},
     #roles: Drupal\Core\Field\EntityReferenceFieldItemList {#5673},
     #default_langcode: Drupal\Core\Field\FieldItemList {#5685},
     #user_picture: Drupal\file\Plugin\Field\FieldType\FileFieldItemList {#5690},
   }

// インスタンスの内容をダンプする例
>>> dump -a $user;
Drupal\user\Entity\User {#5435
  #values: [
    "uid" => [
      "x-default" => "1",
    ],
    "uuid" => [
      "x-default" => "fa02f5db-396d-48af-b8f4-256ab018db5d",
    ],
    "langcode" => [
      "x-default" => "ja",
    ],
    "preferred_langcode" => [
      "x-default" => "ja",
    ],
    "preferred_admin_langcode" => [
      "x-default" => null,
    ],
    "name" => [
      "x-default" => "admin",
    ],
    "pass" => [
      "x-default" => "$S$Ee85r8WTkOUqZHp1oIxIlig5fOntFC8DrfyOoq.93TE9ezcWD9jO",
    ],
    "mail" => [
      "x-default" => "admin@example.com",
    ],
    "timezone" => [
      "x-default" => "Asia/Tokyo",
    ],
    "status" => [
      "x-default" => "1",
    ],
    "created" => [
      "x-default" => "1639116396",
    ],
:

名前空間を指定すると、クラス等の指定を簡略化できます。

>>> namespace Drupal\user\Entity
>>> User::load(1)
=> Drupal\user\Entity\User {#5435
…

show コマンドを利用して、特定のメソッドのコードを閲覧することもできます。

>>> show User::load
481:   /**
482:    * {@inheritdoc}
483:    */
484:   public static function load($id) {
485:     $entity_type_repository = \Drupal::service('entity_type.repository');
486:     $entity_type_manager = \Drupal::entityTypeManager();
487:     $storage = $entity_type_manager->getStorage($entity_type_repository->>
488:     return $storage->load($id);
489:   }

プロジェクトを常に PhpStorm 等の IDE で開いて xdebug している場合は必要ないかもしれませんが、ターミナルでサイトを調査する時などは便利に活用できそうです。

参考資料

追記：

PsySh のブレークポイントってこれかな。eval(\Psy\sh()) の先で \Psy\debug() が呼ばれて、そこで Shell のインスタンスの run() を呼ぶんですね。https://t.co/XF0ySUBaj9
— Kenji Shirane (@bkenro) January 13, 2022

Tag

Docker-compose で Drupal 9 サイトを立ち上げる手順の動画

shirane — Thu, 21 Oct 2021 17:06:48 +0000

Docker-compose で Drupal 9 サイトを立ち上げる手順の動画 shirane 2021/10/22(金) - 02:06

ffdsm（ふづむ）上の Docker で Drupal 9 をインストールする動画のその４です。

前回までの設定とイメージを利用して Docker-compose で各コンテナを起動し、drush site:install コマンドで対話的に Drupal 9 をインストールする手順です。

イメージの取得・ビルドからコンテナの起動までが自動化されるので、文字通りコマンド一発で Drupal 9 サイトのインストール準備が整います。

前回の動画
https://youtu.be/DuI-x9vygy8
ffdsm（ふづむ）
https://github.com/bkenro/ffdsm

Tag

Drupal の Docker 公式イメージに Drush を追加してコマンドラインから Drupal 9 をインストールする手順の動画

shirane — Thu, 14 Oct 2021 12:34:33 +0000

Drupal の Docker 公式イメージに Drush を追加してコマンドラインから Drupal 9 をインストールする手順の動画 shirane 2021/10/14(木) - 21:34

ffdsm（ふづむ）上の Docker で Drupal 9 をインストールする動画のその３です。

今回は、Drupal の Docker 公式イメージに Drush と mysql コマンドを追加したイメージを作り、これを起動したコンテナに対して、コマンドラインから Drush で Drupal 9 サイトをインストールする手順を紹介しています。

できたサイトでは Drush が使えるので、CRON やキャッシュ再構築など種々のサイト管理操作をコマンドラインから行うことが可能です。ローカル作業の効率が向上します。

前回の動画
https://youtu.be/uetR-KWEkn4
ffdsm（ふづむ）
https://github.com/bkenro/ffdsm

Tag

Drupal と MariaDB の Docker 公式イメージのコンテナを組み合わせて Drupal 9 サイトを立ち上げる手順の動画

shirane — Sun, 10 Oct 2021 15:14:41 +0000

Drupal と MariaDB の Docker 公式イメージのコンテナを組み合わせて Drupal 9 サイトを立ち上げる手順の動画 shirane 2021/10/11(月) - 00:14

先日の動画の続編として、ffdsm（ふづむ）上の Docker コンテナで Drupal 9 のローカルサイトを立ち上げる手順の動画を作成しました。今回は、Drupal とは別に MariaDB 公式イメージのコンテナも立ち上げて、両者を組み合わせてサイトを動かす例です。

２つのコンテナで共有するネットワークを作成した後、コンテナ起動時の環境変数で MariaDB のデータベースを作成し、これを Drupal コンテナ上の Drupal 9 サイトから接続して利用するまでの流れを（冗長ではありますが）ステップバイステップで示しています。

関連 URL：

前回の動画
https://youtu.be/FSg94VK2QWY
ffdsm（ふづむ）
https://github.com/bkenro/ffdsm

Tag